GetGroup
Queries the details of an EIAM account group.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The instance ID. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| GroupId |
string |
Yes |
The group ID. |
group_d6sbsuumeta4h66ec3il7yxxxx |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
0441BD79-92F3-53AA-8657-F8CE4A2B912A |
| Group |
object |
The account group object information. |
|
| GroupId |
string |
The group ID. |
group_d6sbsuumeta4h66ec3il7yxxxx |
| GroupName |
string |
The group name. |
group_name |
| Description |
string |
The group description. |
test_group |
| GroupExternalId |
string |
The external ID of the group, which is used to associate the group with an external system. The default value is the account group ID. |
group_d6sbsuumeta4h66ec3il7yxxxx |
| GroupSourceType |
string |
The source type of the group. Currently, only built-in groups are supported. Valid values:
|
build_in |
| GroupSourceId |
string |
The source ID of the group. The default value is the instance ID. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| CreateTime |
integer |
The time when the group was created. The value is a UNIX timestamp in milliseconds. |
1652085686179 |
| UpdateTime |
integer |
The time when the group was last updated. The value is a UNIX timestamp in milliseconds. |
1652085686179 |
| InstanceId |
string |
The instance ID. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
Examples
Success response
JSON format
{
"RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
"Group": {
"GroupId": "group_d6sbsuumeta4h66ec3il7yxxxx",
"GroupName": "group_name",
"Description": "test_group",
"GroupExternalId": "group_d6sbsuumeta4h66ec3il7yxxxx",
"GroupSourceType": "build_in",
"GroupSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"CreateTime": 1652085686179,
"UpdateTime": 1652085686179,
"InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx"
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.