All Products
Search

This Product

    CloudSSO:ListUsers

    Document Center

    CloudSSO:ListUsers

    Last Updated:Aug 13, 2026

    Mengambil 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.

    d-00fc2p61****
    Status

    string

    No

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

    • Enabled: Pengguna diaktifkan.

    • Disabled: Pengguna dinonaktifkan.

    Enabled
    ProvisionType

    string

    No

    Jenis pengguna. Parameter ini digunakan sebagai kondisi filter. Nilai yang valid:

    • Manual: Pengguna dibuat secara manual.

    • Synchronized: Pengguna disinkronkan dari penyedia identitas eksternal.

    Manual
    Filter

    string

    No

    Kondisi filter.

    Format: <Attribute> <Operator> <Value>. Nilai ini tidak membedakan huruf besar/kecil. Saat ini, <Attribute> hanya mendukung UserName, dan Operator hanya mendukung eq (Equals) dan sw (Start With).

    Contoh: Filter = "UserName sw test" menanyakan semua pengguna yang username-nya diawali dengan test. Filter = "UserName eq testuser" menanyakan pengguna yang username-nya adalah testuser.

    UserName sw test
    MaxResults

    integer

    No

    Jumlah maksimum entri per halaman.

    Nilai yang valid: 1 hingga 100.

    Nilai default: 10.

    10
    NextToken

    string

    No

    Token untuk halaman hasil berikutnya. Anda tidak perlu menentukan NextToken pada pemanggilan API pertama.

    Saat Anda memanggil API untuk pertama kali, jika jumlah total entri melebihi batas MaxResults, data akan dipotong dan hanya MaxResults entri yang dikembalikan. Dalam kasus ini, parameter respons IsTruncated bernilai true dan sebuah NextToken dikembalikan. Anda dapat menggunakan NextToken yang dikembalikan dari pemanggilan sebelumnya untuk melanjutkan pemanggilan API sambil menjaga parameter permintaan lainnya tetap sama guna menanyakan data yang terpotong tersebut. Anda dapat mengulangi proses ini hingga IsTruncated bernilai false, yang menandakan bahwa seluruh data telah diambil.

    K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
    Tags

    array<object>

    No

    Daftar tag.

    object

    No

    Key

    string

    No

    Kunci tag.

    TestKey
    Value

    string

    No

    Nilai tag.

    TestValue

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter respons.

    NextToken

    string

    Token untuk halaman hasil berikutnya.

    Catatan

    Parameter ini hanya dikembalikan ketika IsTruncated bernilai true.

    K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
    RequestId

    string

    ID permintaan.

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

    integer

    Jumlah maksimum entri per halaman.

    10
    TotalCounts

    integer

    Jumlah total entri yang sesuai dengan parameter permintaan.

    2
    IsTruncated

    boolean

    Menunjukkan apakah hasilnya terpotong. Nilai yang valid:

    • true: Hasil terpotong.

    • false: Hasil tidak terpotong.

    false
    Users

    array<object>

    Daftar pengguna.

    array<object>

    Daftar pengguna.

    Status

    string

    Status pengguna. Nilai yang valid:

    • Enabled: Pengguna diaktifkan.

    • Disabled: Pengguna dinonaktifkan.

    Enabled
    UserName

    string

    Username.

    AliceLee@example.onmicrosoft.com
    Email

    string

    Alamat email pengguna.

    AliceLee@example.onmicrosoft.com
    Description

    string

    Deskripsi pengguna.

    This is a user.
    UserId

    string

    ID pengguna.

    u-00bikzkuzbb58luh****
    FirstName

    string

    Nama depan pengguna.

    Alice
    CreateTime

    string

    Waktu saat pengguna dibuat (UTC).

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

    string

    Jenis pengguna. Nilai yang valid:

    • Manual: Pengguna dibuat secara manual.

    • Synchronized: Pengguna disinkronkan dari penyedia identitas eksternal.

    Synchronized
    DisplayName

    string

    Nama tampilan pengguna.

    AliceLee
    UpdateTime

    string

    Waktu saat pengguna terakhir dimodifikasi (UTC).

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

    string

    Nama belakang pengguna.

    Lee
    ExternalId

    object

    Informasi pengenal pengguna dari penyedia identitas eksternal.

    Id

    string

    Pengenal pengguna di IdP eksternal.

    c73******a5fdd5

    Issuer

    string

    Saluran untuk sinkronisasi pengguna eksternal. Saat ini, hanya sinkronisasi SCIM yang didukung.

    SCIM
    Tags

    array<object>

    Daftar tag.

    object

    Key

    string

    Kunci tag.

    TestKey
    Value

    string

    Nilai tag.

    TestValue

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

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.