Save as PDF

User APIs

The Responsive application currently supports the following User APIs:

User APIs

Add User Account

API URL

/rfpserver/ext/v1/users/add

Description

Create/Onboard a new user

Type

POST

Input

{

  "firstName": "John", 

  "lastName": "Wick", 

 

  "userName": "johnwick@abc.com", 

  "userRole": "Team Member",  

  "timeZone": "America/Los_Angeles",

 

 

 "language": "en",

 

  

"jobTitle": "Developer", 

"phoneNumber": "123-456-789", 

 "location": "en_US"

 "primaryBU": "APAC", 

 

 "tags": [

    "Admin"

  ]

}

 

firstName (string, optional): First Name of the User. 

lastName (string, optional): Last name or Family name of the User. 

userName (string, Mandatory): Email address of the User. 

userRole (string, optional): Role of the User. Allowed values are RFP_ADMIN, RFP_MANAGER, TEAM_MEMBER, or PROJECT_REQUESTER.  

timeZone (string, optional): TimeZone of the User. It should be a TZ database name. Allowed values: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

If not specified, company's default time zone would be set. 

language (string, optional): Preferred Language of the user. Allowed values: [ISO 639-1 codes], reference: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

If not specified, company's default language would be set. 

jobTitle (string, optional): Job title of the user., 

phoneNumber (string, optional): Phone number of the user., 

 

location (string, optional): Location of the user.

primaryBU (string, optional): Business Unit Name to be associated. This is mandatory only if business unit is enabled for the company, 

tags (Array[string], optional): Tag names of the user. A user can be assigned with multiple tags. Tags should be unique irrespective of CASE.

Output

JSON object containing details of the user just created.

{

  "firstName": "John",

  "lastName": "Wick",

  "userName": "johnwick@abc.com",

  "userRole": "Team Member",

  "timeZone": "Asia/Kolkata",

  "language": "en",

  "jobTitle": "Developer",

  "phoneNumber": "123-456-789",

  "location": "en_US",

  "primaryBU": "APAC",

  "tags": [

    "Admin"

  ],

  "createTs": "2020-05-17 18:44:51 Z",

  "status": "ACTIVE"

}

 

Get Individual User or Team Details

API URL

/rfpserver/ext/v1/users/{userId}

Description

Get the user's details.

Type

GET

Input (path param)

userId

Email Address/UserName of the user. Example: johnwick@abc.com

Output

JSON object containing details of the user. (UserExtVO)

 

Response

UserExtVO

primaryBU

String

Business Unit. This is applicable only if BU is enabled for the instance.

firstName

String

First name of the user.

lastName

String

Last name of the user.

userName

String

Email Id of the user.

userRole

String

Role of the user.

location

String

Location of the user.

jobTitle

String

Job title of the user.

phoneNumber

String

Phone number of the user.

timeZone

String

Time zone of the user.

language

String

Language of the user.

tags

Array[string] 

List of tags names of the user.

createTs

Date-Time

Created date and time of the user.

status

String

Status of the user.

id

String

Team Id. (If teams are enabled.)

members

Array[string] 

List of user names. (If teams are enabled.)

backgroundColor

String 

Background Color of the team. (If teams are enabled.)

foregroundColor

String

Foreground Color of the team. (If teams are enabled.)

sharedBUs

Array[String]

List of shared BUs of the user.

additionalRoles

Array[String]

Additional roles of the user.

lastActiveDate

Date

Last active date of the user.

 

Example 1

Request:

https://dev1.rfpio.com/rfpserver/rfpserver/ext/v1/users/helpdesk@email.com

Response:

{

  "srcName": {},

  "primaryBU": "Asia",

  "sharedBUs": [

    "USA"

  ],

  "firstName": "John",

  "lastName": "Doe",

  "userName": "johndoe@rfpio.com",

  "userRole": "Admin with ALL Permissions",

  "timeZone": "America/Adak",

  "language": "en",

  "phoneNumber": "9090909090",

  "location": "Coimbatore",

  "tags": [],

  "additionalRoles": [

    "BILLING",

    "INTERNAL_CONTACT",

    "PROJECT_PRIMARY_CONTACT"

  ],

  "lastActiveDate": "2024-02-15",

  "createTs": "2017-01-01 21:17:08 -08:00",

  "status": "ACTIVE"

}

 

List User Details

API URL

/rfpserver/ext/v1/users?limit=25

Description

List out all user details.

Type

GET

Input (query param)

 

 

limit

Optional. Limit the number of user records in the response. If limit is given as 0, it returns just the count of users present in the company.

Last Active From Date(yyyy-MM-dd)

To filter users who were active from the specified date.

Last Active To Date(yyyy-MM-dd)

To filter users who were active till the specified date.

Output

JSON object containing the list of users (UserVOSearchList).

