UpdateDirectory API 呼び出しによるディレクトリ名の変更 - CloudSSO

操作説明

ディレクトリの名前を変更すると、CloudSSO ユーザーポータルへのログインに使用される URL が変更されます。CloudSSO ユーザーに正しい URL を通知する必要があります。

このトピックでは、ディレクトリの名前を new-example に変更する方法の例を説明します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cloudsso:UpdateDirectory

update

*Directory

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DirectoryId	string	必須	ディレクトリの ID。	d-00fc2p61****
NewDirectoryName	string	任意	ディレクトリの新しい名前。名前はグローバルに一意である必要があります。名前には、小文字、数字、ハイフン (-) を使用できます。名前の先頭または末尾にハイフン (-) を使用したり、2 つのハイフン (-) を連続して使用したりすることはできません。ディレクトリの新しい名前を `d-` で始める場合は、このパラメーターをディレクトリの ID に設定する必要があります。名前の長さは 2～64 文字である必要があります。	new-example

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	B182C041-8C64-5F2F-A07B-FC67FAF89CF9
Directory	object	ディレクトリに関する情報。
DirectoryId	string	ディレクトリの ID。	d-00fc2p61****
CreateTime	string	ディレクトリが作成された時間。	2021-06-30T08:35:26Z
UpdateTime	string	ディレクトリが変更された時間。	2021-10-25T09:13:24Z
Region	string	ディレクトリのリージョン ID。	cn-shanghai
DirectoryName	string	ディレクトリの名前。	new-example

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。