Get handle user
Allows to add a user to a handle.
This operation requires handle_view privilege
or oz_users_view admin privilege.
Example cURL requests
Get handle user
curl -u username:password -X GET \
https://$ZONE_HOST/api/v3/onezone/handles/$HANDLE_ID/users/$USER_ID
{
"userId" : "f1c8b1a37aa7447b22eb65a742d40524",
"fullName" : "John Doe",
"username" : "jodoe"
}
Path parameters
| Parameter | Type & Description |
|---|---|
| id required | string Handle Id. |
| uid required | string The Id of the user to add to handle. |
Request Examples
onezone-rest-cli getHandleUser id=45bf25a5cb16e12a9faa6d088a2c7088 uid=5ca9574418d5a2c509265d37356ee549Responses
User details returned successfully.
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."
}
}