Sign in
OAuth

List OAuth client metadata for administration

Changed on

Lists registered OAuth client metadata for authenticated administrators.

User and delegated-user principals must have the persisted ADMIN business role. Delegated Aura Historia access-token callers must also have the access-tokens:read capability. The OAuth protocol routes remain under /api/v1/oauth.

Results use bounded keyset pagination in fixed created ascending, then OAuthClient ID ascending order. Page sizes are clamped to 1–100, with a default of 21. The searchAfter value is a JSON-encoded [created RFC3339 timestamp, OAuthClient ID] cursor; it is omitted on the terminal page and must be sent with the same filters.

clientId is an exact OAuthClient ID filter. name is a case-insensitive substring filter. The response contains no plaintext client secret, secret hash, or masked secret value. Every success and error response uses Cache-Control: no-store.

get/api/v1/admin/oauth-clients

Request

  • Base URL: https://api.stage.aura-historia.com
  • URL: https://api.stage.aura-historia.com/api/v1/admin/oauth-clients
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Query parameters

clientIdstring

Optional exact OAuthClient ID filter.

namestring

Optional case-insensitive substring filter for the OAuth client display name.

searchAfterstring

JSON-encoded [created RFC3339 timestamp, OAuthClient ID] cursor returned by the previous page.

sizeinteger

Number of OAuth client summaries requested per page. The server clamps values to 1–100.

Response

OAuth client summaries returned successfully.

sizeinteger required

Number of items returned in the current page.

searchAfterstring[] nullable

[created RFC3339 timestamp, OAuthClient ID] cursor for the next page, omitted when no more results are available.

totalinteger nullable

Total matching OAuth clients when provided by the reader; omitted otherwise.

Example response

{
  "items": [
    {
      "client_id": "oc_7b0gwc1x49e0mvbt3tfexfqgb5",
      "client_name": "Dashboard integration",
      "tos_uri": "https://client.example/tos",
      "policy_uri": "https://client.example/policy",
      "client_uri": "https://client.example",
      "logo_uri": "https://client.example/logo.png",
      "redirect_uris": [
        "https://client.example/callback"
      ],
      "scope": [
        "access-tokens:read"
      ],
      "client_id_issued_at": 1748539200
    }
  ],
  "size": 21,
  "searchAfter": [
    "2026-09-04T12:00:00Z",
    "oc_7b0gwc1x49e0mvbt3tfexfqgb5"
  ],
  "total": 42
}

Changes

  • ba3dfa02ef63Revision changes
    • breaking

      the response property's min was decreased from 1.00 to 0.00 for the response status

    • warning

      added the new admin-overview:read enum value to the /// response property for the response status

    • warning

      added the new auctions:read enum value to the /// response property for the response status

    • warning

      added the new auctions:write enum value to the /// response property for the response status

    • warning

      added the new listing-sources:read enum value to the /// response property for the response status

    • warning

      added the new listing-sources:write enum value to the /// response property for the response status

    • warning

      added the new notifications:read enum value to the /// response property for the response status

    • warning

      added the new notifications:write enum value to the /// response property for the response status

    • warning

      added the new parties:read enum value to the /// response property for the response status

    • warning

      added the new parties:write enum value to the /// response property for the response status

    • warning

      added the new partnership-applications:read enum value to the /// response property for the response status

    • warning

      added the new partnership-applications:write enum value to the /// response property for the response status

    • warning

      added the new partnerships:read enum value to the /// response property for the response status

    • warning

      added the new partnerships:write enum value to the /// response property for the response status

    • warning

      added the new search-filters:read enum value to the /// response property for the response status

  • b6962e36b828Revision changes
    • warning

      added the new listing-sources:write enum value to the /// response property for the response status