Sign in
OAuth

Get OAuth client metadata for consent

Reads the authoritative registered metadata for one OAuth client before the user begins or completes consent. This is a read only: it does not record consent, issue an authorization code or token, or grant privileges. Any signed-in ordinary user can read a registered client without the ADMIN role, client ownership, an existing client token, or a source partnership. Only a Cognito access JWT is accepted through BearerAuth; Cognito ID tokens, Aura opaque access tokens, and client-secret credentials are rejected. Centralized account restrictions continue to apply. Redirect URIs and allowed scopes are returned exactly as registered; scope: [] means the client has no allowed scopes and does not imply user consent. /api/v1/oauth/authorize remains authoritative and revalidates registration, exact redirect URI, requested-scope subset, and S256 PKCE before issuing a code. Every success and error response uses Cache-Control: no-store.

get/api/v1/oauth/clients/{clientId}

Request

  • Base URL: https://api.stage.aura-historia.com
  • URL: https://api.stage.aura-historia.com/api/v1/oauth/clients/{clientId}
  • Auth: HTTP bearer

Path parameters

clientIdstring required

Canonical OAuthClient ID (oc_ TypeID).

Response

Secret-free registered consent metadata retrieved successfully.

client_idstring required

Canonical OAuthClient ID (oc_ TypeID).

client_namestring required

Display name stored for the OAuth client.

tos_uristring uri required

Terms-of-service URL stored for the OAuth client.

policy_uristring uri required

Privacy-policy URL stored for the OAuth client.

client_uristring uri required

Homepage URL stored for the OAuth client.

logo_uristring uri required

Logo URL stored for the OAuth client.

redirect_urisstring[] required

Exact registered redirect URLs, including their registered query strings and other URI components.

scopeAccessTokenScopeData[] required

Allowed OAuth scopes; this does not mean that the user has granted them. Empty registrations return [].

Example response

{
  "client_id": "oc_7b0gwc1x49e0mvbt3tfexfqgb5",
  "client_name": "Aura Historia WooCommerce",
  "tos_uri": "https://integration.example/terms",
  "policy_uri": "https://integration.example/privacy",
  "client_uri": "https://integration.example",
  "logo_uri": "https://integration.example/logo.png",
  "redirect_uris": [
    "https://stage.aura-historia.com/api/oauth/client/redirect-broker/woocommerce"
  ],
  "scope": [
    "product-listings:write"
  ]
}

Changes