Sign in
OAuth

Create OAuth client metadata for administration

Changed on

Creates a new OAuth client metadata record for an authenticated administrator.

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. The plaintext client_secret is returned only in this create response and is never logged or returned by later reads.

Redirect URIs must be non-empty HTTPS URLs without fragments. Requested scopes must be supported OAuth scopes.

post/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

Request body

client_namestring required

Display name of the OAuth client.

tos_uristring uri required

HTTPS URL of the OAuth client's terms-of-service document.

policy_uristring uri required

HTTPS URL of the OAuth client's privacy policy document.

client_uristring uri required

HTTPS URL of the OAuth client's homepage or product site.

logo_uristring uri required

HTTPS URL of the OAuth client's logo image.

redirect_urisstring[] required

Registered HTTPS redirect URIs for the OAuth client.

scopeAccessTokenScopeData[]

Optional allowed scopes for tokens issued to this OAuth client.

Example request

{
  "client_name": "Acceptance OAuth client",
  "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": [
    "product-listings:write"
  ]
}

Response

OAuth client metadata created successfully.

client_idstring required

Canonical OAuthClient ID.

client_secretstring required

Plaintext OAuth client secret returned only once by the create response. Admin list, detail, and update responses omit this property entirely.

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_secret": "aurahistoria_oauth_client_secret_abcdefghijk_abcdefghijklmnopqrstuvwxyz1234567",
  "client_name": "Acceptance OAuth client",
  "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": [
    "product-listings:write"
  ],
  "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 /