User resource

OVERVIEW


This resource endpoint provides functions user operations

Please note that User and Group API methods were implemented for our AD integration and are very limited. We plan to provide detailed API methods for User and Groups in a future release of Collaborate. 

User profile is represented in the API calls using the below User profile object.

 

Field

API Naming

Explanation

Mandatroy

Comment

First Name

firstname

 Forename of a person

Yes

Are we sure we can guarantee this field is always populated in AD?

Last Name

lastname

Last name of a person

Yes

Are we sure we can guarantee this field is always populated in AD?

Title

title

Title of a person

No

Title of the user, it contains fewer letters ex.Mr,Mrs

Email address

email

Unique Email address of a person

Yes

This is not always available in AD. Barclays is an example of this. Not sure it can be mandatory.

Phone

phone

List of contact numbers. Name value pair for office, mobile etc

No

 

Jobtitle

jobtitle

Jobtitle of a person

No

 

Department

dept

Department the person belongs to

No

 

Organisation

org

Organisation ID the user belongs too

No

Rishit organisation id indicates that all applications have an instance of organisation object, and now about it, that might not be the case, so probably need to transfer an instance of organisation object, like groups

External User ID

extuserId

 

Yes

ExternalId is unique Id in external system,we are going to use this for update or delete operation.

SourceType

 

Source type from where user is created for example Active Directory

Yes

 

 


Site users management

   Site users management - Add existing user to site

   Site users management - Add user to site

   Site users management - Models

   Site users management - Get all site users

   Site users management - Get email alert settings

   Site users management - Set email alert settings

   Site users management - Remove users from a site

   Site users management - Send reset password email to users

   Site users management - Send invitation email to users

   Site users management - Send an email to users

   Site users management - Suspend users

   Site users management - Activate users

   Site users management - Add / edit user module permission

   Site users management - Get user module permission

Add user

   Add user - Add user v1

Get user

   Get user - Get user v1

   Get user - Get user v2

Update user

   Update user - Update user v1

Get user list

   Get user list - Get all users v1

Delete/ Archive User

   Delete/ Archive User - Delete user v1

User Object

Get user avatar

User - social list

Comments


1 Comments

Last Updated: Sep 22,2023