VendorOAuthClientsApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| createVendorOauthClient | POST /vendors/{vendor_id}/oauth_clients | Create a new OAuth client |
| deleteVendorOauthClient | DELETE /vendors/{vendor_id}/oauth_clients/{client_id} | Delete an OAuth client |
| getVendorOauthClient | GET /vendors/{vendor_id}/oauth_clients/{client_id} | Get a specific OAuth client |
| listVendorOauthClients | GET /vendors/{vendor_id}/oauth_clients | List OAuth clients for a vendor |
| regenerateVendorOauthClientSecret | POST /vendors/{vendor_id}/oauth_clients/{client_id}/regenerate_secret | Regenerate client secret |
| updateVendorOauthClient | PUT /vendors/{vendor_id}/oauth_clients/{client_id} | Update an OAuth client |
createVendorOauthClient
VendorOAuthClientWithSecretResponse createVendorOauthClient(vendor_id, CreateVendorOAuthClientRequest)
Create a new OAuth client
Creates a new OAuth client for the vendor. Returns the client details including the client secret, which is only shown once at creation time.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| CreateVendorOAuthClientRequest | CreateVendorOAuthClientRequest | OAuth client creation request |
Return type
VendorOAuthClientWithSecretResponse
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
deleteVendorOauthClient
MessageResponse deleteVendorOauthClient(vendor_id, client_id)
Delete an OAuth client
Permanently deletes an OAuth client. This will revoke all access tokens and authorization codes associated with the client.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| client_id | Long | Unique identifier of the OAuth client | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getVendorOauthClient
VendorOAuthClientResponse getVendorOauthClient(vendor_id, client_id)
Get a specific OAuth client
Retrieves details of a specific OAuth client by its ID.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| client_id | Long | Unique identifier of the OAuth client | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listVendorOauthClients
PaginatedResponse_VendorOAuthClientResponse listVendorOauthClients(vendor_id, page, per_page)
List OAuth clients for a vendor
Retrieves a paginated list of OAuth clients registered for the specified vendor.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor whose OAuth clients to retrieve | [default to null] |
| page | Integer | Page number for pagination (defaults to 1) | [optional] [default to null] |
| per_page | Integer | Number of items per page (defaults to 20) | [optional] [default to null] |
Return type
PaginatedResponse_VendorOAuthClientResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
regenerateVendorOauthClientSecret
RegenerateSecretResponse regenerateVendorOauthClientSecret(vendor_id, client_id)
Regenerate client secret
Generates a new client secret for the OAuth client. The old secret will be invalidated immediately. The new secret is only shown once.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| client_id | Long | Unique identifier of the OAuth client | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
updateVendorOauthClient
VendorOAuthClientResponse updateVendorOauthClient(vendor_id, client_id, UpdateVendorOAuthClientRequest)
Update an OAuth client
Updates an existing OAuth client’s details. Note that the client secret cannot be changed through this endpoint; use the regenerate secret endpoint instead.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| client_id | Long | Unique identifier of the OAuth client | [default to null] |
| UpdateVendorOAuthClientRequest | UpdateVendorOAuthClientRequest | OAuth client update request |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8