AcceptInvitation

POST

https://orgs.ezghcloud.com/v1/invitations/{invitationId}/accept

View as Markdown

Authorization

apiKeyoptionalHTTP
sessionCookieoptionalAPI key in cookie
oauthoptionalHTTP

Path parameters

invitationIdstringrequired

Returns

200

Success

JSON

invitationobjectrequired
9 properties
- idstringrequired
- organizationobjectrequired
  3 properties
  idstringrequired
  namestringrequired
  slugstringrequired
- emailstringrequired
- invitedByEmailstringornullrequired
  2 variants
  One of the following:
  string
  null
- statuspendingoracceptedordeclinedorrevokedorexpiredrequired
- urlstringrequired
- createdAtstringrequired
- expiresAtstringrequired
- respondedAtstringornullrequired
  2 variants
  One of the following:
  string
  null
organizationobjectrequired
7 properties
- 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 | EmailNotVerified | AccessDenied | ForbiddenOrigin

JSON

One of the following:

ForbiddenEncoded
View ForbiddenEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeforbiddenrequired
  messagestringrequired
EmailNotVerifiedEncoded
View EmailNotVerifiedEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeemail_not_verifiedrequired
  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

404

NotFound

JSON

errorobjectrequired
2 properties
- codenot_foundrequired
- messagestringrequired

409

InvitationConflict | OrganizationExists | ManagedByScim

JSON

One of the following:

InvitationConflictEncoded
View InvitationConflictEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeinvitation_existsoralready_memberorinvitation_expiredorinvitation_not_pendingrequired
  messagestringrequired
OrganizationExistsEncoded
View OrganizationExistsEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeorganization_existsrequired
  messagestringrequired
ManagedByScimEncoded
View ManagedByScimEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codemanaged_by_scimrequired
  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

{ "invitation": { "id": "string", "organization": { "id": "string", "name": "string", "slug": "string" }, "email": "string", "invitedByEmail": "string", "status": "pending", "url": "string", "createdAt": "string", "expiresAt": "string", "respondedAt": "string" }, "organization": { "id": "string", "name": "string", "slug": "string", "resourceName": "string", "createdAt": "string", "updatedAt": "string", "isRoot": true } }