ListGroupMembers - - Alibaba Cloud Dokümantasyon Merkezi

Bir gruptaki kullanıcıları sorgular.

Operation description

Bu konu, g-00jqzghi2n3o5hkh**** grubundaki kullanıcıların nasıl sorgulanacağına dair bir örnek sunar. Döndürülen sonuç, grubun Alice kullanıcısını ve user1 kullanıcısını içerdiğini gösterir.

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

list

*Group

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

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	Grup kimliği.	g-00jqzghi2n3o5hkh****
DirectoryId	string	Yes	Dizin kimliği.	d-00fc2p61****
NextToken	string	No	Sonuçların yeni bir sayfasını almak için bir sonraki istekte kullanılan sayfalama belirteci. İlk istek için bu parametreyi belirtmenize gerek yoktur. NextToken değeri olarak önceki sorgudan elde edilen belirteci belirtmeniz gerekir.\n\nBu işlemi ilk kez çağırdığınızda, döndürülecek toplam giriş sayısı MaxResults parametresinin değerinden büyükse girişler kırpılır. Sistem, girişleri MaxResults parametresinin değerine göre döndürür ve fazla girişleri döndürmez. Bu durumda, IsTruncated yanıt parametresinin değeri true olur ve NextToken parametresi döndürülür. Bir sonraki çağırmada, fazla girişleri sorgulamak için NextToken parametresinin değerini kullanabilir ve diğer istek parametrelerinin ayarlarını koruyabilirsiniz. IsTruncated değeri false olana kadar çağırmayı tekrarlayabilirsiniz. Bu şekilde tüm girişler döndürülür.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
MaxResults	integer	No	Sayfa başına giriş sayısı.\n\nGeçerli değerler: 1 ile 100 arası.\n\nVarsayılan değer: 10.	10

Response elements

Element	Type	Description	Example
	object	Yanıt parametreleri.
NextToken	string	Bir sayfalama belirteci. Sonuçların yeni bir sayfasını almak için bir sonraki istekte kullanılabilir.\n\n> Bu parametre yalnızca IsTruncated parametresinin değeri true olduğunda döndürülür.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestId	string	İstek kimliği.	BB759F84-2C64-5C36-B6C6-253172C5C370
TotalCounts	integer	Döndürülen toplam giriş sayısı.	2
MaxResults	integer	Sayfa başına giriş sayısı.	10
IsTruncated	boolean	Sorgulanan girişlerin kırpılıp kırpılmadığını gösterir. Geçerli değerler:\n\n* true\n* false.	false
GroupMembers	array<object>	Gruptaki kullanıcılar.
	object	Gruptaki kullanıcı.
Status	string	Kullanıcının durumu. Geçerli değerler:\n\n* Enabled: Kullanıcının oturum açması etkinleştirilmiştir.\n* Disabled: Kullanıcının oturum açması devre dışı bırakılmıştır.	Enabled
UserName	string	Kullanıcı adı.	Alice
Email	string	Kullanıcının e-posta adresi.	AliceLee@example.com
Description	string	Kullanıcı açıklaması.	This is a user.
UserId	string	Kullanıcı kimliği.	u-00q8wbq42wiltcrk****
ProvisionType	string	Kullanıcının türü. Geçerli değerler:\n\n* Manual: Kullanıcı manuel olarak oluşturulmuştur.\n* Synchronized: Kullanıcı harici bir kimlik sağlayıcıdan (IdP) eşitlenmiştir.	Manual
DisplayName	string	Kullanıcının görünen adı.	Alice
JoinTime	string	Kullanıcının gruba eklendiği zaman.	2021-11-01T06:58:18Z
GroupId	string	Grup kimliği.	g-00jqzghi2n3o5hkh****

Examples

Success response

JSON format

{
  "NextToken": "K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****",
  "RequestId": "BB759F84-2C64-5C36-B6C6-253172C5C370",
  "TotalCounts": 2,
  "MaxResults": 10,
  "IsTruncated": false,
  "GroupMembers": [
    {
      "Status": "Enabled",
      "UserName": "Alice",
      "Email": "AliceLee@example.com",
      "Description": "This is a user.",
      "UserId": "u-00q8wbq42wiltcrk****",
      "ProvisionType": "Manual",
      "DisplayName": "Alice",
      "JoinTime": "2021-11-01T06:58:18Z",
      "GroupId": "g-00jqzghi2n3o5hkh****"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.