Skip to content
Authrim

Get an approval artifact

GET
/api/approval-artifacts/{artifactId}
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/approval-artifacts/example \
  --header 'Authorization: Bearer <token>'

Return a pending approval completion artifact, request summary, approval summary, and completion requirements.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
artifactId
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Approval artifact detail.

Media type application/json
object
artifact
required
object
key
additional properties
request
required
object
public_request_id
string
investigation_id
string
request_surface
string
requested_action
string
redaction_level
string
status
string
reason_code
string
policy_preset
string
ticket_reference
Any of:
object
key
additional properties
reference
Any of:
string
approval
required
object
id
string
step_key
string
side
string
subject_type
string
subject_id
Any of:
string
status
string
method
string
transport_channel
Any of:
string
expires_at
integer format: int64
completion_requirements
required
object
key
additional properties
Example 
{
  "artifact": {
    "artifact_id": "apc_123",
    "method": "ciba",
    "expires_at": 1770086400000
  },
  "request": {
    "public_request_id": "apr_123",
    "investigation_id": "inv_123",
    "request_surface": "support_ops",
    "requested_action": "support_action.suspend",
    "redaction_level": "summary_only",
    "status": "pending",
    "reason_code": "support_ops_action_request",
    "policy_preset": "support_case_default",
    "ticket_reference": {
      "system": "support_case",
      "id": "CASE-123"
    },
    "reference": null
  },
  "approval": {
    "id": "apa_123",
    "step_key": "support-ops-approval",
    "side": "admin_operator",
    "subject_type": "admin_user",
    "subject_id": "admin_456",
    "status": "pending",
    "method": "ciba",
    "transport_channel": "email:[email protected]",
    "expires_at": 1770086400000
  },
  "completion_requirements": {
    "mode": "step_up_required",
    "acceptable_methods": [
      "ciba"
    ]
  }
}

default

Section titled “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"
}