Searching for Distinct Resource Users or Owners
Function
This API is used to search for distinct principals that you are sharing resources with or share resources with you.
URI
POST /v1/shared-principals/search-distinct-principal
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 results on a page. If the limit parameter is not specified, the default value is 2,000. |
marker |
No |
String |
Page marker. |
principals |
No |
Array of strings |
List of principals 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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
distinct_shared_principals |
Array of DistinctSharedPrincipal objects |
List of distinct roles. |
page_info |
PageInfo object |
Pagination details. |
Example Requests
Searching for distinct principals that you are sharing resources with or share resources with you
POST https://{endpoint}/v1/shared-principals/search-distinct-principal { "limit" : 2000, "marker" : "string", "principals" : [ "string" ], "resource_urn" : "string", "resource_owner" : "self" }
Example Responses
Status code: 200
Request succeeded.
{ "distinct_shared_principals" : [ { "id" : "string", "updated_at" : "2022-09-19T02:33:45.205Z" } ], "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.