Group management API

IAM IAM

  • API Reference
    • Common request header and common response header
    • Data type
    • Error code
    • Feature Update Records
    • General Description
    • Introduction
    • Service domain
    • STS-Related Interfaces
  • API Reference_IAM
    • Common request header and common response header
    • Data type
    • Error code
    • General Description
    • Group management API
    • Introduction
    • Policy management API
    • Role Management Interfaces
    • Service domain
    • User management API
  • FAQs
    • Common Questions Overview
    • FAQs related to IAM users
    • FAQs related to product permissions
  • Function Release Records
  • Operation guide
    • Account Security Audit
    • Enterprise Account Integration
      • Federated Login Overview
      • IAM Role-based SSO
      • IAM User-based SSO
    • Group Management
    • Message Center
    • Permission Policies
      • ACL
      • Authorization
      • Managing IAM Policies
      • Permission Policy Overview
      • Policy Authentication Evaluation Logic
      • Strategy type
      • Tag-Based Authorization and Authentication
    • Role Management
      • Common scenarios
      • Create role
      • FAQs
      • Managing Roles
      • Overview
      • Related concepts
      • Using Roles
    • Settings
    • User
      • IAM User Operations
      • Two-Factor Authentication
      • User management
    • User Anomaly Behavior Analysis (Public Beta)
      • Risk Behavior Management
  • Operation records
    • Cloud Trail (Public Beta)
  • Product Announcement
    • Baidu Intelligent Cloud Enables Login Protection MFA Multi-Factor Authentication Notification for All Users
  • Product Description
    • Application scenarios
    • Concepts
    • Currently Supported Product Lines
    • Product functions
    • Product overview
    • System Restrictions
    • Enterprise Organization vs Identity and Access Management
  • Product pricing
    • Product pricing
  • Quick Start
    • Create groups and grant permissions
    • Creating IAM User Administrators
  • SDK
    • Go-SDK
      • Error handling
      • Group management API
      • Initialize SDK
      • Install the SDK Package
      • Overview
      • Policy management API
      • Role Management Interfaces
      • User management API
      • Version Change Records
    • Java-SDK
      • Error code
      • Group management API
      • Initialization
      • Install the SDK Package
      • Overview
      • Policy management API
      • Role Management Interfaces
      • User management API
      • Version Change Records
    • Python-SDK
      • Error code
      • Group management API
      • Initialization
      • Install the SDK Package
      • Overview
      • Policy management API
      • Role Management Interfaces
      • User management API
      • Version Change Records
  • Testing Knowledge Base SDK
  • Typical Practices
    • Baidu Intelligent Cloud Partner Guide to Creating IAM Users
    • User Management and Permission Assignment
All documents
menu
No results found, please re-enter

IAM IAM

  • API Reference
    • Common request header and common response header
    • Data type
    • Error code
    • Feature Update Records
    • General Description
    • Introduction
    • Service domain
    • STS-Related Interfaces
  • API Reference_IAM
    • Common request header and common response header
    • Data type
    • Error code
    • General Description
    • Group management API
    • Introduction
    • Policy management API
    • Role Management Interfaces
    • Service domain
    • User management API
  • FAQs
    • Common Questions Overview
    • FAQs related to IAM users
    • FAQs related to product permissions
  • Function Release Records
  • Operation guide
    • Account Security Audit
    • Enterprise Account Integration
      • Federated Login Overview
      • IAM Role-based SSO
      • IAM User-based SSO
    • Group Management
    • Message Center
    • Permission Policies
      • ACL
      • Authorization
      • Managing IAM Policies
      • Permission Policy Overview
      • Policy Authentication Evaluation Logic
      • Strategy type
      • Tag-Based Authorization and Authentication
    • Role Management
      • Common scenarios
      • Create role
      • FAQs
      • Managing Roles
      • Overview
      • Related concepts
      • Using Roles
    • Settings
    • User
      • IAM User Operations
      • Two-Factor Authentication
      • User management
    • User Anomaly Behavior Analysis (Public Beta)
      • Risk Behavior Management
  • Operation records
    • Cloud Trail (Public Beta)
  • Product Announcement
    • Baidu Intelligent Cloud Enables Login Protection MFA Multi-Factor Authentication Notification for All Users
  • Product Description
    • Application scenarios
    • Concepts
    • Currently Supported Product Lines
    • Product functions
    • Product overview
    • System Restrictions
    • Enterprise Organization vs Identity and Access Management
  • Product pricing
    • Product pricing
  • Quick Start
    • Create groups and grant permissions
    • Creating IAM User Administrators
  • SDK
    • Go-SDK
      • Error handling
      • Group management API
      • Initialize SDK
      • Install the SDK Package
      • Overview
      • Policy management API
      • Role Management Interfaces
      • User management API
      • Version Change Records
    • Java-SDK
      • Error code
      • Group management API
      • Initialization
      • Install the SDK Package
      • Overview
      • Policy management API
      • Role Management Interfaces
      • User management API
      • Version Change Records
    • Python-SDK
      • Error code
      • Group management API
      • Initialization
      • Install the SDK Package
      • Overview
      • Policy management API
      • Role Management Interfaces
      • User management API
      • Version Change Records
  • Testing Knowledge Base SDK
  • Typical Practices
    • Baidu Intelligent Cloud Partner Guide to Creating IAM Users
    • User Management and Permission Assignment
  • Document center
  • arrow
  • IAMIAM
  • arrow
  • API Reference_IAM
  • arrow
  • Group management API
