OrganizationDomain
The OrganizationDomain object is the model around an Organization domain.
Properties
- Name
id- Type
string- Description
The 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 when the Organization domain was created.
- Name
updatedAt- Type
Date- Description
The date when the Organization domain was last 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 occurred in order to verify the domain.
- Name
expiresAt- Type
Date- Description
The expiration date and time of the verification.
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. ).
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 that was sent to the user as part of this verification step.
Feedback
Last updated on
Edit on GitHub