Invite to an organization
Emails an invitation to join the organization. Answered by the auth plugin, whose refusals are { code, message } rather than { error }.
Who may call it: An owner, security admin or admin of the organization. API keys: no.
sessiongamma.session_token<token>The session cookie a sign-in sets. Over HTTPS its name carries the __Secure- prefix. Browsers send it on their own; other clients keep it from the sign-in response.
slug*stringThe organization's slug, as in its URL.
application/json- body
email*string^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$emailrole*stringAn admin gives up to admin, a security admin up to securityAdmin, an owner any.
"owner""securityAdmin""admin""projectCreator""member"resend?booleanOK.
application/json- response
An invitation to join an organization, or one project of it.
id*stringorganizationId*stringemail*stringrole*|The role it gives on accepting.
status*stringpending, accepted, rejected or canceled. One past expiresAt stays pending.
expiresAt*stringdate-timecreatedAt*stringdate-timeinviterId*stringThe user who sent it.
projectId?|The project it invites to, as a guest; null or absent for the organization itself.
curl -X POST 'http://localhost:3000/api/organizations/string/invitations' \ -H 'Content-Type: application/json' \ -d '{ "email": "user@example.com", "role": "owner"}'{ "id": "string", "organizationId": "string", "email": "string", "role": "string", "status": "string", "expiresAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "inviterId": "string", "projectId": "string"}