Start approval CIBA completion

POST

/api/approval-artifacts/{artifactId}/ciba/start

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/approval-artifacts/example/ciba/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

Start the CIBA completion flow and dispatch the user code for an approval artifact.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

artifactId

required

string

Request Body

Media type application/json

object

key

additional properties

Example

{}

Responses

200

CIBA start result for approval artifact completion.

Media type application/json

object

auth_req_id

required

string

expires_at

required

integer format: int64

interval

required

integer format: int64

status_path

required

string

device_path

required

string

Example

{
  "auth_req_id": "g1:apac:1:cba_internal",
  "expires_at": 1770000300000,
  "interval": 5,
  "status_path": "/api/approval-artifacts/apc_123/ciba/status",
  "device_path": "/api/approval-artifacts/apc_123/ciba/device?auth_req_id=g1%3Aapac%3A1%3Acba_internal"
}

default

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}