Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Identity Hub API, gRPC: GroupService.ListExternal

Written by
Updated at August 8, 2025

Retrieves the list of external group linked subject container

gRPC request

rpc ListExternal (ListExternalGroupsRequest) returns (ListExternalGroupsResponse)

ListExternalGroupsRequest

{
  "subject_container_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "filter": "string"
}

Field

Description

subject_container_id

string

Required field. Id of the subject container that external group belongs to.
To get subject container, use a yandex.cloud.organizationmanager.v1.saml.FederationService.List request
or yandex.cloud.organizationmanager.v1.idp.UserpoolService.List request.

page_size

int64

The maximum number of results per page to return. If the number of available
results is larger than page_size,
the service returns a ListExternalGroupsResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

page_token

string

Page token. Set page_token
to the ListExternalGroupsResponse.next_page_token
returned by a previous list external request to get the next page of results.

filter

string

A filter expression that filters resources listed in the response.
The expression must specify:

  1. The fields name or id. Currently you can use filtering only on the Group.name or Group.id fields.
  2. An = operator.
  3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].

ListExternalGroupsResponse

{
  "groups": [
    {
      "id": "string",
      "organization_id": "string",
      "created_at": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "subject_container_id": "string",
      "external_id": "string"
    }
  ],
  "next_page_token": "string"
}

Field

Description

groups[]

Group

List of External group resources.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListExternalGroupsRequest.page_size, use
the next_page_token as the value
for the ListExternalGroupsRequest.page_token query parameter
in the next list request. Each subsequent list request will have its own
next_page_token to continue paging through the results.

Group

A Group resource.
For more information, see Groups.

Field

Description

id

string

ID of the group.

organization_id

string

ID of the organization that the group belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp.

name

string

Name of the group.

description

string

Description of the group.

subject_container_id

string

Id of the subject container that external group belongs to. It is set if group is external.

external_id

string

Id of the group from external system. It is set if group is external.
Previous
List
Next
Create