Query access configuration details using the GetAccessConfiguration API - CloudSSO - Alibaba Cloud - CloudSSO

Queries the information about an access configuration.

Operation description

This topic provides an example on how to query the information about the access configuration whose ID is ac-00ccule7tadaijxc****.

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

get

*AccessConfiguration

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

None

Request parameters

Parameter	Type	Required	Description	Example
AccessConfigurationId	string	Yes	The access configuration ID.	ac-00ccule7tadaijxc****
DirectoryId	string	Yes	The directory ID.	d-00fc2p61****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	D5E40508-483B-52F6-993C-D880B0F87591
AccessConfiguration	object	The access configuration information.
AccessConfigurationName	string	The name of the access configuration.	VPC-Admin
SessionDuration	integer	The session duration. The maximum duration of a session when a CloudSSO user uses the access configuration to access an account in a resource directory. Unit: seconds.	3600
Description	string	The description of the access configuration.	This is an access configuration.
RelayState	string	The initial access page. The URL of the initial page that is displayed when a CloudSSO user uses the access configuration to access an account in a resource directory.	https://cloudsso.console.alibabacloud.com
CreateTime	string	The time when the access configuration was created.	2021-06-30T09:39:44Z
UpdateTime	string	The time when the access configuration was last modified.	2021-07-26T03:02:11Z
StatusNotifications	array	The status notification information.
	string	The status notification information. Valid values: Empty: No status notification exists. ReprovisionRequired: The access configuration needs to be reprovisioned.	ReprovisionRequired
AccessConfigurationId	string	The access configuration ID.	ac-00ccule7tadaijxc****
Tags	array<object>	The tags.
	object
Key	string	The tag key.	TestKey
Value	string	The tag value.	TestValue

Examples

Success response

JSON format

{
  "RequestId": "D5E40508-483B-52F6-993C-D880B0F87591",
  "AccessConfiguration": {
    "AccessConfigurationName": "VPC-Admin",
    "SessionDuration": 3600,
    "Description": "This is an access configuration.",
    "RelayState": "https://cloudsso.console.alibabacloud.com",
    "CreateTime": "2021-06-30T09:39:44Z",
    "UpdateTime": "2021-07-26T03:02:11Z",
    "StatusNotifications": [
      "ReprovisionRequired"
    ],
    "AccessConfigurationId": "ac-00ccule7tadaijxc****",
    "Tags": [
      {
        "Key": "TestKey",
        "Value": "TestValue"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.