Sign in
Connections

Callback

This endpoint gets called after the triggering the authorize flow.

Callback links need a state and code parameter to verify the validity of the request.

When an error occurs during the OAuth flow, providers will optionally include error parameters in the callback request instead of the code parameter.

get/vault/callback

Query parameters

statestring required

An opaque value the applications adds to the initial request that the authorization server includes when redirecting the back to the application. This value must be used by the application to prevent CSRF attacks.

codestring required

An authorization code from the connector which Apideck Vault will later exchange for an access token.

errorstring
Example:access_denied

Error code returned by the OAuth provider when authorization fails

error_descriptionstring
Example:The user denied access to your application

Human-readable description of the error from the OAuth provider

Response

Unexpected error

status_codenumber

HTTP status code

errorstring

Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)

type_namestring

The type of error returned

messagestring

A human-readable message providing more details about the error.

refstring

Link to documentation of error type

Example response

{
  "status_code": 400,
  "error": "Bad Request",
  "type_name": "RequestHeadersValidationError",
  "message": "Invalid Params",
  "detail": "Missing Header: x-apideck-consumer-id",
  "ref": "https://developers.apideck.com/errors#unauthorizederror"
}

Changes