| Field | Type | Required | Description | Example |
|---|---|---|---|---|
scopeType |
ScopeTypeEnum | ✔️ | Specifies the level for retrieving policies or roles, either at the account level or within product environments. | prodenv |
scopeId |
Optional<String> | ➖ | The ID of a specific product environment where the policy is applied. This parameter is only relevant if scope_type is "prodenv".- <product_environment_id> |
|
principalType |
Optional<PrincipalTypeEnum> | ➖ | The type of principal you want to retrieve roles or permission policies for. | user |
principalId |
Optional<String> | ➖ | The unique identifier of the principal you want to retrieve roles or permission policies for. Notes: * This parameter is mandatory if principal_type is provided.* Ensure the specified ID belongs to a principle of the specified type. |
|
folderId |
Optional<String> | ➖ | * In the Get role endpoint, the specified folder_id is included in the policy_statement parameter of the response. If no folder_id is specified, the policy_statement shows a placeholder for the folder_id where relevant.* In the Get a principal's roles, Get a role's principals, and Inspect endpoints, the results are filtered by the specified folder_id. Only roles or principals with policy_statement parameters associated with that folder_id are returned. |
|
assetId |
Optional<String> | ➖ | Not currently supported. | |
collectionId |
Optional<String> | ➖ | * In the Get role endpoint, the specified collection_id is included in the policy_statement parameter of the response. If no collection_id is specified, the policy_statement shows a placeholder for the collection_id where relevant.* In the Get a principal's roles and Get a role's principals endpoints, the results are filtered by the specified collection_id. Only roles or principals with policy_statement parameters associated with that collection_id are returned. |
|
paramKey |
List<String> | ➖ | The type of content instance the role applies to, either folder_id or collection_id. Use together with param_value to retrieve role assignments as they apply to a specific instance. |
[ "folder_id" ] |
paramValue |
List<String> | ➖ | The ID of the content instance (for example, a specific folder or collection). Use together with param_key to retrieve roles as they apply to a specific instance. | [ "asdfjkl12347890" ] |
cursor |
Optional<String> | ➖ | A pagination cursor for fetching subsequent results. |