Documentation

Mistake on this page? Email us

Account repository

Hierarchy

Index

Constructors

constructor

  • Initalise a new instance of the repository

    Parameters

    • Optional config: Config

      The configuration to use, if null then repository will initalise its own using dotenv

    • Optional client: Client

      The client instance to use

    Returns AccountRepository

Properties

client

client: Client

The repository client instance

config

config: Config

The repository configuration class

Methods

apiKeys

create

  • create

    Parameters

    • request: AccountCreateRequest

      The entity to perform action on.

    • Optional action: string

      Action, either create or enroll.

      • `create` creates the account where its admin user has ACTIVE status if `admin_password` was defined in the request, or RESET status if no `admin_password` was defined. If the user already exists, its status is not modified.
      • `enroll` creates the account where its admin user has ENROLLING status. If the user already exists, its status is not modified. Email to finish enrollment or notify the existing user about the new account is sent to the `admin_email` defined in the request.

    Returns Promise<Account>

darkThemeBrandingColors

  • darkThemeBrandingColors

    Parameters

    • id: string

      The ID of the account.

    • Optional options: ListOptions

      options

    Returns Paginator<SubtenantDarkThemeColor, ListOptions>

darkThemeBrandingImages

  • darkThemeBrandingImages

    Parameters

    • id: string

      The ID of the account.

    • Optional options: ListOptions

      options

    Returns Paginator<SubtenantDarkThemeImage, ListOptions>

lightThemeBrandingColors

  • lightThemeBrandingColors

    Parameters

    • id: string

      The ID of the account.

    • Optional options: ListOptions

      options

    Returns Paginator<SubtenantLightThemeColor, ListOptions>

lightThemeBrandingImages

  • lightThemeBrandingImages

    Parameters

    • id: string

      The ID of the account.

    • Optional options: ListOptions

      options

    Returns Paginator<SubtenantLightThemeImage, ListOptions>

list

me

  • me(options?: object): Promise<Account>
  • me

    Parameters

    • Optional options: object
      • Optional include?: string
      • Optional properties?: string

    Returns Promise<Account>

read

  • read(id: string, options?: object): Promise<Account>
  • read

    Parameters

    • id: string

      Account ID.

    • Optional options: object
      • Optional include?: string
      • Optional properties?: string

    Returns Promise<Account>

trustedCertificates

update

userInvitations

users