- What's New
- Service Overview
- Getting Started
- User Guide
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
API
- Instance Management
- Access Control Attribute Management
-
Permission Set Management
- Adding a System-defined Identity Policy
- Deleting a Permission Set
- Querying Permission Set Details
- Updating a Permission Set
- Deleting a System-defined Identity Policy
- Querying Details About a Custom Identity Policy
- Adding a Custom Identity Policy
- Deleting a Custom Identity Policy
- Listing Accounts Associated with a Permission Set
- Listing System-defined Identity Policies
- Listing Pre-provisioning Statuses of Permission Sets
- Listing Permission Sets
- Creating a Permission Set
- Listing Permission Sets Provisioned to an Account
- Pre-provisioning a Permission Set
- Querying Pre-attachment Status Details of a Permission Set
- Adding a System-defined Policy
- Deleting a System-defined Policy
- Listing System-defined Policies
-
Account Assignment Management
- Removing Account Assignments
- Querying Details about the Account Assignment Creation Status
- Listing Account Assignment Creation Statuses
- Listing Account Assignment Deletion Statuses
- Listing Users or Groups Associated with an Account and a Permission Set
- Creating Account Assignments
- Querying Details about the Account Assignment Deletion Status
- Tag Management
- User Management
- Group Management
- Group Membership Management
- SCIM User Management
- SCIM Group Management
- Service Provider (SP) Management
- Client Management
- Token Management
- Device Authorization Management
- Authorization Management
- Account Management
- Agency Management
- Credentials Management
- Appendixes
- Change History
- General Reference
Copied.
Adding a User to a Group
Function
This API is used to add a user to a group in the same identity source.
URI
POST /v1/identity-stores/{identity_store_id}/group-memberships
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
identity_store_id |
Yes |
String |
Globally unique ID of the identity source Minimum length: 12 Maximum length: 12 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Security-Token |
No |
String |
Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. Maximum length: 2048 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
group_id |
Yes |
String |
Globally unique ID of an IAM Identity Center group in the identity source Minimum length: 1 Maximum length: 47 |
Yes |
Object |
Group member ID |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
identity_store_id |
String |
Globally unique ID of the identity source Minimum length: 1 Maximum length: 36 |
membership_id |
String |
Globally unique ID of the group membership in the identity source Minimum length: 1 Maximum length: 47 |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
request_id |
String |
Request ID |
encoded_authorization_message |
String |
Authentication information |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
request_id |
String |
Request ID |
encoded_authorization_message |
String |
Authentication information |
Example Request
Adding a user to a group in the same identity source
POST https://{hostname}/v1/identity-stores/{identity_store_id}/group-memberships { "group_id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a", "member_id" : { "user_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9" } }
Example Response
Status code: 200
Successful
{ "identity_store_id" : "d-a00aaaa33f", "membership_id" : "2b0aa970-7aa4-3aaf-0aae-7a2eaaaae3a5" }
Status Codes
For details, see Status Codes.
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot