Apply a workspace member lifecycle action

Runs a lifecycle action. Effects are limited to this workspace. At most 10 actions per member per hour.

action	Allowed from	Result
deactivate	active, suspended, locked	deactivated; workspace sessions end
suspend	active	suspended; workspace sessions end
reactivate	suspended, deactivated, locked	active; a sign-in lockout returns 409 LOCKED_BY_LOGIN_LOCKOUT
reset_mfa	active, locked	MFA enrolment cleared
revoke_sessions	active, suspended, locked	workspace sessions end; status unchanged
resend_invite	pending, expired	new invitation, expiry restarted

Any other combination returns 409 INVALID_STATE_TRANSITION.

Required scope: workspace.members.write

POST /api/public/v1/workspaces/{workspaceId}/members/{memberId}/actions

Apply a workspace member lifecycle action

cURL

curl --request POST \
  --url https://{platformHost}/api/public/v1/workspaces/{workspaceId}/members/{memberId}/actions \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "action": "suspend",
  "reason": "Leave of absence"
}
'

200

{
  "success": true,
  "data": {
    "member": {
      "memberId": "0193f1c2-7a4e-7b10-9c3d-5e6f7a8b9c0d",
      "role": {
        "roleId": "builtin.workspace.restricted_member",
        "name": "RESTRICTED_MEMBER",
        "type": "system",
        "source": "direct"
      },
      "status": "pending",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "revision": 1,
      "userId": "<string>",
      "email": "[e-mail]",
      "name": "<string>",
      "expiresAt": "2023-11-07T05:31:56Z",
      "externalId": "<string>",
      "attributes": {},
      "assignmentSource": "api",
      "projects": [
        {
          "id": "<string>",
          "role": {
            "roleId": "builtin.workspace.restricted_member",
            "name": "RESTRICTED_MEMBER",
            "type": "system",
            "source": "direct"
          },
          "name": "<string>"
        }
      ],
      "projectsTruncated": true
    },
    "action": "deactivate",
    "previousStatus": "<string>",
    "warnings": [
      "INVITE_EMAIL_QUEUED"
    ]
  }
}

Using this API, you can apply a lifecycle action on a member. The actions to manage workspace members are deactivate, suspend, reactivate, reset_mfa, revoke_sessions, and resend_invite. This API request updates only a single workspace. The request needs the workspace.members.write scope. A successful response returns the updated member and the previous status.

The platform allows a maximum of 10 actions per hour per member.

The applicable actions work only on specific existing statuses.

• suspend works only on an active member.
• resend_invite works only on a pending or expired member.

An inapplicable status combination returns the error 409 INVALID_STATE_TRANSITION.

Authorizations

platformApiKeybearerPlatformKey

X-API-Key · string · header · required

Platform key, for example abl_ws_….

Headers

Idempotency-Key · string

Recommended on every write. A retry with the same key and body replays the first result instead of repeating the change. A different body returns 422 IDEMPOTENCY_KEY_REUSED; a retry while the first is still running returns 409 IDEMPOTENCY_IN_PROGRESS.

Required string length: 1 - 255

Path Parameters

workspaceId · string · required

Minimum string length: 1

memberId · string · required

Minimum string length: 1

Body

application/json

action · enum<string> · required

Available options: deactivate, suspend, reactivate, reset_mfa, revoke_sessions, resend_invite

reason · string

Maximum string length: 500

Response

200

application/json

Success

success · enum<boolean> · required

Available options: true

data · object · required

Show child attributes