v1

latestOpenAPI 3.1.02026-07-26457177.8 KB

Authorization

Authorize a User via API

📘

You can place your application's client_id into the username field, and your client_secret into the password form field of the Authentication section of this documentation 👉.

Using the session_token obtained from /v1/partner/identity/verification, call Astra’s Partner Identity Token endpoint to Authorize the User via API.

The result of successfully calling this endpoint will result in the creation of an access_token and refresh_token.

🚧

This resource requires the OAuth Client to be configured for Trusted Authentication.

❗️

This resource is only available for eligible programs. Please reach out to your Astra Integration Specialist for more information.

post/v1/partner/identity/token

Request body

tokenstring required

The session_token obtained from the /v1/partner/identity/verification call

user_consent_capturedboolean required

By setting user_consent_captured to true, you are confirming that the End-User has consented to Astra’s Terms of Service and Privacy Policy.

expires_ininteger

The TTL of the access_token in seconds. Defaults to 7200 if not included. Valid values are between 300 and 86400 inclusive

Response

Successful response

access_tokenstring password

The access token for the User (used for any Bearer Auth resources)

expires_ininteger

Seconds from the time of authorization that the access_token will expire

refresh_tokenstring password

The token that can be used to refresh authorization and retrieve a new access_token

token_typestring

The type of token returned