CreateOidcApiKey

POST

https://orgs.ezghcloud.com/v1/organizations/{orgId}/bots/{botId}/oidc-api-keys

View as Markdown

Path parameters

orgIdstringrequired
botIdstringrequired

Request bodyJSONrequired

tokenstringrequired
maxLength: 16384, minLength: 1
nameoptionalstring
expiresInSecondsoptionalinteger
maximum: 43200, minimum: 900

Returns

201

Success

JSON

apiKeyobjectrequired
10 properties
- idstringrequired
- organizationIdstringrequired
- namestringrequired
- prefixstringrequired
- ownerobjectrequired
  2 properties
  typeuserorbotrequired
  idstringrequired
- createdBystringrequired
- createdAtstringrequired
- lastUsedAtstringornullrequired
  2 variants
  One of the following:
  string
  null
- expiresAtstringornullrequired
  2 variants
  One of the following:
  string
  null
- sourceIdentityobjectornullrequired
  2 variants
  One of the following:
  object
  null
tokenstringrequired

400

InvalidRequest

JSON

errorobjectrequired
3 properties
- codeinvalid_requestrequired
- messagestringrequired
- issuesoptionalarray ofobject
  2 properties
  pathstringrequired
  messagestringrequired

401

Unauthenticated

JSON

errorobjectrequired
2 properties
- codeunauthenticatedrequired
- messagestringrequired

409

LimitExceeded

JSON

errorobjectrequired
2 properties
- codelimit_exceededrequired
- 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

curl --request POST \ --url https://orgs.ezghcloud.com/v1/organizations/string/bots/string/oidc-api-keys \ --header 'Content-Type: application/json' \ --data ' { "token": "string", "name": "string", "expiresInSeconds": 900 } '

{ "apiKey": { "id": "string", "organizationId": "string", "name": "string", "prefix": "string", "owner": { "type": "user", "id": "string" }, "createdBy": "string", "createdAt": "string", "lastUsedAt": "string", "expiresAt": "string", "sourceIdentity": { "type": "SsoUser", "principalId": "string", "userName": "string" } }, "token": "string" }