ListAccessConfigurations - CloudSSO - Alibaba Cloud Documentation Center

Queries access configurations.

Operation description

This topic provides an example on how to query the access configurations within the directory d-00fc2p61****. The returned result shows that the directory contains the VPC-Admin and ECS-Admin access configurations.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cloudsso:ListAccessConfigurations	list	AccessConfiguration `acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/access-configuration/`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	The ID of the directory.	d-00fc2p61****
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of `NextToken`. When you call this operation for the first time, if the total number of entries to return is larger than the value of the `MaxResults` parameter, the entries are truncated. The system returns entries based on the value of the `MaxResults` parameter, and does not return the excess entries. In this case, the value of the response parameter `IsTruncated` is `true`, and the `NextToken` parameter is returned. In the next call, you can use the value of the `NextToken` parameter and maintain the settings of the other request parameters to query the excess entries. You can repeat the call until the value of `IsTruncated` becomes `false`. This way, all entries are returned.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
Filter	string	No	The filter condition. The value is not case-sensitive. You must specify the value in the <Attribute> <Operator> <Value> format. You can set <Attribute> only to AccessConfigurationName and <Operator> only to eq or sw. The value eq indicates Equals. The value sw indicates Starts With. For example, if you set Filter to AccessConfigurationName sw test, the operation queries all access configurations whose names start with test. If you set Filter to AccessConfigurationName eq TestAccessConfiguration, the operation queries the access configuration whose name is TestAccessConfiguration.	AccessConfigurationName sw test
StatusNotifications	string	No	The status notification. The status notification can be used to filter access configurations. Set the value to ReprovisionRequired, which indicates that the operation queries all access configurations that need to be re-provisioned.	ReprovisionRequired

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
AccessConfigurations	array<object>	The access configurations.
AccessConfiguration	object	The access configuration.
AccessConfigurationName	string	The name of the access configuration.	ECS-Admin
SessionDuration	integer	The duration of a session in which a CloudSSO user uses the access configuration to access an account in your resource directory. Unit: seconds.	900
Description	string	The description of the access configuration.	This is an access configuration.
RelayState	string	The initial web page that is displayed after a CloudSSO user uses the access configuration to access an account in your resource directory.	https://cloudsso.console.aliyun.com
CreateTime	string	The time when the access configuration was created.	2021-11-02T08:44:23Z
UpdateTime	string	The time when the information about the access configuration was modified.	2021-11-02T08:44:23Z
StatusNotifications	array	The status notifications.
String	string	The status notification. Valid values: Empty: No status notifications are sent. ReprovisionRequired: The access configuration needs to be re-provisioned.	ReprovisionRequired
AccessConfigurationId	string	The ID of the access configuration.	ac-00jhtfl8thteu6uj****
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. Note This parameter is returned only when the value of the `IsTruncated` parameter is `true`.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestId	string	The request ID.	2BC0CBAC-45E1-5BD3-BF6E-F69D1D5391C2
MaxResults	integer	The number of entries per page.	10
TotalCounts	integer	The total number of entries returned.	2
IsTruncated	boolean	Indicates whether the queried entries are truncated. Valid values: true false	false

Examples

Sample success responses

JSONformat

{
  "AccessConfigurations": [
    {
      "AccessConfigurationName": "ECS-Admin",
      "SessionDuration": 900,
      "Description": "This is an access configuration.",
      "RelayState": "https://cloudsso.console.aliyun.com",
      "CreateTime": "2021-11-02T08:44:23Z",
      "UpdateTime": "2021-11-02T08:44:23Z",
      "StatusNotifications": [
        "ReprovisionRequired"
      ],
      "AccessConfigurationId": "ac-00jhtfl8thteu6uj****",
      "Tags": [
        {
          "Key": "",
          "Value": ""
        }
      ]
    }
  ],
  "NextToken": "K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****",
  "RequestId": "2BC0CBAC-45E1-5BD3-BF6E-F69D1D5391C2",
  "MaxResults": 10,
  "TotalCounts": 2,
  "IsTruncated": false
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history