Queries information about a group.

Usage notes

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

Limits

You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetGroup

The operation that you want to perform. Set the value to GetGroup.

GroupId String Yes g-00jqzghi2n3o5hkh****

The ID of the group.

DirectoryId String Yes d-00fc2p61****

The ID of the directory.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
Group Object

The information about the group.

GroupName String TestGroup

The name of the group.

Description String This is a group.

The description of the group.

CreateTime String 2021-11-01T02:38:27Z

The time when the group was created.

ProvisionType String Manual

The type of the group. Valid values:

  • Manual: The group is manually created.
  • Synchronized: The group is synchronized from an external identity provider (IdP).
UpdateTime String 2021-11-01T02:38:27Z

The time when the information about the group was modified.

GroupId String g-00jqzghi2n3o5hkh****

The ID of the group.

RequestId String 768F908D-A66A-5A5D-816C-20C93CBBFEE3

The ID of the request.

Examples

Sample requests

https://[Endpoint]/?Action=GetGroup
&GroupId=g-00jqzghi2n3o5hkh****
&DirectoryId=d-00fc2p61****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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 API Error Center.