Admin - Collaborate 5.5 API list

Basic user-related API changes

1. API - Create system basic user group
   • POST /groups
   • The <basicusergroup>0</basicusergroup> tag has been introduced in the "Create System Group" API to create system group as a system basic user group. This tag is available from version 12 onwards.
   • <group>
         <name>string</name>
         <description>string</description>
         <type>string</type>
         <basicusergroup>string</basicusergroup>
     </group>
   • To add a system basic user group, the value of "sourcetype" attribute must be "system" otherwise the system will show validation message "Invalid sourcetype input for basic user group. Valid value is System." with reference code "462". If <basicusergroup> is set to 1, then <sourcetype> must be set as "system". (Swagger)
   • Permissible value of "basicusergroup" attribute is 0 OR 1 only, if any other value is entered then system will show validation message "Invalid input for basicusergroup. Valid values are 0 or 1." with reference code "463". (Swagger)
2. API - Get list system basic user group with filtration
   • GET /groups?type=<type_value>
   • Filter users with type=basic_user. New group type value has been introduced to filter System basic user groups. The value is available from version 12 onwards.
   • The tag <basicusergroup>0</basicusergroup> has been introduced to show if system group is a system basic group. This tag is available from version 12 onwards.
   • <groups>
         <total>string</total>
         <totalcount>string</totalcount>
         <group>
             <name>string</name>
             <description>string</description>
             <id>string</id>
             <type>string</type>
             <basicusergroup>string</basicusergroup>
         </group>
     </groups>
   • From API version 12 onwards, a new "type", "basic_user" is added to filter basic user groups. Also "contract_express" type is extended to get "Contract Express basic users" group. (Swagger)
3. API - Get single system basic user group

   • GET /groups/{groupID}

   • The tag <basicusergroup>0</basicusergroup> has been introduced to show if system group is a system basic group. This tag is available from version 12 onwards.
   • <group>
         <name>string</name>
         <description>string</description>
         <type>string</type>
         <basicusergroup>string</basicusergroup>
     </group>
   • From API version 12 onwards, a new attribute "basicusergroup" will be shown in the response which will be used to identify if the group is a basic user group. (Swagger)
4. API - Add users to system group
   • POST /groups/{groupid}/users
   • A non-basic user cannot be added to a system basic user group. When doing so, the API will give a validation message : "Non-basic user is not allowed in a basic user group (From API version 12 onwards)" Reference Code : 465. Validation message will be given to all the API versions (from version 1) (Swagger)
   • A basic user cannot be added to a non-basic user group. When doing so, the API will give the validation message : "Basic user is not allowed in a non-basic user group (From API version 12 onwards)" Reference Code : 464. Validation message will be given to all the API versions (from version 1) (Swagger)
   • This API can also be used to add a user to the basic user group. (Swagger)
5. API - Get system groups by user id

   • GET /users​/{user_id}​/groups

   • The tag <basicusergroup>0</basicusergroup> has been introduced to show if the system group is a system basic group. This tag is available from version 12 onwards.
   • <group>
         <name>string</name>
         <description>string</description>
         <type>string</type>
         <basicusergroup>string</basicusergroup>
     </group>
6. API - Get system user

   • GET /users/{userId_Email}

   • The tag <role>Basic User</role> will now give one more role "Basic user". This value will be available to all the API versions.
   • <user>
         <firstname>string</firstname>
         <lastname>string</lastname>
         <systemuser>string</systemuser>
         <email>string</email>
         <role>string</role>
     </user>
   • If the user is a basic user, the value of "role" attribute will be "basic user". (Swagger)
7. API - Get site group
   • GET /sites/{siteID}/groups/{groupID}
   • The tag <basicusergroup>0</basicusergroup> has been introduced to show if the system group is a system basic group. This tag is available from version 12 onwards.
   • <group>
         <name>string</name>
         <type>string</type>
         <basicusergroup>string</basicusergroup>
     </group>
   • From API version 12 onwards, a new attribute "basicusergroup" is added in the response to identify a basic user group. (Swagger)
8. API - Get all site groups
   • GET /sites/{siteID}/groups/
   • The tag <basicusergroup>0</basicusergroup> has been introduced to show if the system group is a system basic group. This tag is available from version 12 onwards.
   • <sitegroups>
         <group>
             <name>Site admin</name>
             <type>Admin group</type>
             <numberofusers>0</numberofusers>
             <basicusergroup>string</basicusergroup>
         </group>
     </sitegroups>
   • In the response all site groups are returned e.g. org,site,system,admin, allsystem, synced.
     From API version 12 onwards, basic user groups can also be fetched using this API. (Swagger)
