CreateInvitation

POST

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

View as Markdown

Authorization

apiKeyoptionalHTTP
sessionCookieoptionalAPI key in cookie
oauthoptionalHTTP

Path parameters

orgIdstringrequired

Header parameters

idempotency-keyoptionalstring

Request bodyJSONrequired

emailstringrequired
groupIdsoptionalarray ofstring
policyIdsoptionalarray ofstring
expiresInDaysoptionalinteger
maximum: 30, minimum: 1

Returns

201

Success

JSON

idstringrequired
organizationIdstringrequired
emailstringrequired
groupIdsarray ofstringrequired
policyIdsarray ofstringrequired
statuspendingoracceptedordeclinedorrevokedorexpiredrequired
urlstringrequired
invitedBystringrequired
createdAtstringrequired
expiresAtstringrequired
respondedAtstringornullrequired
2 variants
One of the following:
string
null

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

409

InvitationConflict | ManagedByScim | IdempotencyConflict | IdempotencyInProgress

JSON

One of the following:

InvitationConflictEncoded
View InvitationConflictEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeinvitation_existsoralready_memberorinvitation_expiredorinvitation_not_pendingrequired
  messagestringrequired
ManagedByScimEncoded
View ManagedByScimEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codemanaged_by_scimrequired
  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/string/invitations \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "email": "string", "groupIds": [ "string" ], "policyIds": [ "string" ], "expiresInDays": 1 } '

{ "id": "string", "organizationId": "string", "email": "string", "groupIds": [ "string" ], "policyIds": [ "string" ], "status": "pending", "url": "string", "invitedBy": "string", "createdAt": "string", "expiresAt": "string", "respondedAt": "string" }