All Products
Search
Document Center

CloudSSO:UpdateDirectory

Last Updated:Mar 01, 2024

Changes the name of a directory.

Operation description

After you change the name of a directory, the URL that is used to log on to the Cloud SSO user portal is changed. You must notify the Cloud SSO users of the correct URL.

This topic provides an example on how to change the name of a directory to new-example.

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:UpdateDirectoryWrite
  • Directory
    acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DirectoryIdstringYes

The ID of the directory.

d-00fc2p61****
NewDirectoryNamestringNo

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 have two consecutive hyphens (-). If you want to start the new name of the directory starts with d-, you must set this parameter to the ID of the directory.

The name must be 2 to 64 characters in length.

new-example

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

B182C041-8C64-5F2F-A07B-FC67FAF89CF9
Directoryobject

The information about the directory.

DirectoryIdstring

The ID of the directory.

d-00fc2p61****
CreateTimestring

The time when the directory was created.

2021-06-30T08:35:26Z
UpdateTimestring

The time when the directory was modified.

2021-10-25T09:13:24Z
Regionstring

The region ID of the directory.

cn-shanghai
DirectoryNamestring

The name of the directory.

new-example

Examples

Sample success responses

JSONformat

{
  "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

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