All Products
Search
Document Center

CloudSSO:CreateAccessConfiguration

Last Updated:Jun 14, 2024

Creates an access configuration.

Operation description

For more information about access configurations, see Overview of access configurations.

This topic provides an example on how to create an access configuration named ECS-Admin.

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:CreateAccessConfigurationWrite
  • AccessConfiguration
    acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/access-configuration/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DirectoryIdstringYes

The ID of the directory.

d-00fc2p61****
AccessConfigurationNamestringYes

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
DescriptionstringNo

The description of the access configuration.

The description can be up to 1,024 characters in length.

This is an access configuration.
SessionDurationintegerNo

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

Unit: seconds.

Valid values: 900 to 43200. The value 900 indicates 15 minutes. The value 43200 indicates 12 hours.

Default value: 3600. The value indicates 1 hour.

3600
RelayStatestringNo

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

The web page must be a page of the Alibaba Cloud Management Console. By default, this parameter is empty, which indicates that the initial web page is the homepage of the Alibaba Cloud Management Console.

https://cloudsso.console.aliyun.com

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

A3A41736-A050-50B6-ABC5-590F376A0044
AccessConfigurationobject

The information about the access configuration.

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.

3600
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****

Examples

Sample success responses

JSONformat

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

Error codes

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