Listing System-defined Policies
Function
This API is used to list the system-defined policies that are attached to a specified permission set.
URI
GET /v1/instances/{instance_id}/permission-sets/{permission_set_id}/managed-roles
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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Maximum number of results returned for each request Minimum value: 1 Maximum value: 100 Default value: 100 |
marker |
No |
String |
Pagination marker Minimum length: 24 Maximum length: 24 |
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 |
---|---|---|
Array of objects |
List of IAM system-defined policies |
|
Object |
Pagination information |
Parameter |
Type |
Description |
---|---|---|
role_id |
String |
Unique ID of the IAM system-defined policy Minimum length: 20 Maximum length: 2048 |
role_name |
String |
Name of the IAM system-defined policy Minimum length: 1 Maximum length: 100 |
Parameter |
Type |
Description |
---|---|---|
next_marker |
String |
If present, it indicates that the available output is more than the output contained in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this operation until the next_marker response returns null. |
current_count |
Integer |
Number of records returned on this page |
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 |
Example Request
Listing the system-defined policies that are attached to a specified permission set
GET https://{hostname}/v1/instances/{instance_id}/permission-sets/{permission_set_id}/managed-roles
Example Response
Status code: 200
Successful
{ "attached_managed_roles" : [ { "role_id" : "ba5146848aaaaaaaaaaaa03de60620a5", "role_name" : "role_example_456" } ], "page_info" : { "next_marker" : null, "current_count" : 1 } }
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