Change the name of a directory by calling the UpdateDirectory API - CloudSSO - Alibaba Cloud - CloudSSO

Operation description

Changing the directory name also changes the logon URL of the CloudSSO user portal. Make sure to notify all CloudSSO users of the new URL after the change.

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

update

*Directory

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

None

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	The ID of the directory.	d-00fc2p61****
NewDirectoryName	string	No	The new name of the directory. The name must be globally unique. The name can contain lowercase letters, digits, and hyphens (-). The name cannot start or end with a hyphen (-) and cannot contain two consecutive hyphens (-). If the new name starts with `d-`, it must be the same as the directory ID. The name must be 2 to 64 characters in length.	new-example

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	B182C041-8C64-5F2F-A07B-FC67FAF89CF9
Directory	object	The information about the directory.
DirectoryId	string	The ID of the directory.	d-00fc2p61****
CreateTime	string	The time when the directory was created. The time is displayed in UTC. The time follows the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format.	2021-06-30T08:35:26Z
UpdateTime	string	The time when the directory 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-10-25T09:13:24Z
Region	string	The region ID of the directory.	cn-shanghai
DirectoryName	string	The name of the directory.	new-example

Examples

Success response

JSON format

{
  "RequestId": "B182C041-8C64-5F2F-A07B-FC67FAF89CF9",
  "Directory": {
    "DirectoryId": "d-00fc2p61****",
    "CreateTime": "2021-06-30T08:35:26Z",
    "UpdateTime": "2021-10-25T09:13:24Z",
    "Region": "cn-shanghai",
    "DirectoryName": "new-example"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.