Update user's harvester privileges
Updates user's ({uid}) privileges in a harvester ({id}).
This operation requires harvester_set_privileges privilege.
For administrators who do not have to be members of this harvester,
oz_harvesters_set_privileges privilege is required.
The grant field specifies a list of privileges to be granted. The revoke
field specifies a list of privileges to be revoked. At least one of those
fields must be given.
Example cURL requests
Update user's privileges in a harvester
curl -u admin:password -X PATCH -H "Content-type: application/json" \
-d '{"grant": ["harvester_view", "harvester_update"], "revoke": ["harvester_delete"]}' \
https://$ZONE_HOST/api/v3/onezone/harvesters/$HARVESTER_ID/users/$USER_ID/privileges
Path parameters
| Parameter | Type & Description |
|---|---|
| id required | string Harvester Id. |
| uid required | string User Id. |
Request body
Harvester privileges update request.
A list of privileges in the harvester.
A list of privileges in the harvester.
Request Examples
{
"grant": [
"harvester_view",
"harvester_update",
"harvester_delete",
"harvester_view_privileges",
"harvester_set_privileges"
],
"revoke": [
"harvester_invite_user",
"harvester_remove_user",
"harvester_add_group",
"harvester_remove_group"
]
}Responses
The privileges have been updated.
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."
}
}