sitemap.xml llms.txt
Skip to main content

Registration Entities

These interfaces are used by the Registration adapter and encapsulate data objects used by the Epicenter Registration API.

Registration info​

RegistrationInfo​

The RegistrationInfo interface defines the structure of contextual data returned when looking up a self-registration or invite token.

Properties​

  • projectShortName? (string | null): (Optional) The project short name.
  • groupName? (string | null): (Optional) Name of the group associated with the token.
  • accountShortName? (string | null): (Optional) Short name of the account the token belongs to.
  • accountName? (string | null): (Optional) Display name of the account.
  • familyName? (string | null): (Optional) Pre-populated family name for the user.
  • givenName? (string | null): (Optional) Pre-populated given name for the user.
  • projectName? (string | null): (Optional) Display name of the project.
  • email? (string | null): (Optional) Email address associated with the token.
  • groupKey? (string | null): (Optional) Unique GUID of the group.

TeamRegistrationInfo​

The TeamRegistrationInfo interface defines the structure of contextual data returned when looking up a team invite token.

Properties​

  • accountShortName? (string | null): (Optional) The account short name.
  • accountName? (string | null): (Optional) Display name of the account.
  • familyName? (string | null): (Optional) Pre-populated family name for the invited user.
  • givenName? (string | null): (Optional) Pre-populated given name for the invited user.
  • email? (string | null): (Optional) Email address associated with the invited user.

Registration result​

WhoAmIObjectType​

WhoAmIObjectType is a string-literal union type that identifies the type of session principal.

Values​

  • 'system': A system-level principal.
  • 'dashboard': A dashboard-level principal.
  • 'account': An account-level principal.
  • 'admin': An admin principal.
  • 'user': An authenticated end user.
  • 'anonymous': An unauthenticated or anonymous session.

WhoAmI​

The WhoAmI interface defines the structure of the session object returned after a successful registration.

Properties​

  • objectType (WhoAmIObjectType): Identifies the kind of session principal.
  • sessionKey? (string | null): (Optional) The session key for the authenticated session.
  • timeoutMinutes? (number | null): (Optional) Number of minutes before the session expires.
  • token? (string | null): (Optional) Authentication token for the session.
  • expires? (boolean | null): (Optional) Indicates whether the session is set to expire.
  • [key: string] (unknown): Additional properties returned by the API.

RegistrationResult​

The RegistrationResult interface defines the structure of the response returned after completing a self-registration or invite registration.

Properties​

  • whoAmI (WhoAmI): The session object for the newly registered user.
  • redirectUrl? (string | null): (Optional) URL to redirect the user to after registering.

Types​

TeamRole​

TeamRole is a string-literal union type that defines the roles available when inviting a user to a team account.

Values​

  • 'OWNER': Full administrative control of the team account.
  • 'AUTHOR': Can create and manage projects within the account.
  • 'SUPPORT': Read access plus the ability to assist users.
  • 'ASSOCIATE': Basic membership access.

SsoProtocol​

SsoProtocol is a string-literal union type that defines the supported Single Sign-On protocols.

Currently the only supported value is SAML. This type is intentionally narrow so that adding new protocols on the backend requires an explicit type update.