_Docs/
Get StartedModulesPlatformDeployCookbookChangelogReference
_Platform
  • Architecture
    • Single sign-on (SSO) for organizationsEE
    • Access ControlEE
    • Invite users
    • Audit LogsEE
    • Event Streaming
    • Webhooks
  • SDKs
  • Releases policy
  1. Manage
  3. Identity & Access
  5. Invite users
Platform

Invite users

Invite a user#

Send an invitation to join your organization:

curl -X POST $FORMANCE_API_URL/api/membership/organizations/<ORG_ID>/invitations \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com"
  }'
POST/api/membership/organizations/<ORG_ID>/invitations

Manage invitations#

List pending invitations:

curl -X GET $FORMANCE_API_URL/api/membership/organizations/<ORG_ID>/invitations
GET/api/membership/organizations/<ORG_ID>/invitations

Cancel a pending invitation:

curl -X DELETE $FORMANCE_API_URL/api/membership/organizations/<ORG_ID>/invitations/<INVITATION_ID>
DELETE/api/membership/organizations/<ORG_ID>/invitations/<INVITATION_ID>

Accept or decline#

Invited users receive an email with a link. They can also accept or decline programmatically:

curl -X POST $FORMANCE_API_URL/api/membership/me/invitations/<INVITATION_ID>/accept
POST/api/membership/me/invitations/<INVITATION_ID>/accept
curl -X POST $FORMANCE_API_URL/api/membership/me/invitations/<INVITATION_ID>/reject
POST/api/membership/me/invitations/<INVITATION_ID>/reject

After accepting, the user's permissions are determined by the policies assigned to them at the organization and stack level.

From the console#

You can also manage invitations from the Formance Console under your organization settings.

Access ControlAudit Logs