- 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.
Querying Group Details
Function
This API is used to query details about an IAM Identity Center group based on the group ID.
URI
GET /v1/identity-stores/{identity_store_id}/groups/{group_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
identity_store_id |
Yes |
String |
Globally unique ID of the identity source Minimum length: 12 Maximum length: 12 |
group_id |
Yes |
String |
Globally unique ID of an IAM Identity Center group in the identity source Minimum length: 1 Maximum length: 64 |
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 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
description |
String |
Group description Minimum length: 1 Maximum length: 1024 |
display_name |
String |
Display name of a group Minimum length: 1 Maximum length: 1024 |
external_id |
String |
Identifier assigned by an external identity source to a resource |
Array of objects |
List of IDs issued by an external identity provider Array length: 1-10 |
|
group_id |
String |
Globally unique ID of an IAM Identity Center group in the identity source Minimum length: 1 Maximum length: 47 |
identity_store_id |
String |
Globally unique ID of the identity source Minimum length: 1 Maximum length: 36 |
created_at |
Long |
Timestamp when a group is created |
created_by |
String |
Creator |
updated_at |
Long |
Timestamp when a group is updated |
updated_by |
String |
Updater |
Example Request
Querying details about an IAM Identity Center group based on the group ID
GET https://{hostname}/v1/identity-stores/{identity_store_id}/groups/{group_id}
Example Response
Status code: 200
{ "description" : "Example group", "display_name" : "Group name g1", "external_ids" : null, "group_id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a", "identity_store_id" : "d-a00aaaa33f", "created_at" : 1677175760379, "created_by" : "5146d03d8aaaaaaaaaaaabbae60620a5", "updated_at" : 1677175760379, "updated_by" : "5146d03d8aaaaaaaaaaaabbae60620a5" }
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