全部产品
Search
文档中心

云SSO:UpdateDirectory - 修改目录名称

更新时间:Aug 09, 2024

调用UpdateDirectory修改目录名称。

接口说明

修改目录名称会影响云 SSO 用户的登录地址,请在修改后务必将新的登录地址通知用户。

本文将提供一个示例,将目录名称修改为new-example

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cloudsso:UpdateDirectoryupdate
  • Directory
    acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

请求参数

名称类型必填描述示例值
DirectoryIdstring

目录 ID。

d-00fc2p61****
NewDirectoryNamestring

新的目录名称。该参数必须全局唯一。

格式:包含小写字母、数字和短划线(-)。不能以短划线(-)开头或结尾,且不能有两个连续的短划线(-)。如果新的目录名以d-开头,则只能与本目录 ID 相同,而不能设置为其他值。

长度:2~64 个字符。

new-example

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

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

目录信息。

DirectoryIdstring

目录 ID。

d-00fc2p61****
CreateTimestring

目录创建时间。

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

目录修改时间。

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

目录所在的地域 ID。

cn-shanghai
DirectoryNamestring

目录名称。

new-example

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。