Complete an approval artifact

POST

/api/approval-artifacts/{artifactId}/complete

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/approval-artifacts/example/complete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "decision": "approved", "method": "ciba", "completion_assertion": { "method": "ciba", "actor_subject_type": "admin_user", "actor_subject_id": "admin_456", "verified_at": 1770000000000, "metadata": { "source": "approval_ciba", "auth_req_id": "auth_req_123" } } }'

Consume an approval artifact, apply the decision, issue grants, and attempt to issue a decision receipt.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

artifactId

required

string

Request Body ^required

Complete an approval artifact.

Media type application/json

object

decision

required

string

Allowed values: approved denied

method

string

transport_channel

string

reason_code

string

reason_note

string

completion_assertion

object

method

string

actor_subject_type

string

actor_subject_id

string

verified_at

integer format: int64

metadata

object

key

additional properties

Example

{
  "decision": "approved",
  "method": "ciba",
  "completion_assertion": {
    "method": "ciba",
    "actor_subject_type": "admin_user",
    "actor_subject_id": "admin_456",
    "verified_at": 1770000000000,
    "metadata": {
      "source": "approval_ciba",
      "auth_req_id": "auth_req_123"
    }
  }
}

Responses

200

Approval artifact completion result.

Media type application/json

object

artifact_id

required

string

request_id

required

string

approval_id

required

string

decision

required

string

request_status

required

string

grant_ids

required

Array<string>

receipt_id

string

receipt_path

string

receipt_portal_path

string

receipt_expires_at

integer format: int64

receipt_error

string

Example

{
  "artifact_id": "apc_123",
  "request_id": "aprq_123",
  "approval_id": "appr_123",
  "decision": "approved",
  "request_status": "approved",
  "grant_ids": [
    "egr_123"
  ],
  "receipt_id": "adr_123",
  "receipt_path": "/api/approval-receipts/adr_123",
  "receipt_portal_path": "/api/approval-receipts/adr_123/portal",
  "receipt_expires_at": 1770086400000
}

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