Working with People in ActiveCollab

[ 1 Overview ] [ 2 Operation details ] [ 3 Sample configuration ]

Overview

The following operations allow you to work with people. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with people, see Sample configuration.

Operation	Description

Operation	Description
getUser	Retrieves details of an existing user.
createUser	Creates a new user.
listUsers	Retrieves details of all user.
getAllUsers	Retrieves details of users including archived and trashed.
deleteUser	Deletes an existing user.
reactivateUser	Reactivates an user.

Operation details

This section provides further details on the operations related to people.

Retrieving an user details

The getUser operation retrieves details of an particular user.

getUser

<activecollab.getUser>
    <userId>{$ctx:userId}</userId>
</activecollab.getUser>

Properties

userId: Required- The ID of the user to get details.

Sample request

Following is a sample REST/JSON request that can be handled by the getUser operation.

Sample Request for getUser

{
	"email":"emailId@gmail.com",
	"password":"1234",
	"apiVersion":"v1",
    "clientVendor":"XYZ",
    "clientName":"ABC",
    "blocking":"false",
    "userId":"10"
}

Creating a new user

The createUser operation creates new user in ActiveCollab.

createUser

<activecollab.createUser>
    <type>{$ctx:type}</type>
    <userEmail>{$ctx:userEmail}</userEmail>
    <userPassword>{$ctx:userPassword}</userPassword>
    <companyId>{$ctx:companyId}</companyId>
    <customPermissions>{$ctx:customPermissions}</customPermissions>
</activecollab.createUser>

Properties

type: Required- The user type (E.g. Member).
userEmail: Required- The email address of the user.
userPassword: The password for the user.
companyId: The ID of the company.
customPermissions: The list of the permissions for the user (E.g. can_manage_projects).

Sample request

Following is a sample REST/JSON request that can be handled by the createUser operation.

Sample Request for createUser

{
	"email":"emailId@gmail.com",
	"password":"1234",
	"apiVersion":"v1",
    "clientVendor":"XYZ",
    "clientName":"ABC",
    "blocking":"false",
    "type":"Member",
    "userEmail":"userEmail@gmail.com",
    "userPassword":"1234",
    "companyId":"2",
    "customPermissions":[
        "can_manage_projects"
    ]
}

Retrieving all users details

The listUsers operation retrieves details of all users in ActiveCollab.

listUsers

<activecollab.listUsers/>

Sample request

Following is a sample REST/JSON request that can be handled by the listUsers operation.

Sample Request for listUsers

{
	"email":"emailId@gmail.com",
	"password":"1234",
	"apiVersion":"v1",
    "clientVendor":"XYZ",
    "clientName":"ABC",
    "blocking":"false"
}

Retrieving all users details including archived and trashed

The getAllUsers operation retrieves details including archived and trashed of all users in ActiveCollab.

getAllUsers

<activecollab.getAllUsers/>

Sample request

Following is a sample REST/JSON request that can be handled by the getAllUsers operation.

Sample Request for getAllUsers

{
	"email":"emailId@gmail.com",
	"password":"1234",
	"apiVersion":"v1",
    "clientVendor":"XYZ",
    "clientName":"ABC",
    "blocking":"false"
}

Deleting an user

The deleteUser operation deletes an existing user.

deleteUser

<activecollab.deleteUser>
    <userId>{$ctx:userId}</userId>
</activecollab.deleteUser>

Properties

userId: Required- The ID of the user to delete.

Sample request

Following is a sample REST/JSON request that can be handled by the deleteUser operation.

Sample Request for deleteUser

{
	"email":"emailId@gmail.com",
	"password":"1234",
	"apiVersion":"v1",
    "clientVendor":"XYZ",
    "clientName":"ABC",
    "blocking":"false",
    "userId":"10"
}