ListGroups - - Alibaba Cloud Dokümantasyon Merkezi

Grupları sorgular.

Operation description

Bu konuda, d-00fc2p61**** dizinindeki grupların nasıl sorgulanacağına dair bir örnek sunulmaktadır. Döndürülen sonuç, dizinin üç grup içerdiğini göstermektedir. group1 ve group2 grupları harici bir kimlik sağlayıcısından (IdP) eşitlenmiştir. TestGroup grubu ise CloudSSO'da manuel olarak oluşturulmuştur.

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

list

*Group

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

None

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	Dizin kimliği.	d-00fc2p61****
NextToken	string	No	Sonraki istekte yeni bir sonuç sayfası almak için kullanılan sayfalama belirteci. İlk istek için bu parametreyi belirtmenize gerek yoktur. NextToken değeri olarak önceki sorgudan elde edilen belirteci belirtmeniz gerekir. Bu 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. Sonraki çağrıda, 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ğrıyı tekrarlayabilirsiniz. Bu şekilde tüm girişler döndürülür.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
MaxResults	integer	No	Sayfa başına giriş sayısı. Geçerli değerler: 1 ile 100 arası. Varsayılan değer: 10.	10
Filter	string	No	Filtre koşulu. Değeri biçiminde belirtmeniz gerekir. Değer büyük/küçük harfe duyarlı değildir. değerini yalnızca GroupName ve değerini yalnızca eq veya sw olarak ayarlayabilirsiniz. eq değeri Eşittir, sw değeri ise İle Başlar anlamına gelir. Örneğin, Filter değerini GroupName sw test olarak ayarlarsanız işlem, adları test ile başlayan grupları sorgular. Filter değerini GroupName eq testgroup olarak ayarlarsanız işlem, adı testgroup olan grubu sorgular.	GroupName eq testgroup
ProvisionType	string	No	Grubun türü. Bu tür, grupları filtrelemek için kullanılabilir. Geçerli değerler: Manual: Grup manuel olarak oluşturulmuştur. Synchronized: Grup harici bir IdP'den eşitlenmiştir.	Manual

Response elements

Element	Type	Description	Example
	object	Yanıt parametreleri.
NextToken	string	Sayfalama belirteci. Sonraki istekte yeni bir sonuç sayfası almak için kullanılabilir. Not Bu parametre yalnızca IsTruncated parametresinin değeri true olduğunda döndürülür.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestId	string	İstek kimliği.	768F908D-A66A-5A5D-816C-20C93CBBFEE3
Groups	array<object>	Gruplar.
	object	Grup.
GroupName	string	Grubun adı.	TestGroup
Description	string	Grubun açıklaması.	This is a group.
CreateTime	string	Grubun oluşturulduğu zaman.	2021-11-01T02:38:27Z
ProvisionType	string	Grubun türü. Geçerli değerler: Manual: Grup manuel olarak oluşturulmuştur. Synchronized: Grup harici bir IdP'den eşitlenmiştir.	Manual
UpdateTime	string	Grup bilgilerinin değiştirildiği zaman.	2021-11-01T02:38:27Z
GroupId	string	Grubun kimliği.	g-00jqzghi2n3o5hkh****
MaxResults	integer	Sayfa başına giriş sayısı.	10
TotalCounts	integer	Döndürülen toplam giriş sayısı.	3
IsTruncated	boolean	Sorgulanan girişlerin kırpılıp kırpılmadığını gösterir. Geçerli değerler: true false	false

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.