OS1 Services
User Management Service
How to: Change State of a User
1min
To change the state of a User, call the User State Transition endpoint and pass the following parameters in the request body:
Member | Description |
---|---|
toState | One of the valid state codes: onboarding, active, deboarding, or inactive. |
reasonCode | A valid reason code associated with the event. (optional) |
data | Any additional information about the transition. (optional) |
Request bodies are specified in JSON format. The following example request body shows how to change the state of the User:


Updated 16 Aug 2023
Did this page help you?