Get user
This API call retrieves information on a specific cluster user.
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
Parameter | Type | Description | In | Required |
---|---|---|---|---|
id | string | User ID path parameter. Missing or empty values will return a 'Bad Request' | path | required |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | User | Success |
400 | No ID information received for the get-user request | |
404 | Not found |
Response body objects
The UserConfig
object
The configuration of the user.
Element | Type | Description |
---|---|---|
string | User's email address | |
firstName | string | User's first name |
groups | string[] | List of user's user group IDs. |
id | string | User ID |
lastName | string | User's last name |
passwordClearText | string | 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 retrieve john.wicked
user details.
Curl
curl -X GET "https://myManaged.cluster.com/api/v1.0/onpremise/users/john.wicked" -H "accept: application/json"
Request URL
https://mymanaged.cluster.com/api/v1.0/onpremise/users/john.wicked
Response body
{
"id": "john.wicked",
"email": "john.wicked@company.com",
"firstName": "John",
"lastName": "Wicked",
"passwordClearText": null,
"groups": [
"admin"
]
}
Response code
200