9. API - Add new basic user site group in a site
   • POST /sites/{siteID}/groups
   • The tag <basicusergroup>0</basicusergroup> has been introduced to show if the system group is a system basic group. This tag is available from version 12 onwards.
   • <group>
         <name>string</name>
         <type>string</type>
         <basicusergroup>0</basicusergroup>
     </group>
   • From API version 12 onwards, this API supports creating a basic user group in the site. In order to create a basic user group, set the value of "basicusergroup" attribute to 1. (Swagger)
   • When copying the permission from another group, users must provide the group id of same type. e.g. Site group permissions cannot be copied to "Site Basic user" group, so in this case we show this message : "Invalid input for copying permissions from. Please provide the id of a basic user group." (Swagger)
   • Invalid input for copying permissions from. Please provide the id of a non-basic user group. (Swagger)
10. API - Get site groups by user
    • GET /sites/{siteid}/users/{userid}/groups
    • The tag <basicusergroup>0</basicusergroup> has been introduced to show if the system group is a system basic group. This tag is available from version 12 onwards.
    • <groups>
          <group>
              <name>string</name>
              <type>string</type>
              <description>string</description>
              <basicusergroup>0</basicusergroup>
          </group>
      </groups>
    • From API version 12 onwards, a new attribute "basicusergroup" is added in the response to identify if the group is a basic user group or not. (Swagger)
11. API - Update system user roles
    • PUT /users/{userid}/roles

    • From version 12 onwards, a new user role called "Basic user" is supported in this API. Below is the request body to update the basic user role for internal users.

       

      <roles>
          <role>
             <alias>BASIC_USER</alias>
             <name>Basic User</name>
          </role>
          <role>
             <alias>INTERNAL_USER</alias>
             <name>Internal User</name>
          </role>
      </roles> (Swagger)

    • When setting the basic user role, another role cannot be set with it (except for internal user). When doing so, a message will be returned stating "Other than internal user,  this role cannot be applied to the basic user role." (Swagger)
12. API - Add existing basic user system group to the site
    • POST /sites/{siteID}/groups/{groupID}
    • Now this API is also used to add "System Basic User" group to site. Swagger document for it is "This API is extended to add existing system basic user groups (of system / org type) in the site." (Swagger)
13. API - Update site/basic user group
    • PUT /sites/{siteID}/groups/{groupID}
    • Now this API is also used to update "System Basic User" group in site. Swagger document for it is "This API is extended to update the name of an existing basic user group in a site. (Swagger)
14. API - Add user to site group
    • PUT /sites/{siteID}/groups/{groupID}/users
    • From version 12 onwards, this API method associates a basic user to a basic user group and non basic users to a non basic user group. (Swagger)
    • User with role "Basic role" cannot be added to a non-basic group, if this is done the following message will be given : "Basic user(s) cannot be added to a non-basic user group." (Swagger)
    • Non basic user cannot be added to a basic group, if this is done the following message will be given : "Non-basic user(s) cannot be added to a basic user group." (Swagger)
15. API - Add user to site with basic user role
    • POST /sites/{siteID}/users
    • The tag <isBasicUser>0</isBasicUser> has been introduced to add user with role "Basic user".  Value 1 means setting user role to "Basic user". This tag is available from version 12 onwards. (Swagger)
    • If adding existing user to site and isBasicUser set to 1 then the following message will be given : "You cannot mark this user as a basic user as it already exists in the system" (Swagger)
    • If adding external user to site and isBasicUser set to 1 then the following message will be given : "You cannot mark this user as a basic user as it is an external user" (Swagger)
    • If adding basic user to site and isBasicUser set to 0 then the following message will be given : "You cannot mark this user as a normal user as it is already a basic user" (Swagger)
    • Invalid value of isBasicUser. Valid value is 0 or 1 (Swagger)
16. API - Add/Edit group module permission
    • POST /sites/{siteid}/groups/{groupid}/modulepermissions
    • From API version 12 onwards, permissions of a basic user group can be added / updated with respect to system level basic user permissions. (Swagger)
    • When given permission in API do not match with permission set at ASP then the following message will be given : "Basic user groups do not have this permission" (Swagger)
17. API - Add/Edit user module permission
    • POST /sites/{siteid}/users/{userid}/modulepermissions
    • From API version 12 onwards, permissions of a basic user can be added / updated with respect to system level basic user permissions. (Swagger)
    • When given permission in API do not match with permission set at ASP then the following message will be given : "Basic users do not have this permission" (Swagger)