Sign in
OAuth

Update OAuth client metadata for administration

Changed on

Updates one OAuth client metadata record for an authenticated administrator.

Omitted properties leave existing values unchanged; every explicit null is invalid because OAuth metadata is non-nullable; and {} is a valid no-op.

User and delegated-user principals must have the persisted ADMIN business role. Delegated Aura Historia access-token callers must also have the access-tokens:write capability. Redirect URIs remain non-empty HTTPS URLs without fragments, and requested scopes must be supported OAuth scopes.

The response is secret-free. This operation never exposes or rotates the client secret. Every success and error response uses Cache-Control: no-store.

patch/api/v1/admin/oauth-clients/{clientId}

Request

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

Path parameters

clientIdstring required

Canonical OAuthClient ID.

Request body

client_namestring

Optional replacement display name for the OAuth client.

tos_uristring uri

Optional replacement terms-of-service document URL for the OAuth client.

policy_uristring uri

Optional replacement privacy-policy document URL for the OAuth client.

client_uristring uri

Optional replacement homepage or product-site URL for the OAuth client.

logo_uristring uri

Optional replacement logo image URL for the OAuth client.

redirect_urisstring[]

Optional replacement set of registered HTTPS redirect URIs.

scopeAccessTokenScopeData[]

Omit to leave unchanged. Send [] to replace with an empty set; null is invalid.

Example request

{
  "client_name": "Updated acceptance OAuth client",
  "tos_uri": "https://client.example/updated-tos",
  "policy_uri": "https://client.example/updated-policy",
  "client_uri": "https://updated-client.example",
  "logo_uri": "https://updated-client.example/logo.png",
  "redirect_uris": [
    "https://client.example/updated"
  ],
  "scope": [
    "access-tokens:read"
  ]
}

Response

OAuth client metadata updated successfully without exposing a secret.

client_idstring required

Canonical OAuthClient ID.

client_namestring required

Display name of the OAuth client.

tos_uristring uri required

Terms-of-service document URL registered for the OAuth client.

policy_uristring uri required

Privacy-policy document URL registered for the OAuth client.

client_uristring uri required

Homepage or product-site URL registered for the OAuth client.

logo_uristring uri required

Logo image URL registered for the OAuth client.

redirect_urisstring[] required

Registered redirect URIs for the OAuth client.

scopeAccessTokenScopeData[] required

Allowed scopes for tokens issued to this OAuth client.

client_id_issued_atinteger required

Unix timestamp (seconds) when the OAuth client was created and its client ID was issued.

Example response

{
  "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
}

Changes

  • ba3dfa02ef63Revision changes
    • 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

    • info

      added the new admin-overview:read enum value to the request property /

    • info

      added the new auctions:read enum value to the request property /

    • info

      added the new auctions:write enum value to the request property /

    • info

      added the new listing-sources:read enum value to the request property /

    • info

      added the new listing-sources:write enum value to the request property /

    • info

      added the new notifications:read enum value to the request property /

    • info

      added the new notifications:write enum value to the request property /

    • info

      added the new parties:read enum value to the request property /

    • info

      added the new parties:write enum value to the request property /

    • info

      added the new partnership-applications:read enum value to the request property /

    • info

      added the new partnership-applications:write enum value to the request property /

    • info

      added the new partnerships:read enum value to the request property /

    • info

      added the new partnerships:write enum value to the request property /

    • info

      added the new search-filters:read enum value to the request property /

  • b6962e36b828Revision changes
    • warning

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

    • info

      added the new listing-sources:write enum value to the request property /