PUT/v2/organizations/{organizationId}/users/{userId}/disable

Disable a managed user

Disables the account of a user managed by an organization. Use this operation when you need to prevent the managed user from accessing their account without removing them from the organization. Supply the organization and user identifiers.

2 parameters
organizationIdintegerrequired
The integer identifier of the organization that manages the user.
userIdintegerrequired
The integer identifier of the managed user whose account to disable.

5 status codes
200Returns confirmation that the managed user's account was disabled.
400Returned when the request cannot be processed for the specified managed user.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is not authenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user is not permitted to manage users in the organization.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the organization or user cannot be found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when the request cannot be processed for the specified managed user. A 401 is returned when the request is not authenticated, and a 403 when the authenticated user cannot manage users in the organization. A 404 is returned when the organization or user cannot be found.