Obtener grupos

Liste todos los grupos de su inquilino.

GET https://{tenantDomain}/api/v2/groups

Obtener todos los Groups

cURL

curl --request GET \
  --url https://{tenantDomain}/api/v2/groups \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "connection_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "external_id": "<string>",
    "id": "<string>",
    "name": "<string>",
    "tenant_name": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Parámetros de consulta

connection_id · string

Filtre los grupos por ID de conexión.

name · string

Filtre los grupos por nombre.

Required string length: 1 - 128

external_id · string

Filtre los grupos por ID externa.

Maximum string length: 256

search · string

Busque grupos por nombre o ID externa.

Required string length: 1 - 256

fields · string

Una lista de campos separados por comas para incluir o excluir (según include_fields) del resultado; déjela vacía para recuperar todos los campos

Maximum string length: 256

include_fields · boolean

Indica si los campos especificados deben incluirse (true) o excluirse (false).

page · integer

Índice de página de los resultados que se devolverán. La primera página es 0.

Rango requerido: x >= 0

per_page · integer

Número de resultados por página. El valor predeterminado es 50.

Rango requerido: 1 <= x <= 100

include_totals · boolean

Devuelva los resultados dentro de un objeto que contenga el recuento total de resultados (true) o como un array de resultados directamente (false, valor predeterminado).

from · string

id opcional a partir del cual iniciar la selección.

take · integer

Número de resultados por página. El valor predeterminado es 50.

Rango requerido: 1 <= x <= 100

Respuesta

200

application/json

Grupos recuperados correctamente.

object[]

object

Representa los metadatos de un grupo. Las listas de miembros se recuperan mediante un endpoint independiente.

connection_id · string<connection-id>

Identificador de la conexión a la que pertenece este grupo (si es un grupo de conexión).

created_at · string<date-time>

Marca de tiempo de creación del grupo.

external_id · string

Identificador externo del grupo, que suele usarse para la sincronización SCIM. Longitud máxima de 256 caracteres.

Maximum string length: 256

id · string

Identificador único del grupo (generado por el servicio).

Required string length: 18 - 26

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

name · string

Nombre del grupo. Debe ser único dentro de su conexión. Debe contener entre 1 y 128 caracteres ASCII imprimibles.

Required string length: 1 - 128

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

tenant_name · string

Identificador del inquilino al que pertenece este grupo.

Minimum string length: 3

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

updated_at · string<date-time>

Marca de tiempo de la última actualización del grupo.