Organization Domains
These are all methods on the Organization class that allow you to manage the domains of an organization.
getDomains()
Retrieves a list of domains for the currently active organization.
function getDomains(params?: GetDomainsParams): Promise<PaginatedResources<OrganizationDomain>>;
GetDomainsParams
Name | Type | Description |
---|---|---|
initialPage? | number | A number that can be used to skip the first n-1 pages. For example, if initialPage is set to 10, it is will skip the first 9 pages and will fetch the 10th page. |
pageSize? | number | A number that indicates the maximum number of results that should be returned for a specific page. |
enrollmentMode? | 'manual_invitation' | 'automatic_invitation' | 'automatic_suggestion' | An enrollment mode will change how new users join an organization. |
Returns
Type | Description |
---|---|
Promise<PaginatedResponse<OrganizationDomain>> | This method returns a Promise which resolves with a list of OrganizationDomain objects. |
getDomain()
Retrieves a domain for an organization based on the given domain ID.
function getDomain(params: GetDomainParams): Promise<OrganizationDomain>;
GetDomainParams
Name | Type | Description |
---|---|---|
domainId | string | The ID of the domain that will be fetched. |
Returns
Type | Description |
---|---|
Promise<OrganizationDomain> | This method returns a Promise which resolves to the OrganizationDomain for the corresponding ID. |