User operations
- Juan Tomás Alonso Nieto (Deactivated)
The following operations are aimed to manage users in the Devo platform, and work both with common domain or reseller domain credentials. Keep in mind that these users are not assigned to any domain yet, so they won’t be usable until they are.
How can I create new users using the Provisioning API?
The Provisioning API does not allow to create a new user without indicating a valid domain to which you can assign it. See the workflow for creating a domain and its associated user in Create user domains. Creating a user at the same time as the domain can only be done through the Devo web site. Learn more in Sign up and log in.
When you create a new user, you need to provide the user name, the email and the role. When you create a new user providing reseller credentials, you must include the domain name. Using common domain credentials does not require providing the domain name again, but when given, the name will be validated first.
Fetch user info
User data can be fetched either by entering an email (this is the preferred method, since most operations rely solely on the email) or an external ID.
GETÂ /user/email/{email}
Fetches user data by email.
GETÂ /user/external/{id}
Fetches user data by external ID.
Update user info
To update a user's info, use one of the following operations, including the fields to update in the body.
PUTÂ /user/external/{id}
Updates user info by external ID.
PUTÂ /user/email/{email}
Updates user info by email.
The following is an example with a complete list of fields:
{
"email": "my-new-email@my-company.com",
"phone": null,
"userName": "my-new-username"
}null values will be ignored. To remove a field value, use an empty string instead (only the phone can be removed, since the email and userName values are required).