Automate SSO Access Configurations via CreateAccessConfiguration API - CloudSSO - Alibaba Cloud - CloudSSO

Creates an access configuration.

Operation description

For more information about access configurations, see Access configuration overview.

This topic provides an example of how to create an access configuration named 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:CreateAccessConfiguration

create

*AccessConfiguration

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

None

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	The ID of the directory.	d-00fc2p61****
AccessConfigurationName	string	Yes	The name of the access configuration. The name can contain letters, digits, and hyphens (-). The name can be up to 32 characters in length.	ECS-Admin
Description	string	No	The description of the access configuration. The description can be up to 1,024 characters in length.	This is an access configuration.
SessionDuration	integer	No	The duration of the logon session. When a Cloud SSO user uses the access configuration to access a member in your resource directory, the session can be active for a maximum of this duration. Unit: seconds. Valid values: 900 to 43200 (15 minutes to 12 hours). Default value: 3600 (1 hour).	3600
RelayState	string	No	The initial access page. When a Cloud SSO user uses the access configuration to access a member in your resource directory, the user is redirected to this page. The page must be a page of the Alibaba Cloud Management Console. By default, this parameter is empty, which indicates that the user is redirected to the homepage of the Alibaba Cloud Management Console.	https://cloudsso.console.alibabacloud.com
Tags	array<object>	No	The tags.
	object	No	The tag.
Value	string	No	The tag value.
Key	string	No	The tag key.

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	A3A41736-A050-50B6-ABC5-590F376A0044
AccessConfiguration	object	The information about the access configuration.
AccessConfigurationName	string	The name of the access configuration.	ECS-Admin
SessionDuration	integer	The duration of the logon session. When a Cloud SSO user uses the access configuration to access a member in your resource directory, the session can be active for a maximum of this duration. Unit: seconds.	3600
Description	string	The description of the access configuration.	This is an access configuration.
RelayState	string	The initial access page. When a Cloud SSO user uses the access configuration to access a member in your resource directory, the user is redirected to this page.	https://cloudsso.console.alibabacloud.com
CreateTime	string	The time when the access configuration was created. The time is displayed in UTC. The time follows the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format.	2021-11-02T08:44:23Z
UpdateTime	string	The time when the access configuration was last modified. The time is displayed in UTC. The time follows the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format.	2021-11-02T08:44:23Z
StatusNotifications	array	The status notifications.
	string	The status notification. Valid values: Empty: No status notification exists. ReprovisionRequired: The access configuration needs to be redeployed.	ReprovisionRequired
AccessConfigurationId	string	The ID of the access configuration.	ac-00jhtfl8thteu6uj****
Tags	array<object>	The tags.
	object	The tag.
Value	string	The tag value.
Key	string	The tag key.

Examples

Success response

JSON format

{
  "RequestId": "A3A41736-A050-50B6-ABC5-590F376A0044",
  "AccessConfiguration": {
    "AccessConfigurationName": "ECS-Admin",
    "SessionDuration": 3600,
    "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": [
      {
        "Value": "",
        "Key": ""
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.