Invite users to join the organization.
POST
/org/invitesCreate an invitation
Sends an email invitation to a user to join the organization. If the user does not yet have an account, they will be guided through signup.
Request Body
application/json
JSON "organizationId": "A1B2C3D4E5", "name": "string", "email": "alice@example.com", "organizationRoleId": "A1B2C3D4E5", "accountType": "managed", "teamAssignments": [ { "teamId": "A1B2C3D4E5", "roleId": "A1B2C3D4E5" } ], "sendEmail": true
{
}
Responses
Responses
The invite was created successfully.
application/json
JSON "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "email": "alice@example.com", "organizationRoleId": "A1B2C3D4E5", "accountType": "managed", "invitationToken": "string", "invitedAt": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "expiresAt": "string", "organization": { "id": "A1B2C3D4E5", "slug": "acme-corp", "name": "string", "settings": { "auth": { "requireEmailVerification": true, "allowLoginWithPassword": true, "allowLoginWithEmail": true, "requireDpop": true, "checkBreachedPasswords": true, "acr": "string" }, "sessions": { "maxRunningWorkloads": 0, "maxConcurrentClients": 0, "maxConcurrentSessionsPerMember": 0, "endpointFallback": { "defaults": { "idleTimeoutSeconds": 0, "idleCloseDelaySeconds": 0, "maxDurationSeconds": 0 }, "maximums": { "idleTimeoutSeconds": 0, "idleCloseDelaySeconds": 0, "maxDurationSeconds": 0 } }, "endpointDefaults": { "spark_connect": { "defaults": { "idleTimeoutSeconds": 0, "idleCloseDelaySeconds": 0, "maxDurationSeconds": 0 }, "maximums": { "idleTimeoutSeconds": 0, "idleCloseDelaySeconds": 0, "maxDurationSeconds": 0 } } } } }, "defaultTeamId": "A1B2C3D4E5", "defaultOrgRoleId": "A1B2C3D4E5" }, "inviteUrl": "string"
{
}
GET
/org/invites/{token}Describe an invitation
Returns the details of a pending invitation, including the invited email address, expiration time, and current status.
Responses
Responses
The invite details.
application/json
JSON "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "email": "alice@example.com", "organizationRoleId": "A1B2C3D4E5", "accountType": "managed", "invitationToken": "string", "invitedAt": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "expiresAt": "string", "organization": { "id": "A1B2C3D4E5", "slug": "acme-corp", "name": "string", "settings": { "auth": { "requireEmailVerification": true, "allowLoginWithPassword": true, "allowLoginWithEmail": true, "requireDpop": true, "checkBreachedPasswords": true, "acr": "string" }, "sessions": { "maxRunningWorkloads": 0, "maxConcurrentClients": 0, "maxConcurrentSessionsPerMember": 0, "endpointFallback": { "defaults": { "idleTimeoutSeconds": 0, "idleCloseDelaySeconds": 0, "maxDurationSeconds": 0 }, "maximums": { "idleTimeoutSeconds": 0, "idleCloseDelaySeconds": 0, "maxDurationSeconds": 0 } }, "endpointDefaults": { "spark_connect": { "defaults": { "idleTimeoutSeconds": 0, "idleCloseDelaySeconds": 0, "maxDurationSeconds": 0 }, "maximums": { "idleTimeoutSeconds": 0, "idleCloseDelaySeconds": 0, "maxDurationSeconds": 0 } } } } }, "defaultTeamId": "A1B2C3D4E5", "defaultOrgRoleId": "A1B2C3D4E5" }, "inviteUrl": "string"
{
}
POST
/org/invites/{token}/acceptAccept an invitation
Accepts a pending invitation, adding the authenticated user as a member of the organization.
Request Body
application/json
JSON "user": { "email": "string", "givenName": "string", "familyName": "string", "password": "string" }
{
}
Responses
Responses
The invite was accepted successfully.
application/json
JSON "organization": { "id": "A1B2C3D4E5", "slug": "acme-corp", "name": "string", "settings": { "auth": { "requireEmailVerification": true, "allowLoginWithPassword": true, "allowLoginWithEmail": true, "requireDpop": true, "checkBreachedPasswords": true, "acr": "string" }, "sessions": { "maxRunningWorkloads": 0, "maxConcurrentClients": 0, "maxConcurrentSessionsPerMember": 0, "endpointFallback": { "defaults": { "idleTimeoutSeconds": 0, "idleCloseDelaySeconds": 0, "maxDurationSeconds": 0 }, "maximums": { "idleTimeoutSeconds": 0, "idleCloseDelaySeconds": 0, "maxDurationSeconds": 0 } }, "endpointDefaults": { "spark_connect": { "defaults": { "idleTimeoutSeconds": 0, "idleCloseDelaySeconds": 0, "maxDurationSeconds": 0 }, "maximums": { "idleTimeoutSeconds": 0, "idleCloseDelaySeconds": 0, "maxDurationSeconds": 0 } } } } }, "defaultTeamId": "A1B2C3D4E5", "defaultOrgRoleId": "A1B2C3D4E5" }, "user": { "id": "A1B2C3D4E5", "email": "alice@example.com", "givenName": "string", "familyName": "string", "displayName": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" }, "otaCode": "string", "nextStep": "string"
{
}