Documentation

Get the members of an organization

GET
/api/v1/external/organizations/{organizationId}/members

Scope requis : read:organizations.

AutorisationBearer <jeton>

JWT d'organisation obtenu via le flow OIDC. Voir le guide d'intégration.

Dans: header

Paramètres de chemin

organizationId*string

Paramètres de requête

rolesFilter?array<>
search?string
withRoles?boolean
groupsFilter?array<string>
excludeUserIds?array<string>
page*number
Plage1 <= value
Défaut1
pageSize*number
Plage1 <= value
Défaut10
sortBy?string
sortDirection*string
Défaut"DESC"

Valeur parmi

  • "ASC"
  • "DESC"
disablePagination*boolean
Défautfalse

Corps de réponse

application/json

curl -X GET "https://example.com/api/v1/external/organizations/string/members?page=1&pageSize=10&sortDirection=ASC&disablePagination=false"
{  "data": [    {      "id": "string",      "givenName": "string",      "familyName": "string",      "avatarUrl": "string",      "email": "string",      "role": "superadmin",      "groups": [        {          "id": "string",          "name": "string"        }      ],      "lastActiveAt": "string"    }  ],  "meta": {    "currentPage": 0,    "totalItemsCount": 0,    "totalPagesCount": 0,    "itemsPerPage": 0  }}