Skip to content
Authrim

Request a support operation action

POST
/api/admin/support-ops/actions
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/support-ops/actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "cohort_id": "cohort_123", "action": "suspend", "reason": "Support case CASE-123", "support_case_id": "CASE-123" }'

Create an approval-required support operation action for a completed cohort.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”

Request an approved support operation action for a completed cohort.

Media type application/json
object
cohort_id
required
string
action
required
string
reason
required
string
support_case_id
string
Example 
{
  "cohort_id": "cohort_123",
  "action": "suspend",
  "reason": "Support case CASE-123",
  "support_case_id": "CASE-123"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Support operation action response. Action creation returns approval workflow details; action lookup returns persisted action detail.

Media type application/json
object
action_id
string
cohort_id
string
resource
string
action
string
status
string
reason
string
support_case_id
Any of:
string
approval_request_id
Any of:
string
approval_url
string
requested_by
string
approved_by
Any of:
string
summary
object
key
additional properties
result_summary
object
key
additional properties
created_at
integer format: int64
updated_at
integer format: int64
Example 
{
  "action_id": "sact_123",
  "status": "approval_required",
  "approval_request_id": "apr_123",
  "approval_url": "/admin/approvals/apr_123",
  "summary": {
    "resource": "User",
    "action": "suspend",
    "matched_count": 120,
    "actionable_count": 118,
    "blocked_count": 2,
    "blocked_reasons_suppressed": false,
    "privacy": {
      "min_count": 10,
      "low_count_suppressed": false
    }
  }
}

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