Skip to main content

Admin Entities

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

Secret​

The Secret interface defines the structure for storing a password used when creating a native admin.

Properties​

  • password (string): The password associated with the admin.

AdminCreateInView​

The AdminCreateInView interface defines the structure required to create a new Epicenter admin.

Properties​

  • [key: string]: unknown: Allows additional arbitrary fields.
  • handle (string): Unique handle for the admin.
  • email (string): Email address of the admin.
  • givenName? (string): (Optional) Admin’s given name.
  • familyName? (string): (Optional) Admin’s family name.
  • verified (true): Indicates that the admin is verified.
  • active? (true): (Optional) Indicates whether the admin is active.

Admin​

The Admin interface defines the stored structure of an Epicenter admin.

Properties​

  • lastUpdated (string): Timestamp of the last update to the admin record.
  • lastLogin (string): Timestamp of the admin’s most recent login.
  • created (string): Timestamp of when the admin was created.
  • familyName (string): Admin’s family name.
  • givenName (string): Admin’s given name.
  • verified (boolean): Whether the admin is verified.
  • handle (string): Unique handle for the admin.
  • active (boolean): Whether the admin is active.
  • adminKey (string): A GUID key identifying the admin.
  • email (string): Admin’s email address.
  • objectType ('external' | 'native'): An external admin authenticates through an external identity provider and a native admin authenticates with their Epicenter handle and password.

NativeAdminCreateInView​

The NativeAdminCreateInView interface defines the structure required to create a native admin, extending AdminCreateInView.

Properties​

  • objectType ('native'): Identifies the admin as a native admin.
  • secret (Secret): Password configuration for the native admin.
  • (All properties from AdminCreateInView are also included.)