Skip to content

Revoke selected sessions in one backend call.

POST
/v1/sessions/batch-revoke
tenant_id
string
environment_id
string
object
client_session_ids
required
Array<string>
>= 1 items
reason_code
required
string
/^[a-z0-9_]+$/
reason
string
<= 500 characters
correlation_id
string

Per-session revoke results, including partial success.

object
schema_version
required
requested_count
required
integer
succeeded_count
required
integer
failed_count
required
integer
results
required
Array<object>
object
client_session_id
required
string
status
required
Allowed values: succeeded failed
previous_state
required
One of:
string
Allowed values: pending active reconnecting draining terminated revoked expired failed
next_state
required
One of:
string
Allowed values: pending active reconnecting draining terminated revoked expired failed
reason_code
required
string
/^[a-z0-9_]+$/
error_reason
required
string | null
backend_session_ids
required
Array<string>
audit_event_ids
required
Array<string>

Caller lacks session.revoke.

Type set in Geist, Source Serif 4, and Departure Mono.