Skip to main content
POST
Complete a connected account request

Authorizations

Authorization
string
header
required

Bearer and DPoP tokens are supported depending on the API configuration

Headers

x-correlation-id
string

A client-provided unique identifier for a single operation, used to correlate the request across Auth0 systems. The value is surfaced under references.correlation_id in tenant logs and echoed back on the response's x-correlation-id header. Invalid or oversized values are silently dropped and replaced by a generated UUID v4. Avoid including personally identifiable information (PII).

traceparent
string

A W3C Trace Context header used to correlate the request across distributed traces. When supplied, the inbound trace is continued and a fresh child span is echoed back on the response's traceparent header; the trace ID is also surfaced under references.trace_id in tenant logs. Malformed values are ignored.

x-request-language
string

Specifies the language used for localized content generated while handling the request (such as OTP email or SMS messages), using one of the tenant's configured Supported Languages.

Body

application/json
auth_session
string
required

The authentication session identifier

Maximum string length: 64
connect_code
string
required

The authorization code returned from the connect flow

Required string length: 1 - 46
redirect_uri
string<uri>
required

The redirect URI used in the original request

Maximum string length: 2048
code_verifier
string

The PKCE code verifier

Required string length: 43 - 128

Response

Connected account request completed successfully

id
string
required

The unique identifier of the connected account

connection
string
required

The connection name

access_type
enum<string>
required

The access type, always 'offline'

Available options:
offline
created_at
string<date-time>
required

ISO date string of when the connected account was created

scopes
string[]

Array of scopes granted

expires_at
string<date-time>

ISO date string of when the refresh token expires (optional)