Example: 

{

  "userVOList": [

    {

      "id": "60360521167daadd22ebf15d",

      "srcName": {},

      "primaryBU": "Asia",

      "sharedBUs": [

        "USA"

      ],

      "firstName": "John",

      "lastName": "Doe",

      "userName": "johndoe@rfpio.com",

      "userRole": "Admin with ALL Permissions",

      "timeZone": "America/Adak",

      "language": "en",

      "phoneNumber": "9843248808",

      "location": "CA",

      "tags": [],

      "additionalRoles": [

        "BILLING",

        "INTERNAL_CONTACT",

        "PROJECT_PRIMARY_CONTACT"

      ],

      "lastActiveDate": "2024-02-15",      

      "createTs": "2017-01-01 21:17:08 -08:00",

      "status": "ACTIVE"

    }

  ],

  "totalResultsCount": 28,

  "limit": 1,

  "startIndex": 0,

  "endIndex": 0,

  "offset": 0

}

 

 

Update User Status (Activate)

API URL

/rfpserver/ext/v1/users/{userId}/activate

Description

Update the status of the given user to ‘ACTIVE’.

Type

POST

Input (Path param)

userId

Email Address/UserName of the user. Example: johnwick@abc.com

Output

No Content

 

Update User Status (Deactivate)

API URL

/rfpserver/ext/v1/users/{userId}/deactivate

Description

Update status of the given user to ‘DEACTIVATE’.

Type

POST

Input (Path param)

userId

Email Address/UserName of the user. Example: johnwick@abc.com

Output

No Content

 

Update User Account

API URL

/rfpserver/ext/v1/users/{userId}/update

Description

Update user details. It’s a complete replacement of user details.

The fields which doesn’t have values are considered null and persisted as such.

Type

POST

Input

(Path param)

userId

Email Address/UserName of the user. Example: johnwick@abc.com

Input

(request body)

{

  "firstName": "John",

  "lastName": "Wick", 

  "userName": "johnwick@abc.com", 

  "userRole": "TEAM_MEMBER", 

 

 "timeZone": "America/Los_Angeles",

 

 

"language": "en",

 

 

 

 "jobTitle": "Developer", 

 "phoneNumber": "123-456-789", 

  "location": "en_US"

}

 

firstName (string, optional): First Name of the user.

lastName (string, optional): Last Name or Family Name of the user.

userName (string,Mandatory ): Email address of the user.This cannot be updated. 

userRole (string, optional): Role of the user. Allowed values are RFP_ADMIN, RFP_MANAGER,TEAM_MEMBER, PROJECT_REQUESTER.

 

timeZone (string, optional): TimeZone of the User. It should be a TZ database name. Allowed values : https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

If not specified, company's default timezone would be set, 

language (string, optional): Preferred language of the user. Allowed values: [ISO 639-1 codes], reference : https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

If not specified, company's default language would be set, 

 

jobTitle (string, optional): Job title of the user., 

phoneNumber (string, optional): Phone number of the user., 

 

location (string, optional): Location of the user.

Output

JSON object containing details of the user just updated.

 

Delete User

API URL

/rfpserver/ext/v1/users/delete

Description

Remove a user from the organization.

Type

POST

 

Request

DeleteUserVO

userName*

String

Email Id of the User to be deleted.

reassignNewUsersVOList Array[ReassignNewUsersVO]

 

ReassignNewUsersVO

businessUnit

String

Primary/Shared Business Unit of the User to be deleted.

newContentLibraryAndSectionTemplateOwner

String

New Owner for Document,Answer Library and Section Template

newOwnerforProjectSectionsandTasks

String

New Owner for Sections and Tasks

newProjectPrimaryContact

String

New Primary/Additional Primary Contact for Projects

newContentAnalysisWorkspaceowner

String

New Owner for Content Analysis Workspace

newCustomReportOwner

String

New Owner for Custom Report

newSMEasAuthorandReviewer

String

New SME to recommend as Author and Reviewer

newProjectTemplateOwner

String

New Project Template Owner

 

Response:

If the request is successful , then the response will contain a message stating that the user was deleted successfully.

 

Example:

RequestURL:

https://dev1.rfpio.com/rfpserver/rfpserver/ext/v1/users/delete

Response:

