Organization

📄️ List all organizations

Lists all the organizations in a Frontier instance. It can be filtered by user and state.

📄️ List organizations

Returns a list of organizations. It can be filtered by userID or organization state.

📄️ Delete organization

Delete an organization and all of its relations permanently. The organization users will not be deleted from Frontier.

📄️ List organization admins

Returns a list admins of an organization

📄️ Disable organization

Sets the state of the organization as disabled. The existing users in the org will not be able to access any organization resources.

📄️ Enable organization

Sets the state of the organization as enabled. The existing users in the org will be able to access any organization resources.

📄️ Get organization projects

Get all projects that belong to an organization

📄️ List organization service users

List organization service users

📄️ Add organization user

Add a user to an organization. A user must exists in Frontier before adding it to an org. This request will fail if the user doesn't exists

Returns all domains whitelisted for an organization (both pending and verified if no filters are provided for the state). The verified domains allow users email with the org's whitelisted domain to join the organization without invitation.

📄️ Add org domain

Add a domain to an organization which if verified allows all users of the same domain to be signed up to the organization without invitation. This API generates a verification token for a domain which must be added to your domain's DNS provider as a TXT record should be verified with Frontier VerifyOrgDomain API before it can be used as an Organization's trusted domain to sign up users.

📄️ Get org domain

Get a domain from the list of an organization's whitelisted domains. Returns both verified and unverified domains by their ID

📄️ Remove org domain

Remove a domain from the list of an organization's trusted domains list

📄️ Verify org domain

Verify a domain for an organization with a verification token generated by Frontier GenerateDomainVerificationToken API. The token must be added to your domain's DNS provider as a TXT record before it can be verified. This API returns the state of the domain (pending/verified) after verification.

📄️ List pending invitations

Returns all pending invitations queued for an organization

📄️ Invite user

Invite users to an organization, if user is not registered on the platform, it will be notified. Invitations expire in 7 days

📄️ Get pending invitation

Returns a pending invitation queued for an organization

📄️ Delete pending invitation

Delete a pending invitation queued for an organization

📄️ Accept pending invitation

Accept pending invitation queued for an organization. The user will be added to the organization and groups defined in the invitation

📄️ Join organization

Allows the current logged in user to join the Org if one is not a part of it. The user will only be able to join when the user email's domain matches the organization's whitelisted domains.

📄️ List orgs by domain

Returns all organizations that have a specific domain whitelisted. This API will return only those organizations in which the domain ownership have been verified. Useful when you want to show a list of organizations that users can join based on their email domain (by default will also show the orgs of which user is already a part of).