Skip to content

ListGroups

GET
https://orgs.ezghcloud.com/v1/organizations/{orgId}/groups

Authorization

  • apiKeyoptionalHTTP
  • sessionCookieoptionalAPI key in cookie
  • oauthoptionalHTTP

Path parameters

  • orgIdstringrequired

Query parameters

  • limitoptionalstring
    pattern: ^[+-]?\d*\.?\d+(?:[Ee][+-]?\d+)?$
  • cursoroptionalstring

Returns

200

Success

JSON
  • groupsarray ofobjectrequired
    11 properties
    • idstringrequired
    • namestringrequired
    • slugstringrequired
    • resourceNamestringrequired
    • descriptionstringrequired
    • membersarray ofobjectrequired
      2 properties
      • typeuserorbotrequired
      • idstringrequired
    • policyIdsarray ofstringrequired
    • managedBystringornullrequired
      2 variants

      One of the following:

      • string
      • null
    • lockedbooleanrequired
    • createdAtstringrequired
    • updatedAtstringrequired
  • nextCursorstringornullrequired
    2 variants

    One of the following:

    • string
    • null

400

InvalidCursor | InvalidRequest

JSON

One of the following:

401

Unauthenticated

JSON
  • errorobjectrequired
    2 properties
    • codeunauthenticatedrequired
    • messagestringrequired

403

AccessDenied | ForbiddenOrigin

JSON

One of the following:

404

NotFound

JSON
  • errorobjectrequired
    2 properties
    • codenot_foundrequired
    • messagestringrequired

429

TooManyRequests

JSON
  • errorobjectrequired
    2 properties
    • codetoo_many_requestsrequired
    • messagestringrequired

500

InternalError

JSON
  • errorobjectrequired
    2 properties
    • codeinternal_errorrequired
    • messagestringrequired

503

Unavailable

JSON
  • errorobjectrequired
    2 properties
    • codeunavailablerequired
    • messagestringrequired
Navigation

Type to search…

↑↓ navigate↵ selectEsc close