Get effective harvester user details
Returns details about a specific effective user in a harvester.
This operation requires harvester_view privilege
or oz_users_view admin privilege.
Example cURL requests
Get effective harvester user details
curl -u username:password -X GET \
https://$ZONE_HOST/api/v3/onezone/harvesters/$HARVESTER_ID/effective_users/$USER_ID
{
"userId": "f1c8b1a37aa7447b22eb65a742d40524",
"username" : "jodoe",
"fullName" : "John Doe"
}
Path parameters
| Parameter | Type & Description |
|---|---|
| id required | string Harvester Id. |
| uid required | string User Id. |
Request Examples
onezone-rest-cli getEffectiveHarvesterUser id=b752ceafabb662b4e5728b2ded25cdd1 uid=f1c8b1a37aa7447b22eb65a742d40524Responses
Details of a specific user in a harvester.
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."
}
}