Searching for Resource Users or Owners
Function
This API is used to search for principals that you are sharing resources with or share resources with you.
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 |
---|---|---|---|
limit |
No |
Integer |
Maximum number of entries that can be displayed on a page. |
marker |
No |
String |
Page marker. |
principals |
No |
Array of strings |
Principal associated with the resource share. |
resource_urn |
No |
String |
URN of the resource. |
resource_owner |
Yes |
String |
Resource owner (self or other-accounts) of the resource share. |
resource_share_ids |
No |
Array of strings |
List of resource share IDs. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
shared_principals |
Array of SharedPrincipal objects |
List of principal details. |
page_info |
PageInfo object |
Pagination details. |
Parameter |
Type |
Description |
---|---|---|
resource_share_id |
String |
ID of the resource share associated with the principal. |
id |
String |
Account ID of the principal or URN of the resource. |
created_at |
String |
Time when the principal was associated with the resource share. |
updated_at |
String |
Time when the resource share was last updated. |
Example Requests
Searching for principals that you are sharing resources with or share resources with you
POST https://{endpoint}/v1/shared-principals/search { "limit" : 2000, "marker" : "string", "principals" : [ "string" ], "resource_urn" : "string", "resource_owner" : "self", "resource_share_ids" : [ "string" ] }
Example Responses
Status code: 200
Request succeeded.
{ "shared_principals" : [ { "resource_share_id" : "string", "id" : "string", "created_at" : "2022-09-19T02:33:13.496Z", "updated_at" : "2022-09-19T02:33:13.496Z" } ], "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.