Class PermissionsApi

PermissionsApi - object-oriented interface export PermissionsApi

Hierarchy (view full)

BaseAPI
- PermissionsApi

Index

Constructors

Properties

axios basePath configuration

Methods

Constructors

constructor

new PermissionsApi(configuration?, basePath?, axios?): PermissionsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PermissionsApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

permissionsGet

permissionsGet(useCache?, options?): Promise<AxiosResponse<string[], any>>
Use these permissions to set visibility of UI componets only. Any user input to a back end service should not be trusted.
summary List all permissions for the current user
Parameters
- OptionaluseCache: boolean
  Defaults to true. If true, then use a five minute cache.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<string[], any>>
Throws
memberof PermissionsApi
- Defined in src/api/api.ts:22860