Class RoleApi

RoleApi - object-oriented interface

Export

RoleApi

Hierarchy

BaseAPI
- RoleApi

Index

Constructors

constructor

new RoleApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): RoleApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns RoleApi
Inherited from BaseAPI.constructor
- Defined in packages/lib-apiclient/src/generated/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

roleControllerCreate

roleControllerCreate(
roleCreateInputDTO?: RoleCreateInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RoleOutputDTOAPI>>
Required permissions: MANAGE_ROLES
OperationId: RoleControllerCreate
Parameters
- OptionalroleCreateInputDTO: RoleCreateInputDTO
  RoleCreateInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RoleOutputDTOAPI>>
Throws
Memberof
RoleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:20709

roleControllerGetOne

roleControllerGetOne(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RoleOutputDTOAPI>>
Required permissions: READ_ROLES
OperationId: RoleControllerGetOne
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RoleOutputDTOAPI>>
Throws
Memberof
RoleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:20723

roleControllerGetPermissions

roleControllerGetPermissions(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PermissionOutputDTOAPI>>
OperationId: RoleControllerGetPermissions
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PermissionOutputDTOAPI>>
Throws
Memberof
RoleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:20736

roleControllerRemove

roleControllerRemove(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput>>
Required permissions: MANAGE_ROLES
OperationId: RoleControllerRemove
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput>>
Throws
Memberof
RoleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:20750

roleControllerSearch

roleControllerSearch(
roleSearchInputDTO?: RoleSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RoleOutputArrayDTOAPI>>
Required permissions: READ_ROLES
OperationId: RoleControllerSearch
Parameters
- OptionalroleSearchInputDTO: RoleSearchInputDTO
  RoleSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RoleOutputArrayDTOAPI>>
Throws
Memberof
RoleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:20764

roleControllerUpdate

roleControllerUpdate(
    id: string,
    roleUpdateInputDTO?: RoleUpdateInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RoleOutputDTOAPI>>
Required permissions: MANAGE_ROLES
OperationId: RoleControllerUpdate
Parameters
- id: string
- OptionalroleUpdateInputDTO: RoleUpdateInputDTO
  RoleUpdateInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RoleOutputDTOAPI>>
Throws
Memberof
RoleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:20779

Class RoleApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RoleApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

roleControllerCreate

Parameters

Returns Promise<AxiosResponse<RoleOutputDTOAPI>>

Throws

Memberof

roleControllerGetOne

Parameters

Returns Promise<AxiosResponse<RoleOutputDTOAPI>>

Throws

Memberof

roleControllerGetPermissions

Parameters

Returns Promise<AxiosResponse<PermissionOutputDTOAPI>>

Throws

Memberof

roleControllerRemove

Parameters

Returns Promise<AxiosResponse<APIOutput>>

Throws

Memberof

roleControllerSearch

Parameters

Returns Promise<AxiosResponse<RoleOutputArrayDTOAPI>>

Throws

Memberof

roleControllerUpdate

Parameters

Returns Promise<AxiosResponse<RoleOutputDTOAPI>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration