Disable user

Set user status to disabled

put/usermanagement/status/disable/{username}

Request

Base URL
https://rudder.example.com/rudder/api/latest
Auth
API key in header X-API-Token
TypeScript
https://skmtc.dev/rudder/apis/rudder-api/docs/usermanagement/status/disable/:username/put.ts
A function with typed inputs. Its response is checked against the schema.

usernamestring required

Example:JaneDoe

Username of an user (unique and must not contain whitespace)

User was disabled

action'disableUser' required

The id of the action

idstring required

The id of the updated user

result'success' required

Result of the request

{
  "id": "johndoe"
}

No recorded changes to this operation across all 7 revisions of this API.