Class Roles

Hierarchy

default
- Roles

Index

Constructors

Properties

client env host token

Methods

availablePermissions create delete edit list permissions setClient

Constructors

constructor

new Roles(options?: { env?: string; host?: string; token?: string }): Roles
Parameters
- Optionaloptions: { env?: string; host?: string; token?: string }
Returns Roles
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

availablePermissions

availablePermissions(): Promise<any>
Returns Promise<any>
- Defined in api/roles.ts:15

create

create(role: any): Promise<any>
Parameters
- role: any
Returns Promise<any>
- Defined in api/roles.ts:3

delete

delete(uuid: string): Promise<any>
Parameters
- uuid: string
Returns Promise<any>
- Defined in api/roles.ts:7

edit

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

list

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

permissions

permissions(): Promise<any>
Returns Promise<any>
- Defined in api/roles.ts:19

setClient

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