All Products
Search

This Product

    CloudSSO:ListGroups

    Document Center

    CloudSSO:ListGroups

    Last Updated:Jun 10, 2026

    Mengkueri kelompok.

    Deskripsi operasi

    This topic provides an example on how to query the groups in the directory d-00fc2p61****. The returned result shows that the directory contains three groups. The groups group1 and group2 are synchronized from an external identity provider (IdP). The group TestGroup is manually created in CloudSSO.

    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:ListGroups

    list

    *Group

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    DirectoryId

    string

    Yes

    ID direktori.

    d-00fc2p61****
    NextToken

    string

    No

    Token paginasi yang digunakan di permintaan berikutnya untuk mengambil halaman hasil baru. Anda tidak perlu menentukan parameter ini untuk permintaan pertama. Anda harus menentukan token yang diperoleh dari kueri sebelumnya sebagai nilai NextToken.

    Saat Anda memanggil operasi ini untuk pertama kali, jika jumlah total entri yang akan dikembalikan lebih besar dari nilai parameter MaxResults, entri akan dipotong. Sistem mengembalikan entri berdasarkan nilai parameter MaxResults, dan tidak mengembalikan entri yang berlebih. Dalam kasus ini, nilai parameter respons IsTruncated adalah true, dan parameter NextToken dikembalikan. Pada panggilan berikutnya, Anda dapat menggunakan nilai parameter NextToken dan mempertahankan pengaturan parameter permintaan lainnya untuk mengkueri entri yang berlebih. Anda dapat mengulangi panggilan hingga nilai IsTruncated menjadi false. Dengan cara ini, semua entri dikembalikan.

    K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
    MaxResults

    integer

    No

    Jumlah entri per halaman.

    Nilai valid: 1 hingga 100.

    Nilai default: 10.

    10
    Filter

    string

    No

    Kondisi filter.

    Anda harus menentukan nilai dalam format <Attribute> <Operator> <Value>. Nilai tidak peka huruf besar/kecil. Anda hanya dapat mengatur <Attribute> ke GroupName dan <Operator> hanya ke eq atau sw. Nilai eq menunjukkan Equals, dan nilai sw menunjukkan Start With.

    Misalnya, jika Anda mengatur Filter ke GroupName sw test, operasi mengkueri kelompok yang namanya dimulai dengan test. Jika Anda mengatur Filter ke GroupName eq testgroup, operasi mengkueri kelompok yang namanya adalah testgroup.

    GroupName eq testgroup
    ProvisionType

    string

    No

    Tipe kelompok. Tipe dapat digunakan untuk memfilter kelompok. Nilai valid:

    • Manual: Kelompok dibuat secara manual.

    • Synchronized: Kelompok disinkronkan dari IdP eksternal.

    Manual

    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 the value of the IsTruncated parameter is true.

    K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
    RequestId

    string

    The request ID.

    768F908D-A66A-5A5D-816C-20C93CBBFEE3
    Groups

    array<object>

    The groups.

    object

    The group.

    GroupName

    string

    The name of the group.

    TestGroup
    Description

    string

    The description of the group.

    This is a group.
    CreateTime

    string

    The time when the group was created.

    2021-11-01T02:38:27Z
    ProvisionType

    string

    The type of the group. Valid values:

    • Manual: The group is manually created.

    • Synchronized: The group is synchronized from an external IdP.

    Manual
    UpdateTime

    string

    The time when the information about the group was modified.

    2021-11-01T02:38:27Z
    GroupId

    string

    The ID of the group.

    g-00jqzghi2n3o5hkh****
    MaxResults

    integer

    The number of entries per page.

    10
    TotalCounts

    integer

    The total number of entries returned.

    3
    IsTruncated

    boolean

    Indicates whether the queried entries are truncated. Valid values:

    • true

    • false

    false

    Contoh

    Respons sukses

    JSONformat

    {
  "NextToken": "K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****",
  "RequestId": "768F908D-A66A-5A5D-816C-20C93CBBFEE3",
  "Groups": [
    {
      "GroupName": "TestGroup",
      "Description": "This is a group.",
      "CreateTime": "2021-11-01T02:38:27Z",
      "ProvisionType": "Manual",
      "UpdateTime": "2021-11-01T02:38:27Z",
      "GroupId": "g-00jqzghi2n3o5hkh****"
    }
  ],
  "MaxResults": 10,
  "TotalCounts": 3,
  "IsTruncated": false
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.