EnterpriseAccount
An interface that represents an enterprise account.
- Name
active- Type
boolean- Description
A boolean value that indicates whether the enterprise account is active.
- Name
emailAddress- Type
string- Description
The email address of the enterprise account.
- Name
enterpriseConnection- Type
EnterpriseAccountConnection | null- Description
The enterprise connection associated with the enterprise account.
- Name
firstName- Type
string | null- Description
The first name of the enterprise account.
- Name
lastName- Type
string | null- Description
The last name of the enterprise account.
- Name
protocol- Type
'saml' | 'oauth'- Description
The authentication protocol of the enterprise account connection.
- Name
provider- Type
"saml_okta" | "saml_google" | "saml_microsoft" | "saml_custom" | "oauth_${OAuthProvider}"- Description
The provider of the enterprise account.
- Name
providerUserId- Type
string | null- Description
The user's ID as used in the provider.
- Name
publicMetadata- Type
Record<string, unknown> | null- Description
Metadata that can be read from both the Frontend API and Backend API, but can be set only from the Backend API. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.
- Name
verification- Type
Verification | null- Description
The verification of the enterprise account.
Feedback
Last updated on