Switch approval artifact method

POST

/api/approval-artifacts/{artifactId}/switch-method

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/approval-artifacts/example/switch-method \
  --header 'Content-Type: application/json' \
  --data '{ "method": "email_otp" }'

Switch an approval artifact to an allowed fallback completion method and issue a replacement artifact.

Parameters

Path Parameters

artifactId

required

string

Request Body ^required

Switch the approval artifact completion method.

Media type application/json

object

method

required

string

Allowed values: ciba passkey portal_confirm email_otp sms_otp reauth

Example

{
  "method": "email_otp"
}

Responses

200

Approval artifact method switch result.

Media type application/json

object

replaced_artifact_id

required

string

notification_result

required

object

success

boolean

method

string

transport_channel

Any of:

string

string

null

null

delivery_status

string

target

Any of:

string

string

null

null

transport_request_id

Any of:

string

string

null

null

artifact

required

object

artifact_id

string

path

string

expires_at

integer format: int64

completion_requirements

required

object

key

additional properties

request_status

required

string

Example

{
  "replaced_artifact_id": "apc_old",
  "notification_result": {
    "success": true,
    "method": "email_otp",
    "transport_channel": "email:[email protected]",
    "delivery_status": "sent",
    "target": "[email protected]",
    "transport_request_id": "msg_123"
  },
  "artifact": {
    "artifact_id": "apc_new",
    "path": "/api/approval-artifacts/apc_new",
    "expires_at": 1770086400000
  },
  "completion_requirements": {
    "mode": "step_up_required",
    "acceptable_methods": [
      "email_otp"
    ]
  },
  "request_status": "pending"
}

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"
}