Documentation

Mistake on this page? Email us
Device Management SDK JavaScript

SubtenantUser repository

Hierarchy

Index

Constructors

Properties

Methods

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 SubtenantUserRepository

Properties

client

client: Client

The repository client instance

config

config: Config

The repository configuration class

Methods

create

  • create

    Parameters

    • request: SubtenantUserCreateRequest

      The entity to perform action on.

    • accountId: string

      The ID of the account.

    • Optional action: string

      Create or invite user.

    Returns Promise<SubtenantUser>

delete

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

  • delete

    Parameters

    • accountId: string

      Account ID.

    • id: string

      The ID of the user to delete.

    Returns Promise<void>

policyGroups

  • policyGroups

    Parameters

    • accountId: string

      Account ID.

    • id: string

      The ID of the user.

    • Optional options: ListOptions

      options

    Returns Paginator<SubtenantPolicyGroup, ListOptions>

read

  • read

    Parameters

    • accountId: string

      The ID of the account.

    • id: string

      The ID of the user.

    Returns Promise<SubtenantUser>

update

validateEmail

  • validateEmail(accountId: string, id: string): Promise<SubtenantUser>

  • validateEmail

    Parameters

    • accountId: string

      Account ID.

    • id: string

      The ID of the user.

    Returns Promise<SubtenantUser>