Organization Management

Invite Organization Member

Changed on

Create or resend an invitation. Email delivery failures return 502; the invitation remains pending and can be resent after correcting SMTP settings.

post/auth/organization/invite-member

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/auth/organization/invite-member
  • Auth
    HTTP bearer

Request body

emailstring required

The email address of the user to invite

organizationIdstring

The organization ID to invite the user to

resendboolean

Resend the invitation email, if the user is already invited. Eg: true

projectAccess'all' | 'selected'

"all" (the default) gives access to every project. "selected" limits the new member to projectIds once they accept.

projectIdsstring[]

Projects the new member can access when projectAccess is "selected". They must belong to the workspace, and an inviter whose own access is limited can only choose projects they can access.

Response

Success

idstring required
emailstring required
rolestring required
organizationIdstring required
inviterIdstring required
statusstring required
expiresAtstring required
createdAtstring required
projectAccess'all' | 'selected' required

"all" gives access to every project once accepted; "selected" limits the member to projectIds.

projectIdsstring[] required

Projects the invitation grants when projectAccess is "selected". Only projects the viewer can access are listed.

Changes

  • c7b8a842601bRevision changes
    • breaking

      removed the media type text/plain for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

  • 2ed51b8af657Revision changes
    • breaking

      removed the media type application/json for the response with the status

    • info

      added the non-success response with the status