Creates an access configuration.

Usage notes

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.

Limits

You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateAccessConfiguration

The operation that you want to perform. Set the value to CreateAccessConfiguration.

DirectoryId String Yes d-00fc2p61****

The ID of the directory.

AccessConfigurationName String Yes ECS-Admin

The name of the access configuration.

The name can contain letters, digits, and hyphens (-).

The name can be up to 32 characters in length.

Description String No This is an access configuration.

The description of the access configuration.

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

SessionDuration Integer No 3600

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.

RelayState String No https://cloudsso.console.aliyun.com

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.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String A3A41736-A050-50B6-ABC5-590F376A0044

The ID of the request.

AccessConfiguration Object

The information about the access configuration.

AccessConfigurationName String ECS-Admin

The name of the access configuration.

SessionDuration Integer 3600

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

Unit: seconds.

Description String This is an access configuration.

The description of the access configuration.

RelayState String https://cloudsso.console.aliyun.com

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

CreateTime String 2021-11-02T08:44:23Z

The time when the access configuration was created.

UpdateTime String 2021-11-02T08:44:23Z

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

StatusNotifications Array of String ReprovisionRequired

The status notification. Valid values:

  • Empty: No status notifications are sent.
  • ReprovisionRequired: The access configuration needs to be re-provisioned.
AccessConfigurationId String ac-00jhtfl8thteu6uj****

The ID of the access configuration.

Examples

Sample requests

https://[Endpoint]/?Action=CreateAccessConfiguration
&DirectoryId=d-00fc2p61****
&AccessConfigurationName=ECS-Admin
&Description=This is an access configuration.
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateAccessConfigurationResponse>
    <RequestId>A3A41736-A050-50B6-ABC5-590F376A0044</RequestId>
    <AccessConfiguration>
        <AccessConfigurationName>ECS-Admin</AccessConfigurationName>
        <SessionDuration>3600</SessionDuration>
        <Description>This is an access configuration.</Description>
        <RelayState/>
        <CreateTime>2021-11-02T08:44:23Z</CreateTime>
        <UpdateTime>2021-11-02T08:44:23Z</UpdateTime>
        <AccessConfigurationId>ac-00jhtfl8thteu6uj****</AccessConfigurationId>
    </AccessConfiguration>
</CreateAccessConfigurationResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "A3A41736-A050-50B6-ABC5-590F376A0044",
  "AccessConfiguration" : {
    "AccessConfigurationName" : "ECS-Admin",
    "SessionDuration" : 3600,
    "Description" : "This is an access configuration.",
    "RelayState" : "",
    "CreateTime" : "2021-11-02T08:44:23Z",
    "UpdateTime" : "2021-11-02T08:44:23Z",
    "StatusNotifications" : [ ],
    "AccessConfigurationId" : "ac-00jhtfl8thteu6uj****"
  }
}

Error codes

For a list of error codes, visit the API Error Center.