{
"reassignNewUsersVOList": [
{
"businessUnit": "India",
"newContentAnalysisWorkspaceowner": "email@rfpio.com",
"newContentLibraryAndSectionTemplateOwner": "email@rfpio.com",
"newCustomReportOwner": "email@rfpio.com",
"newOwnerforProjectSectionsandTasks": "email@rfpio.com",
"newProjectPrimaryContact": "email@rfpio.com",
"newProjectTemplateOwner": "email@rfpio.com",
"newSMEasAuthorandReviewer": "email@rfpio.com"
},
{
"businessUnit": "california",
"newContentAnalysisWorkspaceowner": "email@rfpio.com",
"newContentLibraryAndSectionTemplateOwner": "email@rfpio.com",
"newCustomReportOwner": "email@rfpio.com",
"newOwnerforProjectSectionsandTasks": "email@rfpio.com",
"newProjectPrimaryContact": "email@rfpio.com.",
"newProjectTemplateOwner": "email@rfpio.com",
"newSMEasAuthorandReviewer": "email@rfpio.com"
},
{
"businessUnit": "America",
"newContentAnalysisWorkspaceowner": "email@rfpio.com",
"newContentLibraryAndSectionTemplateOwner": "email@rfpio.com",
"newCustomReportOwner": "email@rfpio.com",
"newOwnerforProjectSectionsandTasks": "email@rfpio.com",
"newProjectPrimaryContact": "email@rfpio.com",
"newProjectTemplateOwner": "email@rfpio.com",
"newSMEasAuthorandReviewer": "email@rfpio.com"
},
],
"userName": "user@rfpio.com"
}

 

Response:

{
"MESSAGE": "DELETED_SUCCESSFULLY"
}

 

Get current User Details

API URL

/rfpserver/ext/v1/users/me

Description

Get details of user by user name, team by team name or ID.

Type

GET

Input (Path param)

userId

Email Address/UserName of the user. Example: johnwick@abc.com

Output

UserExtVO

Example:

{

  "primaryBU": "Asia",

  "sharedBUs": [

    "USA"

  ],

  "firstName": "John",

  "lastName": "Doe",

  "userName": "johndoe@rfpio.com",

  "userRole": "Admin with ALL Permissions",

  "timeZone": "America/Adak",

  "language": "en",

  "phoneNumber": "9843248808",

  "location": "CA",

  "tags": [],

  "additionalRoles": [

    "BILLING",

    "INTERNAL_CONTACT",

    "PROJECT_PRIMARY_CONTACT"

  ],

  "lastActiveDate": "2024-02-15",

  "createTs": "2017-01-01 21:17:08 -08:00",

  "status": "ACTIVE"

}

 

UserExtVO

primaryBU

String

Business Unit. This is applicable only if BU is enabled for the instance.

firstName

String

First name of the user.

lastName

String

Last name of the user.

userName

String

Email ID of the user.

userRole

String

Role of the user.

location

String

Location of the user.

jobTitle

String

Job title of the user.

phoneNumber

String

Phone number of the user.

timeZone

String

Time zone of the user.

language

String

Language of the user.

tags

Array[string] 

List of tags names of the user.

createTs

Date-Time

Created date and time of the user.

status

String

Status of the user.

id

String

Team ID. If teams is enabled in company.

members

Array[string] 

List of user names. If teams is enabled in company.

backgroundColor

String 

Background Color of the team. If teams is enabled in company.

foregroundColor

String

Foreground Color of the team. If teams is enabled in company.

sharedBUs

Array[String]

List of shared BUs of the user

additionalRoles

Array[String]

Additional roles of the user

lastActiveDate

Date

Last active date of the user

 

 UserVOSearchList

userVOList

Array[UserVO]

List of users info. 

totalResultsCount

Integer

Total count of users.

limit

Integer

The number of records limited in the response.

 

UserVO

primaryBU

String

Business Unit. This is applicable only if BU is enabled for the instance.

firstName

String

First name of the user.

lastName

String

Last name of the user.

userName

String

Email ID of the user.

userRole

String

Role of the user.

location

String

Location of the user.

jobTitle

String

Job title of the user.

phoneNumber

String

Phone number of the user.

timeZone

String

Time zone of the user.

language

String

Language of the user.

tags

Array[string] 

List of tags names of the user.

additionalRoles

Array[string] 

List of additional roles of the user.

createTs

Date-Time

Created date and time of the user.

status

String

Status of the user.

lastActiveDate

Date

Last active date of the user

 

Update User Email

API URL

/rfpserver/ext/v1/users/{userId}/update-user-email

Description

Updates user's email ID

Type

POST

Path Param

userId * -  Existing email address of the user

Input

{

    "newEmailAddress": "johnwilliam@responsive.io"

}

UpdateUserEmailVO

 newEmailAddress (string, mandatory): New email address of the user

 

Output

If the request is successful , then the response will contain a message stating that “YOUR_CHANGE_REQUEST_SUBMITTED_SUCCESSFULLY. AN_EMAIL_WILL_BE_SENT_ONCE_PROCESS_IS_COMPLETED.”

The API endpoints either start with /rfpserver. The baseUrl for most customers is app.rfpio.com. For more details, please reach out to your CSM or contact accountmanagers@responsive.io. See Responsive API Documentation for details on other endpoints.

Was this article helpful?

/