UpdateAccessConfiguration - CloudSSO - Alibaba Cloud Documentation Center

Modifies information about an access configuration.

Operation description

You can modify the Description, SessionDuration, and RelayState parameters for an access configuration.

This topic provides an example on how to change the initial web page in the access configuration ac-00jhtfl8thteu6uj**** to https://cloudsso.console.aliyun.com.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
cloudsso:UpdateAccessConfiguration	Write	AccessConfiguration acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/access-configuration/{#AccessConfigurationId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	The ID of the directory.	d-00fc2p61****
AccessConfigurationId	string	Yes	The ID of the access configuration.	ac-00jhtfl8thteu6uj****
NewDescription	string	No	The new description of the access configuration. The description can be up to 1,024 characters in length.	This is an access configuration.
NewSessionDuration	integer	No	The new 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.	3600
NewRelayState	string	No	The new 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.	https://cloudsso.console.aliyun.com

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	9B13E4EE-3853-5852-9165-597C32AD8FB7
AccessConfiguration	object	The information about the access configuration.
AccessConfigurationName	string	The name of the access configuration.	ECS-Admin
SessionDuration	integer	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
Description	string	The description of the access configuration.	This is an access configuration.
RelayState	string	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
CreateTime	string	The time when the access configuration was created.	2021-11-02T08:44:23Z
UpdateTime	string	The time when the information about the access configuration was modified.	2021-11-02T10:10:01Z
StatusNotifications	array	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
AccessConfigurationId	string	The ID of the access configuration.	ac-00jhtfl8thteu6uj****

Examples

Sample success responses

JSONformat

{
  "RequestId": "9B13E4EE-3853-5852-9165-597C32AD8FB7",
  "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-02T10:10:01Z",
    "StatusNotifications": [
      "ReprovisionRequired"
    ],
    "AccessConfigurationId": "ac-00jhtfl8thteu6uj****"
  }
}

Error codes

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