Class AuthorizationApi

Hierarchy (view full)

BaseAPI
- AuthorizationApi

Index

Constructors

Properties

Methods

deleteAuthKeysWithKeyName deleteAuthKeysWithKeyNameRaw getAuthKeys getAuthKeysRaw getAuthKeysWithKeyName getAuthKeysWithKeyNameRaw postAuthKeys postAuthKeysRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new AuthorizationApi(configuration?): AuthorizationApi
Parameters
- configuration: Configuration = ...
Returns AuthorizationApi
Inherited from BaseAPI.constructor
- Defined in cwmsjs/src/runtime.ts:27

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteAuthKeysWithKeyName

deleteAuthKeysWithKeyName(requestParameters, initOverrides?): Promise<ApiKey>
Delete API key for a user Delete auth keys with keyName
Parameters
- requestParameters: DeleteAuthKeysWithKeyNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiKey>
- Defined in cwmsjs/src/apis/AuthorizationApi.ts:74

deleteAuthKeysWithKeyNameRaw

deleteAuthKeysWithKeyNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<ApiKey>>
Delete API key for a user Delete auth keys with keyName
Parameters
- requestParameters: DeleteAuthKeysWithKeyNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ApiKey>>
- Defined in cwmsjs/src/apis/AuthorizationApi.ts:47

getAuthKeys

getAuthKeys(initOverrides?): Promise<ApiKey[]>
View all keys for the current user Get auth keys
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiKey[]>
- Defined in cwmsjs/src/apis/AuthorizationApi.ts:106

getAuthKeysRaw

getAuthKeysRaw(initOverrides?): Promise<ApiResponse<ApiKey[]>>
View all keys for the current user Get auth keys
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ApiKey[]>>
- Defined in cwmsjs/src/apis/AuthorizationApi.ts:83

getAuthKeysWithKeyName

getAuthKeysWithKeyName(requestParameters, initOverrides?): Promise<ApiKey>
View specific key Get auth keys with keyName
Parameters
- requestParameters: GetAuthKeysWithKeyNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiKey>
- Defined in cwmsjs/src/apis/AuthorizationApi.ts:142

getAuthKeysWithKeyNameRaw

getAuthKeysWithKeyNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<ApiKey>>
View specific key Get auth keys with keyName
Parameters
- requestParameters: GetAuthKeysWithKeyNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ApiKey>>
- Defined in cwmsjs/src/apis/AuthorizationApi.ts:115

postAuthKeys

postAuthKeys(requestParameters?, initOverrides?): Promise<ApiKey>
Create a new API Key for user. The randomly generated key is returned to the caller. A provided key will be ignored. Post auth keys
Parameters
- requestParameters: PostAuthKeysRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<ApiKey>
- Defined in cwmsjs/src/apis/AuthorizationApi.ts:177

postAuthKeysRaw

postAuthKeysRaw(requestParameters, initOverrides?): Promise<ApiResponse<ApiKey>>
Create a new API Key for user. The randomly generated key is returned to the caller. A provided key will be ignored. Post auth keys
Parameters
- requestParameters: PostAuthKeysRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ApiKey>>
- Defined in cwmsjs/src/apis/AuthorizationApi.ts:151

`Protected` request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in cwmsjs/src/runtime.ts:47

withMiddleware

withMiddleware<T>(this, ...middlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in cwmsjs/src/runtime.ts:31

withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in cwmsjs/src/runtime.ts:42

withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in cwmsjs/src/runtime.ts:37