Class ClientAuthorizationsApi

ClientAuthorizationsApi - object-oriented interface

export

Hierarchy

BaseAPI
- ClientAuthorizationsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ClientAuthorizationsApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): ClientAuthorizationsApi

Inherited from BaseAPI.constructor
- Defined in api/base.ts:50
Parameters
- Optional configuration: Configuration
- basePath: string = ...
- axios: AxiosInstance = ...
Returns ClientAuthorizationsApi

Properties

Protected axios

axios: AxiosInstance = ...

Protected basePath

basePath: string = ...

Protected configuration

configuration: undefined | Configuration

Methods

addClientAuthorization

addClientAuthorization(requestParameters: ClientAuthorizationsApiAddClientAuthorizationRequest, options?: any): Promise<AxiosResponse<ClientAuthorizationsResponse>>

- Defined in api/api.ts:5796
Create an authorization for an API client. Each entity to authorize requires a separate request.

summary

add_client_authorization

throws

{RequiredError}

memberof

ClientAuthorizationsApi

Parameters
- requestParameters: ClientAuthorizationsApiAddClientAuthorizationRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<ClientAuthorizationsResponse>>

deleteClientAuthorization

deleteClientAuthorization(requestParameters: ClientAuthorizationsApiDeleteClientAuthorizationRequest, options?: any): Promise<AxiosResponse<void>>

- Defined in api/api.ts:5808
Delete a user from a client whitelist.

summary

delete_client_authorization

throws

{RequiredError}

memberof

ClientAuthorizationsApi

Parameters
- requestParameters: ClientAuthorizationsApiDeleteClientAuthorizationRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<void>>

getClientAuthorizationById

getClientAuthorizationById(requestParameters: ClientAuthorizationsApiGetClientAuthorizationByIdRequest, options?: any): Promise<AxiosResponse<ClientAuthorizationsResponse>>

- Defined in api/api.ts:5820
Retrieve a listing with information on all entities in the whitelist for a specific client.

summary

get_client_authorization_by_id

throws

{RequiredError}

memberof

ClientAuthorizationsApi

Parameters
- requestParameters: ClientAuthorizationsApiGetClientAuthorizationByIdRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<ClientAuthorizationsResponse>>

getClientAuthorizations

getClientAuthorizations(requestParameters?: ClientAuthorizationsApiGetClientAuthorizationsRequest, options?: any): Promise<AxiosResponse<ClientAuthorizationsResponse[]>>

- Defined in api/api.ts:5832
Get a listing of information on all client whitelists.

summary

get_client_authorizations

throws

{RequiredError}

memberof

ClientAuthorizationsApi

Parameters
- requestParameters: ClientAuthorizationsApiGetClientAuthorizationsRequest = {}
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<ClientAuthorizationsResponse[]>>