Skip to main content

Invite user​

Invite users to an organization, if user is not registered on the platform, it will be notified. Invitations expire in 7 days

Path Parameters
    org_id string required

    unique id of the organization to which user is invited

Request Body required
    user_ids string[] required

    user_id is email id of user who are invited inside the organization. If user is not registered on the platform, it will be notified

    group_ids string[]

    list of group ids to which user needs to be added as a member.

    role_ids string[]

    list of role ids to which user needs to be added as a member. Roles are binded at organization level by default.

Responses

A successful response.

Schema
    invitations object[]
  • Array [
    • id string

    The unique invitation identifier.

    user_id string

    The user email of the invited user.

    org_id string

    The organization id to which the user is invited.

    group_ids string[]

    The list of group ids to which the user is invited.

    metadata object

    The metadata of the invitation.

    created_at date-time

    The time when the invitation was created.

    expires_at date-time

    The time when the invitation expires.

    role_ids string[]

    The list of role ids to which the user is invited in an organization.

  • ]
Loading...