Add user to group
Adds user {uid} as member of group {id}. Optional privileges can be passed in the request body, otherwise default privileges will be set for the user in this group.
This operation can only be invoked by the user {uid} to add himself to the
group (if he is not a member already) and requires group_add_user
privilege in the group. If privileges are specified in the request,
group_set_privileges privilege is also required.
Administrators having the oz_groups_add_relationships and
oz_users_add_relationships admin privileges can add any user to any group,
though oz_groups_set_privileges privilege is required if privileges are
specified in the request.
Example cURL requests
Generate user group invite token
curl -u admin:password -X PUT \
https://$ZONE_HOST/api/v3/onezone/groups/$GROUP_ID/users/$USER_ID
Path parameters
| Parameter | Type & Description |
|---|---|
| id required | string Group Id. |
| uid required | string User Id. |
Request body
A list of privileges in the group.
Request Examples
onezone-rest-cli addGroupUser id=a4d3bc73aada63052310652d421609f1 uid=a5b469a2b0516b662a49da74d6d7d7bcResponses
URI of the added user in form https://$ZONE_HOST/api/onezone/v3/groups/{id}/users/{uid} is returned in the response Location header.
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."
}
}