Documentation

Mistake on this page? Email us

User repository

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initalise a new instance of the repository

    Parameters

    • Optional config: ConfigOptions

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

    • Optional client: Client

      The client instance to use

    Returns UserRepository

Properties

client

client: Client

The repository client instance

config

config: Config

The repository configuration class

Methods

create

  • create

    Parameters

    • request: UserCreateRequest

      The entity to perform action on.

    • Optional action: string

      Action, either create or invite.

    Returns Promise<User>

delete

  • delete(id: string): Promise<void>
  • delete

    Parameters

    • id: string

      The ID of the user to delete.

    Returns Promise<void>

list

  • list(options?: UserListOptions): Paginator<User, ListOptions>
  • list

    Parameters

    • Optional options: UserListOptions

      Options to use for the List

    Returns Paginator<User, ListOptions>

policyGroups

  • policyGroups

    Parameters

    • id: string

      The ID of the user.

    • Optional options: ListOptions

      options

    Returns Paginator<PolicyGroup, ListOptions>

read

  • read(id: string): Promise<User>
  • read

    Parameters

    • id: string

      The ID of the user.

    Returns Promise<User>

update

  • update

    Parameters

    • request: UserUpdateRequest

      The entity to perform action on.

    • id: string

      The ID of the user.

    Returns Promise<User>