Query CloudSSO Access Assignments with ListAccessAssignments - CloudSSO - Alibaba Cloud - CloudSSO

Queries the list of access assignments.

Operation description

This topic provides an example of how to query the authorization information on the account in a resource directory 114240524784****. The response shows that one authorization record exists on the account.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cloudsso:ListAccessAssignments

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	The directory ID.	d-00fc2p61****
AccessConfigurationId	string	No	The access configuration ID. This parameter is used as a filter condition for the query.	ac-00jhtfl8thteu6uj****
TargetType	string	No	The task target type. This parameter is used as a filter condition for the query. Valid values: RD-Account, which indicates that the task target type is an account in a resource directory. Note You must specify both `TargetId` and `TargetType` for them to take effect as valid filter conditions.	RD-Account
TargetId	string	No	The task target ID. This parameter is used as a filter condition for the query. Note You must specify both `TargetId` and `TargetType` for them to take effect as valid filter conditions.	114240524784****
PrincipalType	string	No	The CloudSSO identity type. This parameter is used as a filter condition for the query. Valid values: User: a user. Group: a group. Note You must specify both `PrincipalId` and `PrincipalType` for them to take effect as valid filter conditions.	User
PrincipalId	string	No	The CloudSSO identity ID. This parameter is used as a filter condition for the query. Valid values: If `PrincipalType` is set to User, `PrincipalId` is the ID of the CloudSSO user. If `PrincipalType` is set to Group, `PrincipalId` is the ID of the CloudSSO group. Note You must specify both `PrincipalId` and `PrincipalType` for them to take effect as valid filter conditions.	u-00q8wbq42wiltcrk****
NextToken	string	No	The token used to retrieve the next page of results. You do not need to specify `NextToken` for the first request. When you call this operation for the first time, if the total number of entries exceeds the value of `MaxResults`, the results are truncated and only `MaxResults` entries are returned. In this case, the response parameter `IsTruncated` is `true` and a `NextToken` is returned. You can use the `NextToken` returned from the previous request in the next request while keeping all other request parameters unchanged to query the truncated results. You can repeat this process until `IsTruncated` is `false`, which indicates that all data has been retrieved.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
MaxResults	integer	No	The maximum number of entries per page. Valid values: 1 to 20. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	The response parameters.
NextToken	string	The token used to retrieve the next page of results. Note This parameter is returned only when `IsTruncated` is `true`.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestId	string	The request ID.	66898413-EB80-556D-9429-06FE3548F672
MaxResults	integer	The maximum number of entries per page.	10
TotalCounts	integer	The total number of entries that match the request parameters.	1
IsTruncated	boolean	Indicates whether the results are truncated. Valid values: true: The results are truncated. false: The results are not truncated.	false
AccessAssignments	array<object>	The list of access assignments.
	object	The list of access assignments.
AccessConfigurationName	string	The name of the access configuration.	ECS-Admin
TargetPathName	string	The path name of the task target in the resource directory.	rd-3G****/root/dev-test
PrincipalId	string	The CloudSSO identity ID.	u-00q8wbq42wiltcrk****
TargetPath	string	The path ID of the task target in the resource directory.	rd-3G**/r-Wm/114240524784**
CreateTime	string	The time when the access assignment was created.	2021-11-04T10:03:08Z
TargetType	string	The task target type. Valid values: RD-Account, which indicates that the task target type is an account in a resource directory.	RD-Account
PrincipalName	string	The name of the CloudSSO identity.	Alice
TargetName	string	The name of the task target.	dev-test
AccessConfigurationId	string	The access configuration ID.	ac-00jhtfl8thteu6uj****
PrincipalType	string	The CloudSSO identity type. Valid values: User: a user. Group: a group.	User
TargetId	string	The task target ID.	114240524784****
OriginTargetId	string		114240524784****

Examples

Success response

JSON format

{
  "NextToken": "K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****",
  "RequestId": "66898413-EB80-556D-9429-06FE3548F672",
  "MaxResults": 10,
  "TotalCounts": 1,
  "IsTruncated": false,
  "AccessAssignments": [
    {
      "AccessConfigurationName": "ECS-Admin",
      "TargetPathName": "rd-3G****/root/dev-test",
      "PrincipalId": "u-00q8wbq42wiltcrk****",
      "TargetPath": "rd-3G****/r-Wm****/114240524784****",
      "CreateTime": "2021-11-04T10:03:08Z",
      "TargetType": "RD-Account",
      "PrincipalName": "Alice",
      "TargetName": "dev-test",
      "AccessConfigurationId": "ac-00jhtfl8thteu6uj****",
      "PrincipalType": "User",
      "TargetId": "114240524784****",
      "OriginTargetId": "114240524784****"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.