GetGroup - CloudSSO - Alibaba Cloud Documentation Center

Queries information about a group.

Operation description

This topic provides an example on how to query the information about the group g-00jqzghi2n3o5hkh**** in the directory d-00fc2p61****.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cloudsso:GetGroup	Read	Group acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/group/{#GroupId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the group.	g-00jqzghi2n3o5hkh****
DirectoryId	string	Yes	The ID of the directory.	d-00fc2p61****

Response parameters

Parameter	Type	Description	Example
	object
Group	object	The information about the group.
GroupName	string	The name of the group.	TestGroup
Description	string	The description of the group.	This is a group.
CreateTime	string	The time when the group was created.	2021-11-01T02:38:27Z
ProvisionType	string	The type of the group. Valid values: Manual: The group is manually created. Synchronized: The group is synchronized from an external identity provider (IdP).	Manual
UpdateTime	string	The time when the information about the group was modified.	2021-11-01T02:38:27Z
GroupId	string	The ID of the group.	g-00jqzghi2n3o5hkh****
RequestId	string	The ID of the request.	768F908D-A66A-5A5D-816C-20C93CBBFEE3

Examples

Sample success responses

JSONformat

{
  "Group": {
    "GroupName": "TestGroup",
    "Description": "This is a group.",
    "CreateTime": "2021-11-01T02:38:27Z",
    "ProvisionType": "Manual",
    "UpdateTime": "2021-11-01T02:38:27Z",
    "GroupId": "g-00jqzghi2n3o5hkh****"
  },
  "RequestId": "768F908D-A66A-5A5D-816C-20C93CBBFEE3"
}

Error codes

For a list of error codes, visit the Service error codes.