Searching for Associated Principals and Resources
Function
This API is used to search for the principals and resources associated with a resource share you created.
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Security-Token |
No |
String |
Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
association_status |
No |
String |
Status of the association. |
association_type |
Yes |
String |
Association type (principal or resource). |
limit |
No |
Integer |
Maximum number of entries that can be displayed on a page. |
marker |
No |
String |
Page marker. |
principal |
No |
String |
Principal associated with the resource share. |
resource_urn |
No |
String |
URN of the resource associated with the resource share. |
resource_share_ids |
No |
Array of strings |
List of resource share IDs. |
resource_ids |
No |
Array of strings |
List of resource IDs. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
resource_share_associations |
Array of ResourceShareAssociation objects |
List of association details. |
page_info |
PageInfo object |
Pagination details. |
Parameter |
Type |
Description |
---|---|---|
associated_entity |
String |
Associated entity. It can be the resource URN, account ID, URN of the root OU, or URN of another OU. |
association_type |
String |
Entity type in the association. |
created_at |
String |
Time when the association was created. |
updated_at |
String |
Time when the association was last updated. |
external |
Boolean |
Whether the principle is in the same organization as the resource owner. |
resource_share_id |
String |
ID of the resource share. |
resource_share_name |
String |
Name of the resource share. |
status |
String |
Status of the association. |
status_message |
String |
Description of the status to the association. |
Example Requests
Searching for the principals and resources associated with a resource share
POST https://{endpoint}/v1/resource-share-associations/search { "association_status" : "string", "association_type" : "principal", "limit" : 2000, "marker" : "string", "principal" : "string", "resource_urn" : "string", "resource_share_ids" : [ "string" ], "resource_ids" : [ "string" ] }
Example Responses
Status code: 200
Request succeeded.
{ "resource_share_associations" : [ { "associated_entity" : "string", "association_type" : "string", "created_at" : "2022-09-19T02:10:16.960Z", "updated_at" : "2022-09-19T02:10:16.960Z", "external" : true, "resource_share_id" : "string", "resource_share_name" : "string", "status" : "string", "status_message" : "string" } ], "page_info" : { "previous_marker" : "string", "next_marker" : "string", "current_count" : 2000 } }
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.