All Products
Search

This Product

    CloudSSO:ListUsers

    Document Center

    CloudSSO:ListUsers

    Last Updated:Jun 10, 2026

    Mengkueri daftar pengguna.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    cloudsso:ListUsers

    list

    *User

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    DirectoryId

    string

    Yes

    ID Direktori CloudSSO.

    d-00fc2p61****
    Status

    string

    No

    Status pengguna. Parameter ini digunakan sebagai kondisi filter. Nilai valid:

    • Enabled

    • Disabled.

    Enabled
    ProvisionType

    string

    No

    Tipe pengguna. Parameter ini digunakan sebagai kondisi filter. Nilai valid:

    • Manual: Pengguna dibuat secara manual.

    • Synchronized: Pengguna disinkronkan dari IdP eksternal.

    Manual
    Filter

    string

    No

    Kondisi filter.

    Formatnya adalah <Attribute> <Operator> <Value>. Filter tidak peka huruf besar/kecil. <Attribute> hanya mendukung UserName. <Operator> hanya mendukung eq (sama dengan) dan sw (dimulai dengan).

    Contoh:

    Jika Anda menetapkan parameter ini ke UserName sw test, sistem akan mengkueri semua pengguna yang nama penggunanya dimulai dengan test. Jika Anda menetapkan parameter ini ke UserName eq testuser, sistem akan mengkueri pengguna yang nama penggunanya adalah testuser.

    UserName sw test
    MaxResults

    integer

    No

    Jumlah maksimum entri yang dikembalikan pada setiap halaman.

    Nilai valid: 1 hingga 100.

    Nilai default: 10.

    10
    NextToken

    string

    No

    Token paginasi yang digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Anda tidak perlu menentukan parameter ini untuk permintaan pertama.

    Jika jumlah total entri melebihi nilai MaxResults, entri akan dipotong. Sistem mengembalikan nilai MaxResults dan NextToken. Parameter IsTruncated diatur ke true. Anda dapat menggunakan NextToken yang dikembalikan pada panggilan berikutnya untuk mengkueri entri yang tersisa. Pertahankan parameter permintaan lainnya tidak berubah. Ulangi proses ini hingga parameter IsTruncated bernilai false. Ini menunjukkan bahwa semua entri telah dikembalikan.

    K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
    Tags

    array<object>

    No

    object

    No

    Key

    string

    No

    Value

    string

    No

    Elemen respons

    Element

    Type

    Description

    Example

    object

    The response parameters.

    NextToken

    string

    A pagination token. It can be used in the next request to retrieve a new page of results.

    Catatan

    This parameter is returned only when IsTruncated is true.

    K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
    RequestId

    string

    The request ID.

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

    integer

    The maximum number of entries returned per page.

    10
    TotalCounts

    integer

    The total number of entries that meet the filter conditions.

    2
    IsTruncated

    boolean

    Indicates whether the results are truncated. Valid values:

    • true

    • false

    false
    Users

    array<object>

    The list of users.

    array<object>

    The details of the user.

    Status

    string

    The status of the user. Valid values:

    • Enabled

    • Disabled

    Enabled
    UserName

    string

    The username.

    AliceLee@example.onmicrosoft.com
    Email

    string

    The email address of the user.

    AliceLee@example.onmicrosoft.com
    Description

    string

    The description of the user.

    This is a user.
    UserId

    string

    The user ID.

    u-00bikzkuzbb58luh****
    FirstName

    string

    The first name of the user.

    Alice
    CreateTime

    string

    The time when the user was created. The time is in UTC.

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

    string

    The type of the user. Valid values:

    • Manual: The user was manually created.

    • Synchronized: The user was synchronized from an external IdP.

    Synchronized
    DisplayName

    string

    The display name of the user.

    AliceLee
    UpdateTime

    string

    The time when the user was last modified. The time is in UTC.

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

    string

    The last name of the user.

    Lee
    ExternalId

    object

    The identifier of the user in an external IdP.

    Id

    string

    The identifier of the user in the external identity provider.

    c73******a5fdd5

    Issuer

    string

    The channel for external identity synchronization. Currently, only SCIM synchronization is supported.

    SCIM
    Tags

    array<object>

    object

    Key

    string

    Value

    string

    Contoh

    Respons sukses

    JSONformat

    {
  "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": "",
          "Value": ""
        }
      ]
    }
  ]
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.