Class User

Hierarchy

default
- User

Index

Constructors

Properties

client env host token

Methods

auth delete getClaims getUser invite permissions setClient

Constructors

constructor

new User(options?: { env?: string; host?: string; token?: string }): User
Parameters
- Optionaloptions: { env?: string; host?: string; token?: string }
Returns User
Inherited from PlatformBaseClient.constructor
- Defined in api/platformBaseClient.ts:25

Properties

client

client: AxiosInstance

`Protected`env

env: null | string = null

`Protected`host

host: null | string = null

`Protected`token

token: null | string = null

Methods

auth

auth(
    username: string,
    password: string,
    project: string,
): Promise<AxiosResponse<any, any>>
Parameters
- username: string
- password: string
- project: string
Returns Promise<AxiosResponse<any, any>>
- Defined in api/users.ts:31

delete

delete(uuid: string): Promise<AxiosResponse<any, any>>
Parameters
- uuid: string
Returns Promise<AxiosResponse<any, any>>
- Defined in api/users.ts:23

getClaims

getClaims(): Promise<AxiosResponse<UserClaims, any>>
Returns Promise<AxiosResponse<UserClaims, any>>
- Defined in api/users.ts:14

getUser

getUser(): Promise<AxiosResponse<UserModel, any>>
Returns Promise<AxiosResponse<UserModel, any>>
- Defined in api/users.ts:19

invite

invite(email: string, roles: string[]): Promise<AxiosResponse<any, any>>
Parameters
- email: string
- roles: string[]
Returns Promise<AxiosResponse<any, any>>
- Defined in api/users.ts:6

permissions

permissions(): Promise<AxiosResponse<any, any>>
Returns Promise<AxiosResponse<any, any>>
- Defined in api/users.ts:27

setClient

setClient(client: AxiosInstance): User
Parameters
- client: AxiosInstance
Returns User
Inherited from PlatformBaseClient.setClient
- Defined in api/baseClient.ts:10