Suspend an ACS User

• Request Parameters

• Response

• Examples

Suspends a specified access system user. Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can unsuspend them.

JavaScript

Suspends a specified access system user, using the associated user identity.

Code:

await seam.acs.users.suspend({
  user_identity_id: "73fac667-bd93-4548-add2-e75161d69c7c",
  acs_system_id: "f2240088-0bc7-4edb-80d1-485bd956ba7d",
});

Output:

// void

cURL

Python

Ruby

PHP

Seam CLI

Authentication Methods

• API key

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

acs_system_id String

ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.

---

acs_user_id String

ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.

---

user_identity_id String

ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.

---

Response

Returns: void

---

Examples

Suspend a user identity

Suspends a specified access system user, using the associated user identity.

JavaScript

Code:

await seam.acs.users.suspend({
  acs_user_id: "8f934186-1dbc-4098-9f66-d1b202abec9d",
});

Output:

// void

cURL

Python

Ruby

PHP

Seam CLI