All Products
Search
Document Center

Service Catalog:ListPrincipals

Last Updated:Mar 03, 2024

Queries the Resource Access Management (RAM) users and RAM roles that are granted the permissions to access a product portfolio.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PortfolioIdstringYes

The ID of the product portfolio.

port-bp1yt7582g****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

0FEEF92D-4052-5202-87D0-3D8EC16F81BF
Principalsobject []

The RAM entities.

PrincipalTypestring

The type of the RAM entity. Valid values:

  • RamUser: a RAM user
  • RamRole: a RAM role
RamUser
PrincipalIdstring

The ID of the RAM entity.

24477111603637****

Examples

Sample success responses

JSONformat

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "Principals": [
    {
      "PrincipalType": "RamUser",
      "PrincipalId": "24477111603637****"
    }
  ]
}

Error codes

HTTP status codeError codeError message
500InternalErrorA system error occurred.

For a list of error codes, visit the Service error codes.