Suspend a User

Suspend a specified ACS user

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

/acs/users/suspend

post

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.

Authorizations

pat_with_workspaceconsole_session_with_workspaceapi_key

Body

acs_user_idstring · uuidOptional

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_idstring · uuidOptional

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.

acs_system_idstring · uuidOptional

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.

Responses

200

OK

application/json

400

Bad Request

401

Unauthorized

post

HTTPcURLJavaScriptPython

POST /acs/users/suspend HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer API Token
Content-Type: application/json
Accept: */*
Content-Length: 167

{
  "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
  "user_identity_id": "123e4567-e89b-12d3-a456-426614174000",
  "acs_system_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "ok": true
}

Request

Specify the desired ACS user by including the corresponding acs_user_id in the request body.

Request Body Parameters

Parameter	Type	Description
acs_user_id	String (UUID) Required	ID of the desired ACS user

Sample Request

Python

seam.acs.users.suspend(
  acs_user_id="33333333-3333-3333-3333-333333333333"
)

cURL (bash)

curl -X 'POST' \
  'https://connect.getseam.com/acs/users/suspend' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_user_id": "33333333-3333-3333-3333-333333333333"
}'

JavaScript

await seam.acs.users.suspend({
  acs_user_id: "33333333-3333-3333-3333-333333333333"
});

Ruby

# Coming soon!

PHP

$seam->acs->users->suspend(
  acs_user_id: "33333333-3333-3333-3333-333333333333"
);

C#

seam.UsersAcs.Suspend(
  acsUserId: "33333333-3333-3333-3333-333333333333",
);

Java

// Coming soon!

Go

suspend, uErr := client.Acs.Users.Suspend(
  context.Background(), &acs.UsersSuspendRequest{
    AcsUserId: "33333333-3333-3333-3333-333333333333",
  },
);

Response

Returns a Boolean ok status indicator or void.

Sample Response

Python

None

cURL (bash)

{
  "ok": true
}

JavaScript

void

Ruby

# Coming soon!

PHP

void

C#

void

Java

// Coming soon!

Go

{
  "ok": true
}