Get account group information by using GetGroup - Identity as a Service

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eiam:GetGroup

get

*Group

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}

None

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 information about the account group.
GroupId	string	The group ID.	group_d6sbsuumeta4h66ec3il7yxxxx
GroupName	string	The name of the group.	group_name
Description	string	The description of the group.	test_group
GroupExternalId	string	The external ID of the group, which can be used to associate the group with an external system. By default, the external ID is the group ID.	group_d6sbsuumeta4h66ec3il7yxxxx
GroupSourceType	string	The source type of the group. Only build_in may be returned, which indicates that the group was created in IDaaS. *build_in:Create By Self.	build_in
GroupSourceId	string	The source ID of the group. By default, the source ID is the instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
CreateTime	integer	The time at which the group was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1652085686179
UpdateTime	integer	The time at which the group was last updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	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.