Redeem a bootstrap echo link

POST

/api/identity/echo/redeem

curl --request POST \
  --url https://example.com/api/identity/echo/redeem \
  --header 'Content-Type: application/json' \
  --data '{}'

Consumes the one-time code a ssoosshd identity echo link carries in its fragment and returns the authorization URL for a claims echo, as the admin start does. No session or role is needed, and none is granted: the echo shows whoever signs in their own claims and establishes nothing.

A code works once. A wrong, used or expired code all get the same 404, so the endpoint tells a guesser nothing.

Request Body^required

The code from the link

Media typeapplication/json

One of:

object

object

object

The code from the link

object

code

required

string

Example ^generated

{}

Responses

200

Where to send the browser

Media typeapplication/json

object

authorization_url

required

AuthorizationURL carries prompt=login, so the provider issues a fresh token rather than replaying its own session.

string

Example ^generated

{
  "authorization_url": "example"
}

400

Malformed body

Media typeapplication/json

object

data

Data is always null on an error response.

error

required

Error is a human-readable message. Branch on the HTTP status rather than this string; it is for humans and logs.

string

error_code

required

ErrorCode is a machine-readable error classifier. One of the error_code constants from internal/apitypes; use this to decide whether to retry or branch on the failure mode.

string

Example

{
  "error": "certificate request \"9f1c…\" not found",
  "error_code": "not_found"
}

403

Cross-origin call

Media typeapplication/json

object

data

Data is always null on an error response.

error

required

Error is a human-readable message. Branch on the HTTP status rather than this string; it is for humans and logs.

string

error_code

required

ErrorCode is a machine-readable error classifier. One of the error_code constants from internal/apitypes; use this to decide whether to retry or branch on the failure mode.

string

Example

{
  "error": "certificate request \"9f1c…\" not found",
  "error_code": "not_found"
}

404

The code is wrong, used or expired

Media typeapplication/json

object

data

Data is always null on an error response.

error

required

Error is a human-readable message. Branch on the HTTP status rather than this string; it is for humans and logs.

string

error_code

required

ErrorCode is a machine-readable error classifier. One of the error_code constants from internal/apitypes; use this to decide whether to retry or branch on the failure mode.

string

Example

{
  "error": "certificate request \"9f1c…\" not found",
  "error_code": "not_found"
}