CreateOrganization

POST

https://orgs.ezghcloud.com/v1/organizations

View as Markdown

Authorization

apiKeyoptionalHTTP
sessionCookieoptionalAPI key in cookie
oauthoptionalHTTP

Header parameters

idempotency-keyoptionalstring

Request bodyJSONrequired

namestringrequired

Returns

201

Success

JSON

idstringrequired
namestringrequired
slugstringrequired
resourceNamestringrequired
createdAtstringrequired
updatedAtstringrequired
isRootbooleanrequired

400

InvalidRequest

JSON

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

401

Unauthenticated

JSON

errorobjectrequired
2 properties
- codeunauthenticatedrequired
- messagestringrequired

403

Forbidden | AccessDenied | ForbiddenOrigin

JSON

One of the following:

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

409

OrganizationExists | IdempotencyConflict | IdempotencyInProgress

JSON

One of the following:

OrganizationExistsEncoded
View OrganizationExistsEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeorganization_existsrequired
  messagestringrequired
IdempotencyConflictEncoded
View IdempotencyConflictEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeidempotency_conflictrequired
  messagestringrequired
IdempotencyInProgressEncoded
View IdempotencyInProgressEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeidempotency_in_progressrequired
  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 \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "string" } '