Invite users to a team

HTTP method POST

API call URL

https://api-cp-global.ifmcloud.com/public/organizations/Team_ID/users/invite

HTTP header

  • Content-Type: application/json

  • Authorization: Bearer Claris_ID_Token

Body

  • users: An array listing users to invite to the team.

For each user:

  • email (string, required): The Claris ID or external IdP email address of the user to invite to the team.

  • isIdpUser (Boolean): True if inviting an external IdP user. The default is False.

  • isTeamManager (Boolean): True if inviting a user as a team manager. The default is False.

  • isLicensed (Boolean): True if inviting a user as a licensed user. The default is False.

Example:

Copy 
POST /public/organizations/Team_ID/users/invite HTTP/1.1
Content-Type: application/json
Authorization: Bearer Claris_ID_Token
Copy 
{
  "users": [
    {
      "email": "user1@example.com"
    },
    {
      "email": "user2@example.com",
      "isIdpUser": true
    },
    {
      "email": "user3@example.com",
      "isTeamManager": true
    },
    {
      "email": "user4@example.com",
      "isLicensed": true
    },
    {
      "email": "user5@example.com",
      "isLicensed": true,
      "isTeamManager": true
    }
  ]
}

Parameters

None

Response body

  • code (string): The error code if there are any errors; OK if there are no errors.

  • message (string): The error message if there are any errors; null if there are no errors.

  • succeeded: An array listing requests that succeeded.

  • failed: An array listing requests that failed.

  • requestId: The API request ID used for reference.

Example:

Copy 
{
  "code": "OK",
  "message": null,
  "succeeded": [
    {
      "request": {
        "email": "user1@example.com",
        "isIdpUser": false,
        "isTeamManager": false,
        "isLicensed": true
      },
      "code": "OK",
      "message": null
    }
  ],
  "failed": [
    {
      "request": {
        "email": "user2@example.com",
        "isIdpUser": false,
        "isTeamManager": false,
        "isLicensed": true
      },
      "code": "EmailNotValid",
      "message": "user2@example.com is not a valid email."
    }
  ],
  "requestId": "{Request_ID}"
}

Notes 

  • If you invite multiple users and the invitation is successful for only some of the users, the API request is considered to be successful. It returns detailed information about the requests that succeeded and failed.

  • The maximum number of users to add to each request is 50.

  • The maximum number of pending user invitations is 50.

  • The number of licensed users in the request should not exceed the number of licensed users for the subscription.

  • You can't use this API request to change isTeamManager and isLicensed settings if you already used this API or Claris Customer Console to configure the setting for the same user. To change the setting, use Claris Customer Console.

  • You can't use this API request to remove users from your team. Use Claris Customer Console to remove users.