LockUsers - App Streaming - Alibaba Cloud ドキュメントセンター

操作説明

セキュリティ上の理由から、エンドユーザーをロックできます。ロックされたエンドユーザーは Wuying 端末にサインインしたり、Wuying クラウドリソースにアクセスしたりすることはできません。

説明

DescribeUsers 操作を呼び出して、エンドユーザーアカウントに関する情報をクエリできます。応答では、Status が 0 の場合はロック解除されたアカウントを示し、Status が 9 の場合はロック済みアカウントを示します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecd:LockUsers

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Users	array	必須	ロックするエンドユーザーのユーザー名。	test1
	string	必須	ロックするエンドユーザーのユーザー名。	alice
LogoutSession	boolean	任意	アカウントがロックされた後、エンドユーザーのすべてのアクティブセッションを終了するかどうかを指定します。デフォルト値： false。
BusinessChannel	string	任意	ビジネスチャンネル。	ENTERPRISE

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
LockUsersResult	object	ロック操作の結果。
LockedUsers	array	正常にロックされたエンドユーザーのユーザー名。
	string	正常にロックされたエンドユーザーのユーザー名。	alice
FailedUsers	array<object>	ロックに失敗したエンドユーザーのリスト。
	object	ロックに失敗したエンドユーザーの詳細。
EndUserId	string	ロックに失敗したエンドユーザーのユーザー名。	alice
ErrorCode	string	エラーコード。	InvalidUsername
ErrorMessage	string	エラーメッセージ。	test123 is an invalid username.

例

成功レスポンス

JSONJSON

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "LockUsersResult": {
    "LockedUsers": [
      "alice"
    ],
    "FailedUsers": [
      {
        "EndUserId": "alice",
        "ErrorCode": "InvalidUsername",
        "ErrorMessage": "test123 is an invalid username."
      }
    ]
  }
}

エラーコード

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

変更履歴

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