Automate Access Configuration Updates with CloudSSO API - CloudSSO

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.alibabacloud.com.

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

update

*AccessConfiguration

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

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.alibabacloud.com

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	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.alibabacloud.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 notifications.
	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

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.