Docs

You are viewing an archived version of the docs.Go to latest version

OrganizationDomain

The OrganizationDomain object is the model around an organization domain.

Properties

  • Name
    id
    Type
    string
    Description

    A unique identifier for this organization domain.

  • Name
    name
    Type
    string
    Description

    The name for this organization domain (e.g. example.com).

  • Name
    organizationId
    Type
    string
    Description

    The organization ID of the organization this domain is for.

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

    An enrollment mode will change how new users join an organization.

  • Name
    verification
    Type
    OrganizationDomainVerification
    Description

    The object that describes the status of the verification process of the domain.

  • Name
    affiliationEmailAddress
    Type
    string | null
    Description

    The email address that was used to verify this organization domain.

  • Name
    totalPendingInvitations
    Type
    number
    Description

    The number of total pending invitations sent to emails that match the domain name.

  • Name
    totalPendingSuggestions
    Type
    number
    Description

    The number of total pending suggestions sent to emails that match the domain name.

  • Name
    createdAt
    Type
    Date
    Description

    The date and time the organization domain was created.

  • Name
    updatedAt
    Type
    Date
    Description

    The date and time the organization domain was updated.

  • Name
    status
    Type
    'unverified' | 'verified'
    Description

    The status of the verification process.

  • Name
    strategy
    Type
    'email_code'
    Description

    A string that indicates strategy of the verification.

  • Name
    attempts
    Type
    number
    Description

    A number that indicates how many attempts have occured in order to verify the domain.

  • Name
    expiresAt
    Type
    Date
    Description

    The expiration date and time of the verification.

Methods

delete()

Deletes the organization domain and removes it from the organization.

function delete: () => Promise<void>;

prepareAffiliationVerification()

Begins the verification process of a created organization domain. This is a required step in order to complete the registration of the domain under the organization.

function prepareAffiliationVerification(params: PrepareAffiliationVerificationParams): Promise<OrganizationDomain>;
  • Name
    affiliationEmailAddress
    Type
    string
    Description

    An email address that is affiliated with the domain name (e.g. user@example.com).

Returns

TypeDescription
Promise<OrganizationDomain>This method returns a Promise which resolves with an OrganizationDomain object.

attemptAffiliationVerification()

Attempts to complete the domain verification process. This is a required step in order to complete the registration of a domain under an organization, as the administrator should be verified as a person who is affiliated with that domain.

Make sure that an OrganizationDomain object already exists before you call this method, by first calling OrganizationDomain.prepareAffiliationVerification.

function attemptAffiliationVerification(params: AttemptAffiliationVerificationParams): Promise<OrganizationDomain>;
  • Name
    code
    Type
    string
    Description

    The one-time code that was sent to the user as part of this verification step.

Returns

TypeDescription
Promise<OrganizationDomain>This method returns a Promise which resolves with an OrganizationDomain object.

Feedback

What did you think of this content?

Last updated on