- 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 Permission Set Details
Function
This API is used to query details about a specified permission set according to the permission set ID.
URI
GET /v1/instances/{instance_id}/permission-sets/{permission_set_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
instance_id |
Yes |
String |
Globally unique ID of an IAM Identity Center instance |
permission_set_id |
Yes |
String |
Globally unique ID of a permission set |
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 |
---|---|---|
Object |
Permission set details |
Parameter |
Type |
Description |
---|---|---|
created_date |
Long |
Time when a permission set is created |
description |
String |
Description of a permission set Minimum length: 1 Maximum length: 700 |
name |
String |
Name of a permission set Minimum length: 1 Maximum length: 32 |
permission_set_id |
String |
Unique ID of a permission set |
relay_state |
String |
Redirection of users within an application during the federated authentication Minimum length: 1 Maximum length: 240 |
session_duration |
String |
Length of time that the application user sessions are valid for in the ISO-8601 standard Minimum length: 1 Maximum length: 100 |
permission_urn |
String |
URN of a permission set |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
request_id |
String |
Unique ID of a request |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
request_id |
String |
Unique ID of a request |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
request_id |
String |
Unique ID of a request |
Example Request
Querying details about a specified permission set according to the permission set ID
GET https://{hostname}/v1/instances/{instance_id}/permission-sets/{permission_set_id}
Example Response
Status code: 200
Successful
{ "permission_set" : { "created_date" : 1684794344964, "description" : "Example permission set", "name" : "example_0615", "permission_set_id" : "ps-8603aaaaaaaa14bd", "relay_state" : "", "session_duration" : "PT4H", "permission_urn" : "IdentityCenter::system:permissionSet:ps-8603aaaaaaaa14bd" } }
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