ListAccessConfigurations - CloudSSO - Alibaba Cloud Documentation Center

Queries a list of access configurations.

Operation description

This topic provides an example of how to query the access configurations in the folder d-00fc2p61****. The response shows two access configurations: VPC-Admin and ECS-Admin.

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:ListAccessConfigurations

list

*AccessConfiguration

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/access-configuration/*

None

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	The ID of the folder.	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. If the number of results exceeds the value of `MaxResults`, the response is truncated. The `IsTruncated` parameter is set to `true`, and a `NextToken` is returned. You can use the `NextToken` in a subsequent request with the same parameters to retrieve the next page of results. Repeat this process until `IsTruncated` is `false` to query all results.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
MaxResults	integer	No	The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	10
Filter	string	No	The filter condition. The format is `<Attribute> <Operator> <Value>` . The filter is not case-sensitive. The `<Attribute>` only supports `AccessConfigurationName`. The `<Operator>` only supports `eq` (equal to) and `sw` (starts with). Examples: If you configure this parameter to `AccessConfigurationName sw test`, the system queries all access configurations whose names start with `test`. If you configure this parameter to `AccessConfigurationName eq TestAccessConfiguration`, the system queries the access configuration named `TestAccessConfiguration`.	AccessConfigurationName sw test
StatusNotifications	string	No	The status notification, which is used as a filter condition. A value of ReprovisionRequired returns only the access configurations that need to be reprovisioned.	ReprovisionRequired
Tags	array<object>	No	The tags attached to the access configuration.
	object	No	The tag attached to the access configuration.
Key	string	No	The tag key.
Value	string	No	The tag value.

Response elements

Element	Type	Description	Example
	object	The response parameters.
AccessConfigurations	array<object>	The list of access configurations.
	array<object>	The details of the access configuration.
AccessConfigurationName	string	The name of the access configuration.	ECS-Admin
SessionDuration	integer	The session duration. The maximum session duration for a CloudSSO user who 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 access page. This is the page that a CloudSSO user is redirected to after they uses the access configuration to access an account in your resource directory.	https://cloudsso.console.alibabacloud.com
CreateTime	string	The time when the access configuration was created.	2021-11-02T08:44:23Z
UpdateTime	string	The time when the access configuration was last modified.	2021-11-02T08:44:23Z
StatusNotifications	array	The status notifications.
	string	The status notification. Valid values: Empty: No status notification was generated. ReprovisionRequired: The access configuration needs to be reprovisioned.	ReprovisionRequired
AccessConfigurationId	string	The ID of the access configuration.	ac-00jhtfl8thteu6uj****
Tags	array<object>	The tags attached to the access configuration.
	object	The tag attached to the access configuration.
Key	string	The tag key.
Value	string	The tag value.
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 `IsTruncated` is set to `true`.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestId	string	The request ID.	2BC0CBAC-45E1-5BD3-BF6E-F69D1D5391C2
MaxResults	integer	The maximum number of entries returned per page.	10
TotalCounts	integer	The total number of entries that meet the filter conditions.	2
IsTruncated	boolean	Indicates whether the response is truncated. Valid values: true: The response was truncated. false: The response was not truncated.	false

Examples

Success response

JSON format

{
  "AccessConfigurations": [
    {
      "AccessConfigurationName": "ECS-Admin",
      "SessionDuration": 900,
      "Description": "This is an access configuration.",
      "RelayState": "https://cloudsso.console.alibabacloud.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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.