Get approval step guide

GET

/api/admin/approvals/{requestId}/steps/{approvalId}/guide

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/approvals/example/steps/example/guide \
  --header 'Authorization: Bearer <token>'

Returns method and transport guidance for completing an approval step.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

requestId

required

string

Public approval request ID.

approvalId

required

string

Approval step ID.

Responses

200

Guide for completing an approval step.

Media type application/json

object

key

additional properties

Example

{
  "request_id": "apreq_123",
  "approval_id": "apstep_123",
  "acceptable_methods": [
    "email_otp",
    "passkey"
  ],
  "selected_method": "email_otp",
  "transport_channel": "[email protected]",
  "instructions": [
    {
      "type": "email_otp",
      "required": true
    }
  ]
}

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