Polarex.Clients (Polarex v0.3.1)

Copy Markdown View Source

Provides API endpoints related to clients

Summary

Functions

oauth2_clients_oauth2_create_client(body, opts \\ [])

@spec oauth2_clients_oauth2_create_client(
  body :: Polarex.OAuth2ClientConfiguration.t(),
  opts :: keyword()
) :: {:ok, map()} | {:error, Polarex.HTTPValidationError.t()}

Create Client

Create an OAuth2 client.

Request Body

Content Types: application/json

oauth2_clients_oauth2_delete_client(client_id, opts \\ [])

@spec oauth2_clients_oauth2_delete_client(client_id :: String.t(), opts :: keyword()) ::
  {:ok, map()} | {:error, Polarex.HTTPValidationError.t()}

Delete Client

Delete an OAuth2 client.

oauth2_clients_oauth2_get_client(client_id, opts \\ [])

@spec oauth2_clients_oauth2_get_client(client_id :: String.t(), opts :: keyword()) ::
  {:ok, map()} | {:error, Polarex.HTTPValidationError.t()}

Get Client

Get an OAuth2 client by Client ID.

oauth2_clients_oauth2_update_client(client_id, body, opts \\ [])

@spec oauth2_clients_oauth2_update_client(
  client_id :: String.t(),
  body :: Polarex.OAuth2ClientConfigurationUpdate.t(),
  opts :: keyword()
) :: {:ok, map()} | {:error, Polarex.HTTPValidationError.t()}

Update Client

Update an OAuth2 client.

Request Body

Content Types: application/json