Tüm Ürünler
Search

Bu Ürün

    :ListUsers

    Belge Merkezi

    :ListUsers

    Son Güncelleme:Sep 30, 2026

    Kullanıcı listesini sorgular.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    cloudsso:ListUsers

    list

    *User

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DirectoryId

    string

    Yes

    Dizin kimliği.

    d-00fc2p61****
    Status

    string

    No

    Kullanıcı durumu. Bu parametre filtre koşulu olarak kullanılır. Geçerli değerler:

    • Enabled: Kullanıcı etkin.

    • Disabled: Kullanıcı devre dışı.

    Enabled
    ProvisionType

    string

    No

    Kullanıcı türü. Bu parametre filtre koşulu olarak kullanılır. Geçerli değerler:

    • Manual: Kullanıcı manuel olarak oluşturulmuştur.

    • Synchronized: Kullanıcı harici bir kimlik sağlayıcıdan eşitlenmiştir.

    Manual
    Filter

    string

    No

    Filtre koşulu.

    Biçim: . Bu değer büyük/küçük harfe duyarlı değildir. Şu anda yalnızca UserName değerini, ise yalnızca eq (Equals) ve sw (Start With) değerlerini destekler.

    Örnek: Filter = "UserName sw test" ifadesi, kullanıcı adları test ile başlayan tüm kullanıcıları sorgular. Filter = "UserName eq testuser" ifadesi, kullanıcı adı testuser olan kullanıcıyı sorgular.

    UserName sw test
    MaxResults

    integer

    No

    Sayfa başına en fazla giriş sayısı.

    Geçerli değerler: 1 ile 100 arası.

    Varsayılan değer: 10.

    10
    NextToken

    string

    No

    Sonraki sonuç sayfası için belirteç. İlk API çağrısı için NextToken belirtmeniz gerekmez.

    API'yi ilk kez çağırdığınızda, toplam giriş sayısı MaxResults sınırını aşarsa veriler kırpılır ve yalnızca MaxResults kadar giriş döndürülür. Bu durumda, IsTruncated yanıt parametresi true değerini alır ve bir NextToken döndürülür. Kırpılan verileri sorgulamak için diğer istek parametrelerini değiştirmeden önceki çağrıdan döndürülen NextToken değerini kullanarak API'yi çağırmaya devam edebilirsiniz. Tüm verilerin alındığını gösteren IsTruncated değeri false olana kadar bu işlemi tekrarlayabilirsiniz.

    K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
    Tags

    array<object>

    No

    Etiket listesi.

    object

    No

    Key

    string

    No

    Etiket anahtarı.

    TestKey
    Value

    string

    No

    Etiket değeri.

    TestValue

    Response elements

    Element

    Type

    Description

    Example

    object

    Yanıt parametreleri.

    NextToken

    string

    Sonraki sonuç sayfası için belirteç.

    Not

    Bu parametre yalnızca IsTruncated değeri true olduğunda döndürülür.

    K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
    RequestId

    string

    İstek kimliği.

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

    integer

    Sayfa başına en fazla giriş sayısı.

    10
    TotalCounts

    integer

    İstek parametreleriyle eşleşen toplam giriş sayısı.

    2
    IsTruncated

    boolean

    Sonuçların kırpılıp kırpılmadığını gösterir. Geçerli değerler:

    • true: Sonuçlar kırpılmıştır.

    • false: Sonuçlar kırpılmamıştır.

    false
    Users

    array<object>

    Kullanıcı listesi.

    array<object>

    Kullanıcı listesi.

    Status

    string

    Kullanıcının durumu. Geçerli değerler:

    • Enabled: Kullanıcı etkin.

    • Disabled: Kullanıcı devre dışı.

    Enabled
    UserName

    string

    Kullanıcı adı.

    AliceLee@example.onmicrosoft.com
    Email

    string

    Kullanıcının e-posta adresi.

    AliceLee@example.onmicrosoft.com
    Description

    string

    Kullanıcının açıklaması.

    This is a user.
    UserId

    string

    Kullanıcı kimliği.

    u-00bikzkuzbb58luh****
    FirstName

    string

    Kullanıcının adı.

    Alice
    CreateTime

    string

    Kullanıcının oluşturulduğu zaman (UTC).

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

    string

    Kullanıcının türü. Geçerli değerler:

    • Manual: Kullanıcı manuel olarak oluşturulmuştur.

    • Synchronized: Kullanıcı harici bir kimlik sağlayıcıdan eşitlenmiştir.

    Synchronized
    DisplayName

    string

    Kullanıcının görünen adı.

    AliceLee
    UpdateTime

    string

    Kullanıcının en son değiştirildiği zaman (UTC).

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

    string

    Kullanıcının soyadı.

    Lee
    ExternalId

    object

    Kullanıcının harici kimlik sağlayıcıdaki tanımlayıcı bilgileri.

    Id

    string

    Harici kimlik sağlayıcıdaki kullanıcı tanımlayıcısı.

    c73******a5fdd5

    Issuer

    string

    Harici kimlik eşitleme kanalı. Şu anda yalnızca SCIM tabanlı kullanıcı eşitleme desteklenmektedir.

    SCIM
    Tags

    array<object>

    Etiket listesi.

    object

    Key

    string

    Etiket anahtarı.

    TestKey
    Value

    string

    Etiket değeri.

    TestValue

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.