Class APIUser

Hierarchy

default
- APIUser

Index

Constructors

Properties

client env host token

Methods

auth edit get list newSecret revokeSecret setClient

Constructors

constructor

new APIUser(options?: { env?: string; host?: string; token?: string }): APIUser
Parameters
- Optionaloptions: { env?: string; host?: string; token?: string }
Returns APIUser
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/apiUser.ts:4

edit

edit(uuid: string, roles: string[]): Promise<AxiosResponse<any, any>>
Parameters
- uuid: string
- roles: string[]
Returns Promise<AxiosResponse<any, any>>
- Defined in api/apiUser.ts:23

get

get(uuid: string): Promise<AxiosResponse<any, any>>
Parameters
- uuid: string
Returns Promise<AxiosResponse<any, any>>
- Defined in api/apiUser.ts:31

list

list(): Promise<any>
Returns Promise<any>
- Defined in api/apiUser.ts:27

newSecret

newSecret(uuid: string): Promise<AxiosResponse<any, any>>
Parameters
- uuid: string
Returns Promise<AxiosResponse<any, any>>
- Defined in api/apiUser.ts:15

revokeSecret

revokeSecret(uuid: string): Promise<AxiosResponse<any, any>>
Parameters
- uuid: string
Returns Promise<AxiosResponse<any, any>>
- Defined in api/apiUser.ts:19

setClient

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