Skip to main content

Retrieve a list of OAuth2 clients​

Retrieve a list of existing OAuth 2.0 clients for your organization.

Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Responses

OK

Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • cursor_pagination object

    Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.

  • limit integer
  • next_cursor string

    Opaque token addressing the next page. Absent on the last page.

  • prev_cursor string

    Opaque token addressing the previous page. Absent on the first page.

  • last_cursor string

    Opaque token addressing the final page directly, so a client can jump to the end without a total count.

  • total_count int64

    Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.

  • errors object[]
  • httpcode integer
  • message string
  • result object[]
  • client_id string

    The client identifier.

  • client_name string

    Human-friendly name to identify this client.

  • grant_types string[]

    Possible values: [client_credentials, authorization_code, refresh_token, urn:ietf:params:oauth:grant-type:token-exchange]

    The client's allowed grant types.

  • response_types array[]

    Possible values: [code, id_token, token]

    The client's allowed response types. All allowed combinations of response types have to be listed.

  • scopes string[]

    The scopes this client is allowed to request.

  • access_token_duration integer

    How long (in seconds) access tokens should be valid for. If unspecified, this defaults to 24 hours (86,400 seconds). For OIDC flows, this value is also used as the ID token duration.

  • refresh_token_duration integer

    How long (in seconds) refresh tokens should be valid for. If unspecified, this defaults to 10 days (864,000 seconds).

  • public boolean

    Indicates if this client is marked as public. Public clients are unable to use registered client secrets, such as applications running in a browser or on a mobile device. Defaults to false.

  • redirect_uris uri[]

    The client's allowed redirect URIs.

  • created_at date-time
  • last_used date-time