Get effective parent group details
Returns details about a specific effective parent group.
This operation requires group_view privilege.
For administrator who does not belong to this group
oz_groups_view privilege is required.
Example cURL requests
Get effective parent group details
curl -u admin:password -X GET \
https://$ZONE_HOST/api/v3/onezone/groups/$GROUP_ID/effective_parents/$PARENT_GROUP_ID
{
"groupId": "9OqgExw00RwaU2MXT51",
"name": "Group1",
"type": "organization"
}
Path parameters
| Parameter | Type & Description |
|---|---|
| id required | string Group Id. |
| pid required | string Effective parent group Id. |
Request Examples
onezone-rest-cli getEffectiveParentGroup id=f1c8b1a37aa7447b22eb65a742d40524 pid=9OqgExw00RwaU2MXT51Responses
Information about a specific effective parent group.
Unique group Id.
The name of the group.
The type of the group.
creator Object representing a subject in the system, can be perceived as client (actor) identity.
Object representing a subject in the system, can be perceived as client (actor) identity.
Type of the subject
Id of the subject (null for nobody)
Timestamp in seconds (UNIX epoch), e.g. 1563819329.
Example
{
"groupId": "a4d3bc73aada63052310652d421609f1",
"name": "Test group",
"type": "team",
"creator": {
"type": "user",
"id": "7434b256e71e1052e0d5e3e9da657ebf"
},
"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."
}
}