Identity Hub API, REST: Group.Get
Returns the specified Group resource.
To get the list of available Group resources, make a List request.
HTTP request
GET https://organization-manager.api.cloud.yandex.net/organization-manager/v1/groups/{groupId}
Path parameters
|
Field |
Description |
|
groupId |
string Required field. ID of the Group resource to return. The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"organizationId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"subjectContainerId": "string",
"externalId": "string",
"labels": "object"
}
A Group resource.
For more information, see Groups.
|
Field |
Description |
|
id |
string ID of the group. |
|
organizationId |
string ID of the organization that the group belongs to. |
|
createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
name |
string Name of the group. |
|
description |
string Description of the group. |
|
subjectContainerId |
string Id of the subject container that external group belongs to. It is set if group is external. |
|
externalId |
string Id of the group from external system. It is set if group is external. |
|
labels |
object (map<string, string>) Resource labels as |