Skip to content

GetPermissions

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

Authorization

  • apiKeyoptionalHTTP
  • oauthoptionalHTTP
  • sessionCookieoptionalAPI key in cookie

Path parameters

  • orgIdstringrequired

    The organization's UUID or prefixed ID (org_…).

Query parameters

  • actionsoptionalstring
  • resourceoptionalstring
  • requestUrloptionalstring

Returns

200

Success

JSON
  • organizationobjectrequired
    8 properties
    • idstringrequired
    • namestringrequired
    • slugstringrequired
    • resourceNamestringrequired
    • createdAtstringrequired
    • updatedAtstringrequired
    • isRootbooleanrequired
    • requireMfaoptionalboolean
  • principalobjectrequired
    3 properties
    • typeuserorbotorssoUserrequired
    • idstringrequired
    • slugstringornullrequired
      2 variants

      One of the following:

      • string
      • null
  • apiKeyIdstringornullrequired
    2 variants

    One of the following:

    • string
    • null
  • userIdentityobjectrequired
    7 properties
    • typeRootorUserorBotorSsoUserorEzghServiceorUnknownrequired
    • principalIdstringornullrequired
      2 variants

      One of the following:

      • string
      • null
    • userNamestringornullrequired
      2 variants

      One of the following:

      • string
      • null
    • isRootbooleanrequired
    • accessKeyIdstringornullrequired
      2 variants

      One of the following:

      • string
      • null
    • sessionContextobjectornullrequired
      2 variants

      One of the following:

      • object
      • null
    • invokedBystringornullrequired
      2 variants

      One of the following:

      • string
      • null
  • resourcestringrequired
  • allowedarray ofstringrequired
  • allowedSomewherearray ofstringrequired

400

InvalidRequest

JSON
  • errorobjectrequired
    3 properties
    • codeinvalid_requestrequired
    • messagestringrequired
    • issuesoptionalarray ofobject
      2 properties
      • pathstringrequired
      • messagestringrequired

401

Unauthenticated

JSON
  • errorobjectrequired
    2 properties
    • codeunauthenticatedrequired
    • messagestringrequired

403

AccessDenied | BoundaryViolation | 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