Class AuthorizationApi

Hierarchy (view full)

BaseAPI
- AuthorizationApi

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteAuthKeysWithKeyName

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

deleteAuthKeysWithKeyNameRaw

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

getAuthKeys

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

getAuthKeysRaw

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

getAuthKeysWithKeyName

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

getAuthKeysWithKeyNameRaw

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

`Protected` isJsonMime

isJsonMime(mime): boolean
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
Parameters
- mime: string
  MIME (Multipurpose Internet Mail Extensions)
Returns boolean
True if the given MIME is JSON, false otherwise.
Inherited from BaseAPI.isJsonMime
- Defined in cwmsjs/src/runtime.ts:127

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 cwmsData auth keys
Parameters
- requestParameters: PostAuthKeysRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiKey>
- Defined in cwmsjs/src/apis/AuthorizationApi.ts:189

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 cwmsData auth keys
Parameters
- requestParameters: PostAuthKeysRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<ApiKey>>
- Defined in cwmsjs/src/apis/AuthorizationApi.ts:163

`Protected` request

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

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:101

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:112

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:107