Remove users from a structure

Removes up to 100 users from a structure. Only direct memberships are removed — a user who inherits membership from an ancestor structure keeps that inherited membership. Removing a user who is not a member of the structure is not an error.

Use this endpoint to remove one or more users from a structure. Send up to 100 user IDs per request. Removing a user from a structure does not deactivate them or remove them from your organization. They keep their membership of every other structure.

Requirements

Only direct memberships are removed. A user who also reaches this structure through an inherited membership from an ancestor keeps that inherited membership, and so may still appear against the structure after this call. To remove their access entirely, remove them from the ancestor that grants it.

Removing a user who is not a member of the structure is not an error.

Path Params
string
required

The unique identifier of the structure.

Body Params

Request message to remove one or more users from a structure.

user_ids
array of strings
required

The unique identifiers of the users to remove. Limited to 100 users per request.

user_ids*
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json