Skip to main content
POST
Create access token from client credentials

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Body

application/json
grant_type
enum<string>
required

Platform client-credentials grant for the Veryfront proxy. Agents and applications use API keys instead.

Available options:
client_credentials
Example:

"client_credentials"

client_id
string
required

Client ID for client_credentials token exchange

client_secret
string
required

Client secret for client_credentials token exchange

options
object
project_reference
string

Project UUID or slug for scoped tokens. Select at most one of project_reference, project_id, project_slug, or custom_domain; unknown projects return 400.

project_id
string

Deprecated project ID selector; a slug is not resolved here. Use project_reference.

project_slug
string

Deprecated project slug selector; a UUID is not accepted here. Use project_reference.

custom_domain
string

Custom domain to resolve project (alternative to project_id/project_slug)

Response

Token successfully generated

access_token
string
required

JWT access token for short-lived access. Lifetime uses nonzero options.expire, otherwise the configured JWT expiry.

token_type
enum<string>
required

Token type

Available options:
Bearer
user
object
required

User information (empty object for client_credentials)