class

Polar::Api::Oauth2::Clients

Inherits Reference < Object

API client for clients operations in oauth2 context

Constants

Log = ::Log.for(self)

Constructors

new(client : Client)

Creates a new Clients instance

@param client [Client] The Polar API client instance

Source

Instance methods

create_client(body : Polar::Models::OAuth2ClientConfiguration)

Create Client

Create an OAuth2 client.

Endpoint: POST /v1/oauth2/register

Parameters:

  • body (required): Request body as Polar::Models::OAuth2ClientConfiguration

Returns: JSON response string

Raises:

  • ResourceNotFoundError on 404
  • NotPermittedError on 403
  • HTTPValidationError on 422
  • PolarError on other errors
Source
delete_client(client_id : String)

Delete Client

Delete an OAuth2 client.

Endpoint: DELETE /v1/oauth2/register/{client_id}

Parameters:

  • client_id (required): Path parameter

Returns: JSON response string

Raises:

  • ResourceNotFoundError on 404
  • NotPermittedError on 403
  • HTTPValidationError on 422
  • PolarError on other errors
Source
get_client(client_id : String)

Get Client

Get an OAuth2 client by Client ID.

Endpoint: GET /v1/oauth2/register/{client_id}

Parameters:

  • client_id (required): Path parameter

Returns: JSON response string

Raises:

  • ResourceNotFoundError on 404
  • NotPermittedError on 403
  • HTTPValidationError on 422
  • PolarError on other errors
Source
update_client(client_id : String, body : Polar::Models::OAuth2ClientConfigurationUpdate)

Update Client

Update an OAuth2 client.

Endpoint: PUT /v1/oauth2/register/{client_id}

Parameters:

  • client_id (required): Path parameter
  • body (required): Request body as Polar::Models::OAuth2ClientConfigurationUpdate

Returns: JSON response string

Raises:

  • ResourceNotFoundError on 404
  • NotPermittedError on 403
  • HTTPValidationError on 422
  • PolarError on other errors
Source