Use the Users API

Manage user accounts within the Account Manager system. You can assign users to roles and organizations, configure authentication preferences, and manage lifecycle states (INITIAL, ENABLED, DELETED).

To create a new user, send a POST request to /dw/rest/v1/users with the required properties. See the createUser endpoint reference for complete details.

Users are created in INITIAL state and must be activated before they can log in. The user receives activation instructions via email.

To update an existing user, send a PUT request to /dw/rest/v1/users/{userId}. This is a partial update operation. Only the fields provided are updated, and omitted fields retain their current values. See the updateUser endpoint reference for complete details.

To reset a user to INITIAL state and send activation instructions, send a POST request to /dw/rest/v1/users/{userId}/reset. This is useful for password resets or account recovery scenarios. See the resetUser endpoint reference for complete details.

Removing a user is a two-step process involving specific states:

1. Disable: You must first call the disableUser endpoint to transition the user object to the DELETED state.
2. Purge: Once the user is in the DELETED state, you can use the standard HTTP DELETE method to permanently remove ("purge") the object. See the purgeUser endpoint reference for details.

To retrieve a paginated list of all users, send a GET request to /dw/rest/v1/users. Use the pageable query parameter to control pagination. See the getUsers endpoint reference for complete details.

To retrieve details about a specific user, send a GET request to /dw/rest/v1/users/{userId}. Use the expand query parameter to retrieve more information on related organizations and roles. See the getUser endpoint reference for complete details.