すべてのプロダクト
Search

このプロダクト

    CloudSSO:ListUsers

    ドキュメントセンター

    CloudSSO:ListUsers

    最終更新日:Aug 12, 2026

    ユーザーのリストを照会します。

    今すぐお試しください

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

    list

    *User

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DirectoryId

    string

    必須

    ディレクトリ ID。

    d-00fc2p61****
    Status

    string

    任意

    ユーザーステータス。このパラメーターはフィルター条件として使用されます。有効な値:

    • Enabled: ユーザーが有効です。

    • Disabled: ユーザーが無効です。

    Enabled
    ProvisionType

    string

    任意

    ユーザータイプ。このパラメーターはフィルター条件として使用されます。有効な値:

    • Manual: ユーザーが手動で作成されました。

    • Synchronized: ユーザーが外部 ID プロバイダーから同期されました。

    Manual
    Filter

    string

    任意

    フィルター条件。

    フォーマット: <Attribute> <Operator> <Value>。この値は大文字と小文字を区別しません。現在、<Attribute> は UserName のみサポートしており、Operator は eq (Equals) および sw (Start With) のみをサポートしています。

    例: Filter = "UserName sw test" は、ユーザー名が test で始まるすべてのユーザーを照会します。Filter = "UserName eq testuser" は、ユーザー名が testuser のユーザーを照会します。

    UserName sw test
    MaxResults

    integer

    任意

    1 ページあたりのエントリの最大値。

    有効な値: 1～100。

    デフォルト値: 10。

    10
    NextToken

    string

    任意

    次のページの結果を取得するためのトークン。最初の API 呼び出しでは NextToken を指定する必要はありません。

    API を初めて呼び出す際、エントリの総数が MaxResults の制限を超えている場合、データは切り捨てられ、MaxResults 件のエントリのみが返されます。この場合、レスポンスパラメーター IsTruncated が true となり、NextToken が返されます。前回返された NextToken を使用し、他のリクエストパラメーターを変更せずに API を継続して呼び出すことで、切り捨てられたデータをクエリできます。IsTruncated が false になるまでこのプロセスを繰り返すことで、すべてのデータを取得できます。

    K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
    Tags

    array<object>

    任意

    タグリスト。

    object

    任意

    Key

    string

    任意

    タグキー。

    TestKey
    Value

    string

    任意

    タグ値。

    TestValue

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    NextToken

    string

    次のページの結果を取得するためのトークン。

    説明

    このパラメーターは、IsTruncated が true の場合にのみ返されます。

    K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
    RequestId

    string

    リクエスト ID。

    734D9AAC-9A8E-5DF6-A633-ADE70FF2A9B1
    MaxResults

    integer

    1 ページあたりのエントリの最大値。

    10
    TotalCounts

    integer

    リクエストパラメーターに一致するエントリの総数。

    2
    IsTruncated

    boolean

    結果が切り捨てられているかどうかを示します。有効な値:

    • true: 結果が切り捨てられています。

    • false: 結果が切り捨てられていません。

    false
    Users

    array<object>

    ユーザーリスト。

    array<object>

    ユーザーリスト。

    Status

    string

    ユーザーのステータス。有効な値:

    • Enabled: ユーザーが有効です。

    • Disabled: ユーザーが無効です。

    Enabled
    UserName

    string

    ユーザー名。

    AliceLee@example.onmicrosoft.com
    Email

    string

    ユーザーのメールアドレス。

    AliceLee@example.onmicrosoft.com
    Description

    string

    ユーザーの説明。

    This is a user
    UserId

    string

    ユーザーの ID。

    u-00bikzkuzbb58luh****
    FirstName

    string

    ユーザーの名。

    Alice
    CreateTime

    string

    ユーザーが作成された時間 (UTC)。

    2021-06-30T09:20:08Z
    ProvisionType

    string

    ユーザーのタイプ。有効な値:

    • Manual: ユーザーが手動で作成されました。

    • Synchronized: ユーザーが外部 ID プロバイダーから同期されました。

    Synchronized
    DisplayName

    string

    ユーザーの表示名。

    AliceLee
    UpdateTime

    string

    ユーザーが最後に変更済みの時間 (協定世界時 (UTC))。

    2021-06-30T09:20:08Z
    LastName

    string

    ユーザーの姓。

    Lee
    ExternalId

    object

    外部 ID プロバイダーからのユーザーの識別子情報。

    Id

    string

    外部 ID プロバイダーにおけるユーザーの識別子。

    c73******a5fdd5

    Issuer

    string

    外部アイデンティティ同期のチャネル。 現在、SCIM 同期のみがサポートされています。

    SCIM
    Tags

    array<object>

    タグリスト。

    object

    Key

    string

    TestKey
    Value

    string

    TestValue

    例

    成功レスポンス

    JSONJSON

    {
  "NextToken": "K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****",
  "RequestId": "734D9AAC-9A8E-5DF6-A633-ADE70FF2A9B1",
  "MaxResults": 10,
  "TotalCounts": 2,
  "IsTruncated": false,
  "Users": [
    {
      "Status": "Enabled",
      "UserName": "AliceLee@example.onmicrosoft.com",
      "Email": "AliceLee@example.onmicrosoft.com",
      "Description": "This is a user.",
      "UserId": "u-00bikzkuzbb58luh****",
      "FirstName": "Alice",
      "CreateTime": "2021-06-30T09:20:08Z",
      "ProvisionType": "Synchronized",
      "DisplayName": "AliceLee",
      "UpdateTime": "2021-06-30T09:20:08Z",
      "LastName": "Lee",
      "ExternalId": {
        "Id": "c73******a5fdd5\n",
        "Issuer": "SCIM"
      },
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ]
    }
  ]
}

    エラーコード

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

    変更履歴

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