Skip to main content

The Backend OrganizationDomain object

The OrganizationDomain object is the model around an Organization's Verified Domain.

Properties

  • Name
    affiliationEmailAddress
    Type
    null | string
    Description

    The email address used to verify the domain.

  • Name
    createdAt
    Type
    number
    Description

    The Unix timestamp when the domain was created.

  • Name
    enrollmentMode
    Type
    "manual_invitation" | "automatic_invitation" | "automatic_suggestion"
    Description

    The enrollment mode that determines how matching users are added to the Organization.

    • manual_invitation: No automatic enrollment. Users with a matching email domain are not given any invitation or suggestion; an admin must invite them manually.
    • automatic_invitation: Users with a matching email domain automatically receive a pending invitation (assigned the Organization's default role) which they can accept to join.
    • automatic_suggestion: Users with a matching email domain automatically receive a suggestion to join, which they can request.
  • Name
    id
    Type
    string
    Description

    The unique identifier of the domain.

  • Name
    name
    Type
    string
    Description

    The name of the domain.

  • Name
    organizationId
    Type
    string
    Description

    The ID of the Organization that the domain belongs to.

  • Name
    totalPendingInvitations
    Type
    number
    Description

    The total number of pending invitations for the domain.

  • Name
    totalPendingSuggestions
    Type
    number
    Description

    The total number of pending suggestions for the domain.

  • Name
    updatedAt
    Type
    number
    Description

    The Unix timestamp when the domain was last updated.

  • Name
    verification
    Type
    null | { attempts: null | number; expireAt: null | number; status: string; strategy: string; }
    Description

    The verification details of the domain.

  • Name
    verification.attempts
    Type
    null | number
    Description

    The number of verification attempts that have been made.

  • Name
    verification.expireAt
    Type
    null | number
    Description

    The Unix timestamp when the current verification attempt expires.

  • Name
    verification.status
    Type
    string
    Description

    The current status of the verification.

  • Name
    verification.strategy
    Type
    string
    Description

    The strategy used to verify the domain.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub