Versions Compared

Version Old Version 2 New Version 3
Changes made by

Annu

Annu

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Background

This REST API is meant to create users in UpRaise company directory. Below are the API request and response responses for creating users.

API Details

App name

Endpoint

UpRaise for Employee Success

https://employee-success.upraise.io/rest/upraise/public/1.0/directory/createUser

UpRaise People

https://people.upraise.io/rest/upraise/public/1.0/directory/createUser

UpRaise Employee Garrison

https://garrison.upraise.io/rest/upraise/public/1.0/directory/createUser

On this page

Table of Contents
minLevel2
maxLevel6
outlinefalse
typelist
printablefalse
Iframe
scrollingauto
srchttps://form.typeform.com/to/loItQqk5#url=xxx
width350
frameborderhide
alignmiddle
height250

Request payload JSON

Code Block
{
    "email":"akshaykumar@splasher.com",
    "role": {
                "id":3
            },
    "designation":  {
                        "id":1
                    },
    "manager":  {
                    "accountId": "61d406c3326554006cf69278"
                },
    "teams":[{
                "id":1
             },
             {
                "id":2
             }],
    "leavePolicy": {
                "id":1
            },
    "holidayScheme": {
                "id":1
            },
    "workWeekScheme": {
                "id":1
            },
    "enrollmentDate":"2024-05-08"
}

Request parameters

Parent

Parameter

Type

Description

Possible values

email

String

Email of the user to create UpRaise user. This email should have an active Jira account.

Any email address that has a Jira account

role

String

UpRaise user role

  • User

  • Admin

  • Super admin

  • User with Company OKR permission

  • Other custom UpRaise roles

role

id

Number

ID of the user role

1, 2, 3, 4, etc.

designation

String

Designation of the user Sales manager, Support Manager

  • id

designation

id

Number

ID of the designation

1, 2, 3, 4, etc.

manager

String

This field is to define users manager

  • accountId

manager

accountId

String

AccountId of the user who is alinged as manager of user being created now

6363, 77474, etc.

teams

String

Teams of the user being created

  • id

teams

id

Number

UpRaise ID of the team

90, 67, etc.

leavePolicy

String

Leave policy of the user being created

  • id

leavePolicy

id

Number

UpRaise ID of the leave policy

89, 56, etc.

holidayScheme

String

Holiday scheme of the user being created

  • id

holidayScheme

id

Number

UpRaise ID of the holiday scheme

89, 90, etc.

workweekScheme

String

Workweek scheme of the user being created

  • id

workweekScheme

id

Number

UpRaise ID of the workweek scheme

90, 67, etc.

Response sample JSON

Code Block
{
    "id": 20,
    "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=712020:201ae3a3-748c-47c6-b093-aef40297be41",
    "name": "fawino3915",
    "accountId": "712020:201ae3a3-748c-47c6-b093-aef40297be41",
    "active": true,
    "timeZone": "Asia/Beirut",
    "manager": {
        "id": 1,
        "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=61d406c3326554006cf69278"
    },
    "designation": {
        "id": 1,
        "name": "Software Engineer"
    },
    "role": {
        "id": 2,
        "name": "USER"
    },
    "teams": [
        {
            "id": 2,
            "name": "t1"
        },
        {
            "id": 1,
            "name": "Market research"
        }
    ]
}

Response parameters

Parent

Parameter

Type

Description

Possible values

id

Number

User ID created by the system after user creation is executed in UpRaise

89, 343, etc.

jiraUserRestApiUrl

String

Jira User Rest API URL fetched from Jira for the user based on the provided account ID

<baseURL>/rest/api/2/user?accountId=712020:201ae3a3-748c-47c6-b093-aef40297be41

name

String

User name based on Jira records of the user

  • John Doe

  • Peter Walter

accounId

String

active

String

This parameter is for the user’s status

  • true

  • false

timeZone

String

Time zone of the user

  • Asia/Beirut

  • New Caledonia

manager

String

This parameter contains details of user’s manager

  • id

  • jiraUserRestApiUrl

manager

id

Number

This is the user ID of the user who is manager

89, 78, etc.

manager

jiraUserRestApiUrl

String

This is the Jira user Rest API URL

<baseURL>/rest/api/2/user?accountId=61d406c3326554006cf69278

designation

String

Designation of the user

  • id

  • name

designation

id

Number

ID of the designation

1, 2, 3, 4, etc.

designation

name

String

Designation of the user

Sales manager, Product manager

role

String

Role of the newly created user

  • id

  • name

role

id

Number

Id of the UpRaise user role

89, 90, etc.

role

name

String

Name of the UpRaise role

  • User

  • Admin

  • Super admin

  • No access

  • Any custom UpRaise role

teams

String

Teams of the user being created

  • id

teams

id

Number

UpRaise ID of the team

90, 67, etc.

teams

name

String

Team/s name of the newly created user

Products, Software development