Class OAuthClientsService

OAuth clients service (External connectors).

Hierarchy

OAuthClientsService

Index

Constructors

Properties

httpClient namespace

Methods

createOAuthClient deleteOAuthClient getAvailablePermissions getOAuthClients updateOAuthClient

Constructors

constructor

new OAuthClientsService(httpClient): OAuthClientsService
Parameters
- httpClient: HttpClient
Returns OAuthClientsService

Properties

`Private` httpClient

httpClient: HttpClient

`Private` namespace

namespace: string = '/company/v1/oauth_clients'

Methods

createOAuthClient

createOAuthClient(body): Promise<AxiosResponse<IApiEnvelope<IOAuthClientWithSecret>, any, {}>>
Create an OAuth client. Returns the client including the one-time secret.
Parameters
- body: IOAuthClientRequest
  
  name + selected permission keys (area.entity.action)
Returns Promise<AxiosResponse<IApiEnvelope<IOAuthClientWithSecret>, any, {}>>

deleteOAuthClient

deleteOAuthClient(id): Promise<AxiosResponse<{
message: string;
status: boolean;
}, any, {}>>
Delete an OAuth client by id (client_id).
Parameters
- id: string
Returns Promise<AxiosResponse<{
message: string;
status: boolean;
}, any, {}>>

getAvailablePermissions

getAvailablePermissions(): Promise<AxiosResponse<IApiEnvelope<IOAuthPermissionGroup[]>, any, {}>>
Get the available permissions catalog for the client scope selector.

Returns Promise<AxiosResponse<IApiEnvelope<IOAuthPermissionGroup[]>, any, {}>>

getOAuthClients

getOAuthClients(page?, list?): Promise<AxiosResponse<IApiEnvelope<IOAuthClientsPaginator>, any, {}>>
Get the workspace's OAuth clients.
Parameters
- Optional page: number
- Optional list: number
Returns Promise<AxiosResponse<IApiEnvelope<IOAuthClientsPaginator>, any, {}>>

updateOAuthClient

updateOAuthClient(id, body): Promise<AxiosResponse<IApiEnvelope<IOAuthClient>, any, {}>>
Update an OAuth client (name and/or permissions) by id (client_id). The secret is never returned on update.
Parameters
- id: string
- body: Partial<IOAuthClientRequest>
Returns Promise<AxiosResponse<IApiEnvelope<IOAuthClient>, any, {}>>

Generated using TypeDoc