Skip to content
Authrim

Execute a support operation action

POST
/api/admin/support-ops/actions/{actionId}/execute
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/support-ops/actions/example/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

Execute an approved support operation action. Currently only User suspend is implemented.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
actionId
required
string

Request Body

Section titled “Request Body ”
Media type application/json
object
key
additional properties
Example 
{}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Support operation execution result.

Media type application/json
object
action_id
required
string
status
required
string
resource
required
string
action
required
string
cohort_id
required
string
matched_count
integer format: int64
attempted_count
integer format: int64
succeeded_count
integer format: int64
failed_count
integer format: int64
blocked_count
integer format: int64
privacy
object
min_count
integer format: int64
low_count_suppressed
boolean
count_precision
integer format: int64
count_exact
boolean
complementary_suppression
boolean
Example 
{
  "action_id": "sact_123",
  "status": "completed",
  "resource": "User",
  "action": "suspend",
  "cohort_id": "cohort_123",
  "matched_count": 120,
  "attempted_count": 118,
  "succeeded_count": 118,
  "failed_count": 0,
  "blocked_count": 2,
  "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"
}