Class UsersClient

Hierarchy

UsersClient

Index

Constructors

constructor

Methods

Constructors

constructor

new UsersClient(_request: IRequest): UsersClient

- Defined in src/client/index.ts:285
Parameters
- _request: IRequest
Returns UsersClient

Methods

create

create(serverID: string, args: IClientServerUserRequest): Promise<IClientServerUser>

- Defined in src/client/index.ts:302
Create subuser for the specified user.

Parameters
- serverID: string
  
  Server Identifier
- args: IClientServerUserRequest
  
  Client subusers arguments want to send.
Returns Promise<IClientServerUser>

delete

delete(serverID: string, userUUID: string): Promise<boolean>

- Defined in src/client/index.ts:319
Delete subuser for the specified server.

Parameters
- serverID: string
  
  Server Identifier
- userUUID: string
  
  Subuser Identifier
Returns Promise<boolean>

getAll

getAll(serverID: string): Promise<IClientServerUser[]>

- Defined in src/client/index.ts:293
Retrieves subusers on specified server

Parameters
- serverID: string
  
  Server Identifier
Returns Promise<IClientServerUser[]>

update

update(serverID: string, userUUID: string, permissions: string[]): Promise<boolean>

- Defined in src/client/index.ts:311
Updating permissions for the specified subuser from a server.

Parameters
- serverID: string
  
  Server Identifier
- userUUID: string
  
  Subuser identifier
- permissions: string[]
  
  Permissions for subuser Array<String>
Returns Promise<boolean>

Generated using TypeDoc