Accept an invitation or enroll a verified person
POST
/v1/invitations/{invitationId}/acceptAuthorization
AuthorizationBasic auth · headerrequiredRegistered confidential integration credentials. Keep the secret server-side.
or
CookieAPI key · headerrequiredConsole-managed Vault session cookie; secure cookie naming may vary by environment.
Path parameters
invitationIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Request body
requiredapplication/jsonexternalSubjectstringmin length 1 · max length 256
organizationIdstringmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
rolestringAllowed:
viewermemberadminownersubmissionKeystringrequiredmin length 8 · max length 128 · matches ^[A-Za-z0-9_.:-]+$
Responses
200
Success
dataobjectrequiredShow propertiesHide properties
effectsstring[]requiredoperationIdstringrequiredoutcomestringrequiredmembershipobjectrequiredShow propertiesHide properties
emailstringrequiredidstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
joinedAtstring<date-time>requiredmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
namestringrequiredrolestringrequiredAllowed:
viewermemberadminownermetaobjectrequiredShow propertiesHide properties
requestIdstringrequireddefault
Error
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_readyfieldsobject[]Show propertiesHide properties
Array of
objectcodestringrequiredmessagestringrequiredpathstringrequiredmessagestringrequiredoperationIdstringmetaobjectrequiredShow propertiesHide properties
requestIdstringrequired