Skip to content

GetBot

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

Authorization

  • apiKeyoptionalHTTP
  • oauthoptionalHTTP
  • sessionCookieoptionalAPI key in cookie

Path parameters

  • orgIdstringrequired

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

  • botIdstringrequired

    The bot's UUID or prefixed ID (bot_…).

Returns

200

Success

JSON
  • idstringrequired
  • organizationIdstringrequired
  • namestringrequired
  • slugstringrequired
  • resourceNamestringrequired
  • groupIdsarray ofstringrequired
  • policyIdsarray ofstringrequired
  • trustarray ofobjectrequired
    4 properties
    • principalTypessoUserorssoGrouprequired
    • principalIdstringrequired
    • resourceNamestringrequired
    • createdAtstringrequired
  • permissionsBoundarystringornullrequired
    2 variants

    One of the following:

    • string
    • null
  • childBoundarystringornullrequired
    2 variants

    One of the following:

    • string
    • null
  • createdAtstringrequired
  • updatedAtstringrequired

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