Polarex.OrganizationAccessTokens (Polarex v0.3.1)

Copy Markdown View Source

Provides API endpoints related to organization access tokens

Summary

Functions

organization_access_tokens_create(body, opts \\ [])

@spec organization_access_tokens_create(
  body :: Polarex.OrganizationAccessTokenCreate.t(),
  opts :: keyword()
) ::
  {:ok, Polarex.OrganizationAccessTokenCreateResponse.t()}
  | {:error, Polarex.HTTPValidationError.t()}

Create

Scopes: organization_access_tokens:write

Request Body

Content Types: application/json

organization_access_tokens_delete(id, opts \\ [])

@spec organization_access_tokens_delete(id :: String.t(), opts :: keyword()) ::
  :ok | {:error, Polarex.HTTPValidationError.t()}

Delete

Scopes: organization_access_tokens:write

organization_access_tokens_list(opts \\ [])

@spec organization_access_tokens_list(opts :: keyword()) ::
  {:ok, Polarex.ListResourceOrganizationAccessToken.t()}
  | {:error, Polarex.HTTPValidationError.t()}

List

List organization access tokens.

Scopes: organization_access_tokens:read organization_access_tokens:write

Options

  • organization_id: Filter by organization ID.
  • page: Page number, defaults to 1.
  • limit: Size of a page, defaults to 10. Maximum is 100.
  • sorting: Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

organization_access_tokens_update(id, body, opts \\ [])

@spec organization_access_tokens_update(
  id :: String.t(),
  body :: Polarex.OrganizationAccessTokenUpdate.t(),
  opts :: keyword()
) ::
  {:ok, Polarex.OrganizationAccessToken.t()}
  | {:error, Polarex.HTTPValidationError.t()}

Update

Scopes: organization_access_tokens:write

Request Body

Content Types: application/json