ListMFADevicesForUser でユーザーの MFA デバイスをクエリする - CloudSSO

操作説明

本トピックでは、ユーザー u-00q8wbq42wiltcrk**** にバインドされている MFA デバイスを照会する方法の例を示します。返された結果は、Alice-MFA1 という名前の MFA デバイスがユーザーにバインドされていることを示しています。

今すぐお試しください

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

list

*User

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DirectoryId	string	必須	ディレクトリの ID。	d-00fc2p61****
UserId	string	必須	ユーザーの ID。	u-00q8wbq42wiltcrk****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	8B9982ED-FD0D-5622-8EA0-7B768685DCE7
TotalCounts	integer	MFA デバイスの総数。	1
MFADevices	array<object>	MFA デバイスのリスト。
	object	MFA デバイス。
DeviceType	string	MFA デバイスのタイプ。値は TOTP に固定されており、仮想 MFA デバイスを示します。仮想 MFA デバイスは、時間ベースのワンタイムパスワード (TOTP) アルゴリズムに基づいています。	TOTP
EffectiveTime	string	MFA デバイスが有効化された時刻。	2021-10-29T09:14:06Z
DeviceId	string	MFA デバイスの ID。	mfa-00ujhet8pycljj7j****
UserId	string	ユーザーの ID。	u-00q8wbq42wiltcrk****
DeviceName	string	MFA デバイスの名前。	Alice-MFA1

例

成功レスポンス

JSONJSON

{
  "RequestId": "8B9982ED-FD0D-5622-8EA0-7B768685DCE7",
  "TotalCounts": 1,
  "MFADevices": [
    {
      "DeviceType": "TOTP",
      "EffectiveTime": "2021-10-29T09:14:06Z",
      "DeviceId": "mfa-00ujhet8pycljj7j****",
      "UserId": "u-00q8wbq42wiltcrk****",
      "DeviceName": "Alice-MFA1"
    }
  ]
}

エラーコード

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

変更履歴

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