Table of contents on this page
  • Create group
  • Query group
  • Update group
  • Delete group
  • List groups
  • Add user to group
  • Remove user from group
  • List the group to which a user belongs
  • List users within a group

Group management API

Updated at：2025-10-27

Create group

API description

Create a group.

Request structure

Plain Text 
1POST /v1/group HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string

Request headers

There are no special headers required beyond the common headers.

Request parameters

Name Types Location Description Required or not
name String RequestBody Group name Yes
description String RequestBody Group description No

Response headers

There are no special headers required beyond the common headers.

Response parameters

[GroupModel](IAM/API Reference_IAM/Data type.md#GroupModel) object

Request example

Plain Text 
1POST /v1/group HTTP/1.1
2Host: iam.bj.baidubce.com
3content-type: application/json
4Content-Length: 20
5Authorization: AuthorizationString
6{"name":"test_group"}

Response example

Plain Text 
1HTTP/1.1 201 Created     
2Content-Type: application/json;charset=UTF-8     
3X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7     
4Server: BWS     
5{
6    "description": "",
7    "id": "d3f6fd54fe3643459109ea0675c295a8",
8    "createTime": "2019-06-06T08:18:34Z",
9    "name": "test_group"
10}

Query group

API description

Query a group.

Request structure

Plain Text 
1GET /v1/group/{groupName} HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string

Request headers

There are no special headers required beyond the common headers.

Request parameters

Name Types Location Description Required or not
groupName String URL parameter Group name Yes

Response headers

There are no special headers required beyond the common headers.

Response parameters

[GroupModel](IAM/API Reference_IAM/Data type.md#GroupModel) object

Request example

Plain Text 
1GET /v1/group/test_group HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: AuthorizationString

Response example

Plain Text 
1HTTP/1.1 200 OK     
2Content-Type: application/json;charset=UTF-8     
3X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7     
4Server: BWS     
5{
6    "description": "",
7    "id": "d3f6fd54fe3643459109ea0675c295a8",
8    "createTime": "2019-06-06T08:18:34Z",
9    "name": "test_group"
10}

Update group

API description

Update a group.

Request structure

Plain Text 
1PUT /v1/group/{groupName} HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string

Request headers

There are no special headers required beyond the common headers.

Request parameters

Name Types Location Description Required or not
groupName String URL parameter Group name Yes
name String RequestBody Updated group name No
description String RequestBody Group description No

Response headers

There are no special headers required beyond the common headers.

Response parameters

[GroupModel](IAM/API Reference_IAM/Data type.md#GroupModel) object

Request example

Plain Text 
1PUT /v1/group/test_group HTTP/1.1
2Host: iam.bj.baidubce.com
3content-type: application/json
4Content-Length: 39
5Authorization: AuthorizationString
6{"description":"update for test group"}

Response example

Plain Text 
1HTTP/1.1 200 OK     
2Content-Type: application/json;charset=UTF-8     
3X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7     
4Server: BWS     
5{
6    "description": "update for test group",
7    "id": "d3f6fd54fe3643459109ea0675c295a8",
8    "createTime": "2019-06-06T08:18:34Z",
9    "name": "test_group"
10}

Delete group

API description

Delete a group.

Note: Before deleting a group, remove all IAM users from the group and revoke all associated permission policies.

Request structure

Plain Text 
1DELETE /v1/group/{groupName} HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string

Request headers

There are no special headers required beyond the common headers.

Request parameters

Name Types Location Description Required or not
groupName String URL parameter Group name Yes

Response headers

There are no special headers required beyond the common headers.

Response parameters

None.

Request example

Plain Text 
1DELETE /v1/group/test_group HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: AuthorizationString

Response example

Plain Text 
1HTTP/1.1 204 No Content
2X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
3Server: BWS

List groups

API description

List all groups.

Request structure

Plain Text 
1GET /v1/group HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string

Request headers

There are no special headers required beyond the common headers.

Request parameters

None.

Response headers

There are no special headers required beyond the common headers.

Response parameters

Name Types Description
groups List<[GroupModel](IAM/API Reference_IAM/Data type.md#GroupModel)> List of group objects

Request example

Plain Text 
1GET /v1/group HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: AuthorizationString

Response example

Plain Text 
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
4Server: BWS
5{
6    "groups": [
7        {
8            "description": "update for test group",
9            "id": "d3f6fd54fe3643459109ea0675c295a8",
10            "createTime": "2019-06-06T08:18:34Z",
11            "name": "test_group"
12        }
13    ]
14}

Add user to group

API description

Add a user to a group.

Request structure

Plain Text 
1PUT /v1/group/{groupName}/user/{userName} HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string

Request headers

There are no special headers required beyond the common headers.

Request parameters

Name Types Location Description Required or not
userName String URL parameter Username Yes
groupName String URL parameter Group name Yes

Response headers

There are no special headers required beyond the common headers.

Response parameters

None.

Request example

Plain Text 
1PUT /v1/group/test_group/user/test-user HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: AuthorizationString

Response example

Plain Text 
1HTTP/1.1 204 No Content
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
4Server: BWS

Remove user from group

API description

Remove a user from a group.

Request structure

Plain Text 
1DELETE /v1/group/{groupName}/user/{userName} HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string

Request headers

There are no special headers required beyond the common headers.

Request parameters

Name Types Location Description Required or not
userName String URL parameter Username Yes
groupName String URL parameter Group name Yes

Response headers

There are no special headers required beyond the common headers.

Response parameters

None.

Request example

Plain Text 
1DELETE /v1/group/test_group/user/test-user HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: AuthorizationString

Response example

Plain Text 
1HTTP/1.1 204 No Content
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
4Server: BWS

List the group to which a user belongs

API description

List the groups a user belongs to.

Request structure

Plain Text 
1GET /v1/user/{userName}/group HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string

Request headers

There are no special headers required beyond the common headers.

Request parameters

Name Types Location Description Required or not
userName String URL parameter Username Yes

Response headers

There are no special headers required beyond the common headers.

Response parameters

Name Types Description
groups List<[GroupModel](IAM/API Reference_IAM/Data type.md#GroupModel)> List of group objects

Request example

Plain Text 
1GET /v1/user/test-user/group HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: AuthorizationString

Response example

Plain Text 
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
4Server: BWS
5{
6    "groups": [
7        {
8            "description": "",
9            "id": "5cf62eee890146ed8116f6b449268f33",
10            "name": "test_group"
11        }
12    ]
13}

List users within a group

API description

List all users in a group.

Request structure

Plain Text 
1GET /v1/group/{groupName}/user HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string

Request headers

There are no special headers required beyond the common headers.

Request parameters

Name Types Location Description Required or not
groupName String URL parameter Group name Yes

Response headers

There are no special headers required beyond the common headers.

Response parameters

Name Types Description
users List<[UserModel](IAM/API Reference_IAM/Data type.md#UserModel)> List of user objects

Request example

Plain Text 
1GET /v1/group/test_group/user
2Host: iam.bj.baidubce.com
3Authorization: AuthorizationString

Response example

Plain Text 
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
4Server: BWS
5{
6    "users": [
7        {
8            "id": "f4225c39ba2247b692eec7b461835aa1",
9            "createTime": "2019-06-06T03:42:13Z",
10            "name": "test-user"
11        }
12    ]
13}

Previous
General Description
Next
Introduction