Get effective user of provider
Returns the details of an effective user of a specific provider. This operation requires any of the following authentication:
- as the subject provider (
{id}), - as user who has
cluster_viewprivilege in the cluster corresponding to the subject provider, - as user who has
oz_users_viewadmin privilege.
Example cURL requests
Get effective user of a provider
curl -u username:password -X GET \
https://$ZONE_HOST/api/v3/onezone/providers/$PROVIDER_ID/effective_users/$USER_ID
{
"userId" : "f1c8b1a37aa7447b22eb65a742d40524",
"fullName" : "John Doe",
"username" : "jodoe",
"emails" : [],
"linkedAccounts" : []
}
Path parameters
| Parameter | Type & Description |
|---|---|
| id required | string Provider Id. |
| uid required | string User Id. |
Request Examples
onezone-rest-cli getEffectiveProviderUser id=1f290dd428ff09aab8ca014d24154a35 uid=051f1a51d80c664b0d9528d81ee56a93Responses
The effective user details.
Unique user Id.
User's full name (given names + surname).
User's human-readable identifier, unique across the system. Makes it easier to identify the user and can be used for signing in with password.
Timestamp in seconds (UNIX epoch), e.g. 1563819329.
Example
{
"userId": "f1c8b1a37aa7447b22eb65a742d40524",
"fullName": "Rudolf Lingens",
"username": "r.lingens",
"creationTime": 1576152793
}Invalid request.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authentication error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authorization error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Resource not found.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Internal server Error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}