All Products
Search
Document Center

CloudSSO:ListAccessConfigurations

Last Updated:Mar 28, 2024

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

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

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
cloudsso:ListAccessConfigurationsList
  • AccessConfiguration
    acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/access-configuration/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DirectoryIdstringYes

The ID of the directory.

d-00fc2p61****
NextTokenstringNo

The token to return for the next page. If this is your first time to call this operation, you do not need to specify the NextToken parameter.

When you call this operation for the first time, if the total number of entries to return exceeds the value of MaxResults, the entries are truncated. Only the entries that match the value of MaxResults are returned, and the excess entries are not returned. In this case, the value of the response parameter IsTruncated is true, and NextToken is returned. In the next call, you can use the value of NextToken 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****
MaxResultsintegerNo

The number of entries to return on each page.

Valid values: 1 to 100.

Default value: 10.

10
FilterstringNo

The filter condition.

Specify the value in the <Attribute> <Operator> <Value> format. The value is not case sensitive. 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
StatusNotificationsstringNo

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

ParameterTypeDescriptionExample
object
AccessConfigurationsobject []

The access configurations.

AccessConfigurationNamestring

The name of the access configuration.

ECS-Admin
SessionDurationinteger

The duration of a session in which a CloudSSO user accesses an account in your resource directory by using the access configuration.

Unit: seconds.

900
Descriptionstring

The description of the access configuration.

This is an access configuration.
RelayStatestring

The initial web page that is displayed after a CloudSSO user accesses an account in your resource directory by using the access configuration.

https://cloudsso.console.aliyun.com
CreateTimestring

The time when the access configuration was created.

2021-11-02T08:44:23Z
UpdateTimestring

The time when the information about the access configuration was modified.

2021-11-02T08:44:23Z
StatusNotificationsarray

The status notification.

string

The status notification. Valid values:

  • Empty: No status notifications are sent.
  • ReprovisionRequired: The access configuration needs to be re-provisioned.
ReprovisionRequired
AccessConfigurationIdstring

The ID of the access configuration.

ac-00jhtfl8thteu6uj****
NextTokenstring

The token that is returned for the next page.

Note This parameter is returned only when the IsTruncated parameter is set to true.
K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestIdstring

The ID of the request.

2BC0CBAC-45E1-5BD3-BF6E-F69D1D5391C2
MaxResultsinteger

The number of entries returned per page.

10
TotalCountsinteger

The total number of entries returned.

2
IsTruncatedboolean

Indicates whether the queried entries are truncated. Valid values:

  • true: The queried entries are truncated.
  • false: The queried entries are not truncated.
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****"
    }
  ],
  "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.