Sign in
User Account

Create an Aura Historia access token

Changed on

Creates a new Aura Historia access token for the authenticated user. The response includes the plaintext bearer token once. List, get, and update responses contain only secret-free metadata and never return the bearer token again. Accepts Cognito access JWTs or Aura Historia opaque bearer access tokens. Aura Historia access tokens require the delegated access-tokens:write capability.

post/api/v1/me/access-tokens

Request

  • Base URL: https://api.stage.aura-historia.com
  • URL: https://api.stage.aura-historia.com/api/v1/me/access-tokens
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

namestring required

User-defined display name of the new access token.

scopesAccessTokenScopeData[] required

Required scopes granted to the access token. Send an empty array for no scopes.

expiresstring date-time nullable

Optional RFC3339 expiration timestamp.

Example request

{
  "name": "Partner product sync",
  "scopes": [
    "product-listings:write"
  ],
  "expires": "2026-06-30T00:00:00Z"
}

Response

Access token created successfully

userIdstring required

User who owns the access token.

accessTokenIdstring required

Unique identifier of the created access token.

accessTokenstring required

Plaintext bearer token. Store it securely; it cannot be retrieved again.

Example response

{
  "userId": "usr_5pvhvpxyhve6ts31n9x8c2y513",
  "accessTokenId": "at_4ck23tcv0meqqrbyjaka24ra6g",
  "accessToken": "aurahistoria_abcdefghijk_abcdefghijklmnopqrstuvwxyz1234567"
}

Changes

  • ba3dfa02ef63Revision changes
    • breaking

      added the new required request property

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      the endpoint scheme security AccessTokenAuth was added to the API

    • info

      added the new optional request property

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • d6278283f0e4Revision changes
    • info

      added the new admin-overview: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 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 /