Obtener un grupo del directorio
GET /v1/directories/{directory_id}/groups/{directory_group_id} · permiso directories:read
Devuelve un grupo que el proveedor de identidad aprovisionó en el directorio: ID, ID externo, nombre para mostrar y número de miembros; nunca un miembro. Para listar los miembros de un grupo, use GET /v1/directories/{directory_id}/users?group_id=….
Solicitud
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
directory_id |
path | sí | ID del directorio SCIM (dir_…). |
directory_group_id |
path | sí | ID del grupo del directorio (dsg_…). |
No hay cuerpo de solicitud.
Respuesta
200 OK con el grupo.
{
"id": "dsg_01j9xn3p5q7r9s1t3v5w7x9y1a",
"external_id": "00g1a2b3c4",
"name": "Engineering",
"member_count": 12
}
Errores
| HTTP | code | Cuándo |
|---|---|---|
| 404 | not_found |
El directorio o el grupo no existe en este entorno, o el grupo pertenece a otro directorio. |
| 401 | unauthenticated |
La credencial falta, no es válida o fue revocada. |
| 403 | insufficient_permissions |
La credencial no tiene el permiso requerido. |
| 429 | rate_limited |
Se superó el límite de frecuencia; reintente después del período Retry-After. |
| 503 | service_unavailable |
La sincronización de directorios no está disponible temporalmente o no está configurada en este despliegue; reintente después del período Retry-After. |
Ejemplo
curl -i "https://api.eu.keenauth.com/v1/directories/dir_01j9xm2n4p6q8r0s2t4v6w8y0z/groups/dsg_01j9xn3p5q7r9s1t3v5w7x9y1a" \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY"