EnterpriseAccount
An interface that represents an enterprise account.
- Name
active- Type
boolean- Description
Whether the 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
enterpriseConnectionId- Type
string | null- Description
The ID of the enterprise connection associated with the enterprise account.
- Name
firstName- Type
string | null- Description
The first name of the user associated with the enterprise account.
- Name
id- Type
string- Description
The unique identifier of the enterprise account.
- Name
lastAuthenticatedAt- Type
Date | null- Description
The date and time when the enterprise account was last authenticated.
- Name
lastName- Type
string | null- Description
The last name of the user associated with the enterprise account.
- Name
protocol- Type
'saml' | 'oauth'- Description
The authentication protocol of the enterprise account.
- 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>- Description
Metadata that can be read from the Frontend API and Backend API, but can be set only from the Backend API.
- Name
verification- Type
VerificationResource | null- Description
The
VerificationResourceof the enterprise account, which includes information about the verification process, such as the number of attempts, the status, and the error if the verification failed.
Feedback
Last updated on