GetPermissions

GET

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

View as Markdown

Authorization

apiKeyoptionalHTTP
sessionCookieoptionalAPI key in cookie
oauthoptionalHTTP

Path parameters

orgIdstringrequired

Query parameters

actionsoptionalstring
resourceoptionalstring

Returns

200

Success

JSON

organizationobjectrequired
7 properties
- idstringrequired
- namestringrequired
- slugstringrequired
- resourceNamestringrequired
- createdAtstringrequired
- updatedAtstringrequired
- isRootbooleanrequired
principalobjectrequired
2 properties
- typeuserorbotrequired
- idstringrequired
apiKeyIdstringornullrequired
2 variants
One of the following:
string
null
userIdentityobjectrequired
7 properties
- typeRootorUserorBotorEzghServiceorUnknownrequired
- 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 | ForbiddenOrigin

JSON

One of the following:

AccessDeniedEncoded
View AccessDeniedEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeaccess_deniedrequired
  messagestringrequired
ForbiddenOriginEncoded
View ForbiddenOriginEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeforbidden_originrequired
  messagestringrequired

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

{ "organization": { "id": "string", "name": "string", "slug": "string", "resourceName": "string", "createdAt": "string", "updatedAt": "string", "isRoot": true }, "principal": { "type": "user", "id": "string" }, "apiKeyId": "string", "userIdentity": { "type": "Root", "principalId": "string", "userName": "string", "isRoot": true, "accessKeyId": "string", "sessionContext": { "credential": "session", "sessionIssuedAt": "string", "ssoProviderId": "string", "mfaAuthenticated": true, "clientId": "string" }, "invokedBy": "string" }, "resource": "string", "allowed": [ "string" ], "allowedSomewhere": [ "string" ] }