Revoke STS session - ByCloud API

delete/v1/iam/sts-sessions/{session_id}

Revoke STS session

Revoke an active STS session, invalidating its credentials. Requires `iam:RevokeSTSSession` permission.

Path Parameters

session_id

string<uuid>required

path

STS session ID

Request Body

optional

Content-Type: application/json

reason

stringoptional

Reason for revoking the session

Responses

200

Session revoked successfully

Content-Type: application/json

sts_session

objectoptional

401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired

403

Insufficient permissions

Content-Type: application/json

error

objectrequired

404

Resource not found

Content-Type: application/json

error

objectrequired

curl -X DELETE "https://api.spo1.mycloud.com/v1/iam/sts-sessions/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

Response

Session revoked successfully

{
  "sts_session": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "organization_id": "550e8400-e29b-41d4-a716-446655440000",
    "role_id": "550e8400-e29b-41d4-a716-446655440000",
    "role_name": "string",
    "principal_id": "550e8400-e29b-41d4-a716-446655440000",
    "principal_type": "user",
    "principal_name": "string",
    "session_name": "string",
    "created_at": "2024-01-15T10:30:00Z",
    "expires_at": "2024-01-15T10:30:00Z",
    "last_used_at": "2024-01-15T10:30:00Z",
    "revoked": true,
    "revoked_at": "2024-01-15T10:30:00Z",
    "revoked_reason": "string",
    "source_ip": "string",
    "is_active": true
  }
}