Add users to a group

HTTP method

PUT

API call URL

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

HTTP header
  • Content-Type: application/json
  • Authorization: Bearer Claris_ID_Token
Body
  • groupName (string, required): The name of the group.
  • users: An array listing the users to add to the group.

For each user:

  • email (string, required): The email address of the users to add to the group.
  • isIdpUser (Boolean): True if adding an external IdP user to the group. The default is False.

Example:

Copy 
PUT /public/organizations/Team_ID/groups/users HTTP/1.1
Content-Type: application/json
Authorization: Bearer Claris_ID_Token
Copy 
{
  "groupName": "Example Group",
 
  "users": [
    {
      "email": "user1@example.com"
    },
    {
      "email":"user2@example.com",
      "isIdpUser": true
    },
    {
      "email":"user3@example.com"
    }
  ]
}
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,
      },
      "code": "OK",
      "message": null
    }
  ],
  "failed": [
    {
      "request": {
        "email": "user2@example.com",
        "isIdpUser": false,
      },
      "code": "EmailNotValid",
      "message": "user2@example.com is not a valid email."
    }
  ],
  "requestId": "{Request_ID}"
}

Notes 

  • If you add multiple users to a group and the request 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 100.
  • You cannot use this API request to invite users to an external group.