Help Center/ Resource Access Manager/ API Reference/ APIs/ Principals/ Searching for Resource Users or Owners
Updated on 2025-10-30 GMT+08:00
View PDF

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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    ram:sharedPrincipals:search

    List

    -

    -

    -

    -

URI

POST /v1/shared-principals/search

Request Parameters

Table 1 Request header 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.
Table 2 Request body parameters

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

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

Table 3 Response body parameters

Parameter

Type

Description

shared_principals

Array of SharedPrincipal objects

List of principal details.

page_info

PageInfo object

Pagination details.
Table 4 SharedPrincipal

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.
Table 5 PageInfo

Parameter

Type

Description

previous_marker

String

Marker of the previous page.

next_marker

String

Marker of the next page.

current_count

Integer

Number of pages.

Example Requests

Searching for principals that you are sharing resources with or share resources with you

POST /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.

Parent topic: Principals