Finalize an Auth Request and get the callback URL.​
Finalize an Auth Request and get the callback URL for success or failure. The user must be redirected to the URL in order to inform the application about the success or failure. On success, the URL contains details for the application to obtain the tokens. This method can only be called once for an Auth request.
Path Parameters
Set this field when the authorization flow failed. It creates a callback URL to the application, with the error details set.
Request Body required
session object
Possible values: non-empty
and <= 200 characters
ID of the session, used to login the user. Connects the session to the Auth Request.
Possible values: non-empty
and <= 200 characters
Token to verify the session is valid
error object
Set this field when the authorization flow failed. It creates a callback URL to the application, with the error details set.
Possible values: [ERROR_REASON_UNSPECIFIED
, ERROR_REASON_INVALID_REQUEST
, ERROR_REASON_UNAUTHORIZED_CLIENT
, ERROR_REASON_ACCESS_DENIED
, ERROR_REASON_UNSUPPORTED_RESPONSE_TYPE
, ERROR_REASON_INVALID_SCOPE
, ERROR_REASON_SERVER_ERROR
, ERROR_REASON_TEMPORARY_UNAVAILABLE
, ERROR_REASON_INTERACTION_REQUIRED
, ERROR_REASON_LOGIN_REQUIRED
, ERROR_REASON_ACCOUNT_SELECTION_REQUIRED
, ERROR_REASON_CONSENT_REQUIRED
, ERROR_REASON_INVALID_REQUEST_URI
, ERROR_REASON_INVALID_REQUEST_OBJECT
, ERROR_REASON_REQUEST_NOT_SUPPORTED
, ERROR_REASON_REQUEST_URI_NOT_SUPPORTED
, ERROR_REASON_REGISTRATION_NOT_SUPPORTED
]
Default value: ERROR_REASON_UNSPECIFIED
Request Body required
session object
Possible values: non-empty
and <= 200 characters
ID of the session, used to login the user. Connects the session to the Auth Request.
Possible values: non-empty
and <= 200 characters
Token to verify the session is valid
error object
Set this field when the authorization flow failed. It creates a callback URL to the application, with the error details set.
Possible values: [ERROR_REASON_UNSPECIFIED
, ERROR_REASON_INVALID_REQUEST
, ERROR_REASON_UNAUTHORIZED_CLIENT
, ERROR_REASON_ACCESS_DENIED
, ERROR_REASON_UNSUPPORTED_RESPONSE_TYPE
, ERROR_REASON_INVALID_SCOPE
, ERROR_REASON_SERVER_ERROR
, ERROR_REASON_TEMPORARY_UNAVAILABLE
, ERROR_REASON_INTERACTION_REQUIRED
, ERROR_REASON_LOGIN_REQUIRED
, ERROR_REASON_ACCOUNT_SELECTION_REQUIRED
, ERROR_REASON_CONSENT_REQUIRED
, ERROR_REASON_INVALID_REQUEST_URI
, ERROR_REASON_INVALID_REQUEST_OBJECT
, ERROR_REASON_REQUEST_NOT_SUPPORTED
, ERROR_REASON_REQUEST_URI_NOT_SUPPORTED
, ERROR_REASON_REGISTRATION_NOT_SUPPORTED
]
Default value: ERROR_REASON_UNSPECIFIED
Request Body required
session object
Possible values: non-empty
and <= 200 characters
ID of the session, used to login the user. Connects the session to the Auth Request.
Possible values: non-empty
and <= 200 characters
Token to verify the session is valid
error object
Set this field when the authorization flow failed. It creates a callback URL to the application, with the error details set.
Possible values: [ERROR_REASON_UNSPECIFIED
, ERROR_REASON_INVALID_REQUEST
, ERROR_REASON_UNAUTHORIZED_CLIENT
, ERROR_REASON_ACCESS_DENIED
, ERROR_REASON_UNSUPPORTED_RESPONSE_TYPE
, ERROR_REASON_INVALID_SCOPE
, ERROR_REASON_SERVER_ERROR
, ERROR_REASON_TEMPORARY_UNAVAILABLE
, ERROR_REASON_INTERACTION_REQUIRED
, ERROR_REASON_LOGIN_REQUIRED
, ERROR_REASON_ACCOUNT_SELECTION_REQUIRED
, ERROR_REASON_CONSENT_REQUIRED
, ERROR_REASON_INVALID_REQUEST_URI
, ERROR_REASON_INVALID_REQUEST_OBJECT
, ERROR_REASON_REQUEST_NOT_SUPPORTED
, ERROR_REASON_REQUEST_URI_NOT_SUPPORTED
, ERROR_REASON_REGISTRATION_NOT_SUPPORTED
]
Default value: ERROR_REASON_UNSPECIFIED
- 200
- 403
- 404
- default
OK
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Callback URL where the user should be redirected, using a "302 FOUND" status. Contains details for the application to obtain the tokens on success, or error details on failure. Note that this field must be treated as credentials, as the contained code can be used to obtain tokens on behalve of the user.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.624Z",
"resourceOwner": "69629023906488334"
},
"callbackUrl": "https://client.example.org/cb?code=SplxlOBeZQQYbYS6WxSbIA&state=af0ifjsldkj"
}
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Callback URL where the user should be redirected, using a "302 FOUND" status. Contains details for the application to obtain the tokens on success, or error details on failure. Note that this field must be treated as credentials, as the contained code can be used to obtain tokens on behalve of the user.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.625Z",
"resourceOwner": "69629023906488334"
},
"callbackUrl": "https://client.example.org/cb?code=SplxlOBeZQQYbYS6WxSbIA&state=af0ifjsldkj"
}
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Callback URL where the user should be redirected, using a "302 FOUND" status. Contains details for the application to obtain the tokens on success, or error details on failure. Note that this field must be treated as credentials, as the contained code can be used to obtain tokens on behalve of the user.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.625Z",
"resourceOwner": "69629023906488334"
},
"callbackUrl": "https://client.example.org/cb?code=SplxlOBeZQQYbYS6WxSbIA&state=af0ifjsldkj"
}
Returned when the user does not have permission to access the resource.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}