All Products
Search
Document Center

CloudSSO:CreateGroup

Last Updated:Jun 14, 2024

Creates a group.

Operation description

This topic provides an example on how to create a group named TestGroup.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
cloudsso:CreateGroupWrite
  • Group
    acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/group/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DirectoryIdstringYes

The ID of the directory.

d-00fc2p61****
GroupNamestringYes

The name of the group.

The name can contain letters, digits, underscores (_), hyphens (-), and periods (.).

The name can be up to 128 characters in length.

TestGroup
DescriptionstringNo

The description of the group.

The description can be up to 1,024 characters in length.

This is a group.

Response parameters

ParameterTypeDescriptionExample
object
Groupobject

The information about the group.

GroupNamestring

The name of the group.

TestGroup
Descriptionstring

The description of the group.

This is a group.
CreateTimestring

The time when the group was created.

2021-11-01T02:38:27Z
ProvisionTypestring

The type of the group. The value is fixed as Manual, which indicates that the group is manually created.

Manual
UpdateTimestring

The time when the information about the group was modified.

2021-11-01T02:38:27Z
GroupIdstring

The ID of the group.

g-00jqzghi2n3o5hkh****
RequestIdstring

The ID of the request.

20E9650E-EC23-593E-933F-EA0D280D040C

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": "20E9650E-EC23-593E-933F-EA0D280D040C"
}

Error codes

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