UpdateGroup API でグループ名と説明を変更 - CloudSSO

操作説明

グループの GroupName と Description を変更できます。

説明

System for Cross-domain Identity Management (SCIM) 同期が有効になっている場合、SCIM を使用して同期されたグループの情報を変更することはできません。

このトピックでは、グループ g-00jqzghi2n3o5hkh**** の名前を NewTestGroup に変更する方法の例を示します。

今すぐお試しください

この 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:UpdateGroup

update

*Group

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DirectoryId	string	必須	ディレクトリの ID。	d-00fc2p61****
GroupId	string	必須	グループの ID。	g-00jqzghi2n3o5hkh****
NewGroupName	string	任意	グループの新しい名前。	NewTestGroup
NewDescription	string	任意	グループの新しい説明。	This is a group.

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターです。
Group	object	グループに関する情報。
GroupName	string	グループの名前。	NewTestGroup
Description	string	グループの説明。	This is a group.
CreateTime	string	グループが作成された時間。	2021-11-01T02:38:27Z
ProvisionType	string	グループのタイプ。有効な値は次のとおりです。 Manual: グループは手動で作成されます。 Synchronized: グループは外部 ID プロバイダー (IdP) から同期されます。	Manual
UpdateTime	string	グループが変更された時間。	2021-11-01T06:06:11Z
GroupId	string	グループの ID。	g-00jqzghi2n3o5hkh****
RequestId	string	リクエスト ID。	F723DE01-6276-5DC4-9B1F-9CBE3E1748B2

例

成功レスポンス

JSONJSON

{
  "Group": {
    "GroupName": "NewTestGroup",
    "Description": "This is a group.",
    "CreateTime": "2021-11-01T02:38:27Z",
    "ProvisionType": "Manual",
    "UpdateTime": "2021-11-01T06:06:11Z",
    "GroupId": "g-00jqzghi2n3o5hkh****"
  },
  "RequestId": "F723DE01-6276-5DC4-9B1F-9CBE3E1748B2"
}

エラーコード

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

変更履歴

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