Get all Groups - Auth0 Docs

承認

Authorization

string

header

必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

クエリパラメータ

connection_id

string

Filter groups by connection ID.

name

string

Filter groups by name.

Required string length: 1 - 128

Pattern: ^[\x20-\x7E]+$

external_id

string

Filter groups by external ID.

Maximum string length: 256

fields

string

A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields

Maximum string length: 256

Pattern:

^((id)|(name)|(external_id)|(organization_id)|(connection_id)|(tenant_name)|(description)|(created_at)|(updated_at))(,((id)|(name)|(external_id)|(organization_id)|(connection_id)|(tenant_name)|(description)|(created_at)|(updated_at)))*$

include_fields

boolean

Whether specified fields are to be included (true) or excluded (false).

page

integer

Page index of the results to return. First page is 0.

必須範囲: x >= 0

per_page

integer

Number of results per page. Defaults to 50.

必須範囲: 1 <= x <= 100

include_totals

boolean

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

from

string

Optional Id from which to start selection.

take

integer

Number of results per page. Defaults to 50.

必須範囲: 1 <= x <= 100

レスポンス

Groups successfully retrieved.

object[]
object

Represents the metadata of a group. Member lists are retrieved via a separate endpoint.

string

Unique identifier for the group (service-generated).

Required string length: 25 - 26

Pattern: ^grp_[1-9a-km-zA-HJ-NP-Z]{21,22}$

name

string

Name of the group. Must be unique within its connection. Must contain between 1 and 128 printable ASCII characters.

Required string length: 1 - 128

Pattern: ^[\x20-\x7E]+$

external_id

string

External identifier for the group, often used for SCIM synchronization. Max length of 256 characters.

Maximum string length: 256

connection_id

string<connection-id>

Identifier for the connection this group belongs to (if a connection group).

tenant_name

string

Identifier for the tenant this group belongs to.

Minimum string length: 3

Pattern: ^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$

created_at

string<date-time>

Timestamp of when the group was created.

updated_at

string<date-time>

Timestamp of when the group was last updated.