| Arm Pelion IoT Platform

Documentation

Mistake on this page? Email us

SubtenantUser repository

Hierarchy

Repository
- SubtenantUserRepository

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SubtenantUserRepository(config?: ConfigOptions, client?: Client): SubtenantUserRepository

Inherited from Repository.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 SubtenantUserRepository

Properties

client

client: Client

The repository client instance

config

config: Config

The repository configuration class

Methods

create

create(request: SubtenantUserCreateRequest, accountId: string, action?: string): Promise<SubtenantUser>

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(accountId: string, id: string, options?: ListOptions): Paginator<SubtenantPolicyGroup, ListOptions>

policyGroups

Parameters
- accountId: string
  
  Account ID.
- id: string
  
  The ID of the user.
- Optional options: ListOptions
  
  options
Returns Paginator<SubtenantPolicyGroup, ListOptions>

read

read(accountId: string, id: string): Promise<SubtenantUser>

read

Parameters
- accountId: string
  
  The ID of the account.
- id: string
  
  The ID of the user.
Returns Promise<SubtenantUser>

update

update(request: SubtenantUserUpdateRequest, accountId: string, id: string): Promise<SubtenantUser>

update

Parameters
- request: SubtenantUserUpdateRequest
  
  The entity to perform action on.
- accountId: string
  
  The ID of the account.
- id: string
  
  The ID of the user.
Returns Promise<SubtenantUser>

validateEmail

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

validateEmail

Parameters
- accountId: string
  
  Account ID.
- id: string
  
  The ID of the user.
Returns Promise<SubtenantUser>