Update user
This API call updates a cluster user account.
Authentication
To execute this request, you need the Service Provider API (ServiceProviderAPI) permission assigned to your API token. Generate your API token via Cluster Management Console (CMC). To learn how to obtain and use it, see Cluster API - Authentication.
Endpoint
/api/v1.0/onpremise/users
Parameter
Request body objects
The UserConfig object
The configuration of the user.
User's email address
User's first name
List of user's user group IDs.
User ID
User's last name
User's password in a clear text; used only to set initial password
Request body JSON model
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"email": "string","firstName": "string","groups": ["string"],"id": "string","lastName": "string","passwordClearText": "string"}
Response
Response codes
Operation failed. The input is invalid. Possible reasons:
- all required values (ID, email, first name, last name) must be set
- invalid user data
- user email address already assigned
- user group ID does not exist
Operation forbidden - users and groups are fully managed via LDAP or SSO
Not found
Unacceptable request
Email address already registered
Response body objects
The UserConfig object
The configuration of the user.
User's email address
User's first name
List of user's user group IDs.
User ID
User's last name
User's password in a clear text; used only to set initial password
Response body JSON model
{"email": "string","firstName": "string","groups": ["string"],"id": "string","lastName": "string","passwordClearText": "string"}
Example
In this example, you update the john.wicked user to assign admins group membership only. As a response, you will receive back current state of the entity.
Curl
curl -X PUT "https://myManaged.cluster.com/api/v1.0/onpremise/users" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"id\":\"john.wicked\",\"email\":\"john.wicked@company.com\",\"firstName\":\"John\",\"lastName\":\"Wicked\",\"passwordClearText\":null,\"groups\":[\"admin\"]}"
Request URL
https://myManaged.cluster.com/api/v1.0/onpremise/users
Response body
{"id": "john.wicked","email": "john.wicked@company.com","firstName": "John","lastName": "Wicked","passwordClearText": null,"groups": ["admin"]}
Response code
200