Retrieve the details of a specific User

GET /seiapi/v3/trans/User/${UserID}

Insert or Update the details of a specific User

PUT /seiapi/v3/trans/User/${UserID}?emailNotification=true

Delete a specific User

DELETE /seiapi/v3/trans/User/${UserID}

Reset a User's Password

PUT /seiapi/v3/trans/User/${UserID}/ResetPassword  

Change a User's Password

PUT /seiapi/v3/trans/User/${UserID}/ChangePassword  

Assign Service Teams to a User

PUT /seiapi/v3/trans/User/${UserID}/ServiceTeams

Retrieve the details of a specific User's Entity

GET  /seiapi/v3/trans/User/${UserID}/Entity

Impersonate a specific User

POST /seiapi/v3/trans/User/${UserID}/impersonate

Retrieve the details of a specific User

This REST API will return a User with the specified ID. The User with the specified ID must already exist in the system.

URL

HTTP Request Body

This request does not require a request body. 

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will contain a REST Object Definitions User Related Objects User Object . Otherwise, on error, the response body will contain a descriptive reason for the error. 

 {
	"Activated": true,
	"AuthenticationID": "",
	"Deleted": false,
	"DGroupID": "",
	"Email": "",
    "EnableMobileDiagnostics": false,
	"Extensions": {
		"key1": "value1",
		"key2": "value2"
	},
	"FaceTime": "",
	"FirstName": "",
	"IsMobileWorker": true,
	"LanguageCode": "",
	"LastName": "",
	"Locked": false,
	"Password": "",
	"Phones": [{
		"PhoneNum": "",
		"PhoneType": ""
	}],
	"ResetPassword": false,
	"ServiceTeamID": "",
	"SMS": "",
	"Status": "",
	"StorageLocationID": "",
	"UserID": ""
}

Insert or Update the details of a specific User

This REST API will insert a new User with the specified ID into the system, if a User with the specified ID does not already exist in the system.

If, however, the User with the specified ID does already exist in the system, then this REST API will update (i.e. replace) the already existing User with the specified ID with the details of the User supplied in the HTTP Request Body.

URL

HTTP Request Body

The HTTP request body must contain a valid REST Object Definitions User Related Objects User Object.

HTTP Response

On success the API will return a response code of 200.

Delete a specific User

URL

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success an HTTP response code of 200 will be returned. The system will return HTTP response code 410 in case of non-existent REST Object Definitions User Related Objects User Object .

Reset a User's Password

This REST API will automatically generate a new password and email it to the user. 

URL

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success an HTTP response code of 200 will be returned.

Change a User's Password

This REST API will change a user's password to the supplied value.

URL

HTTP Request Body

The HTTP request body must contain the following JSON, where the supplied value is the password that is to be set.

{
	"Password" : ""
}

HTTP Response

On success an HTTP response code of 200 will be returned.

Assign Service Teams to a User

This REST API will assign supplied Service Teams to a user.

URL

HTTP Request Body

The HTTP request body must contain a collection of valid Service Teams.

{
	"ServiceTeams": [
		// Service Teams ID
	]
}

HTTP Response

On success an HTTP response code of 200 will be returned.

Retrieve the details of a specific User's Entity

This REST API will return the details of User's Entity from the system. The User with the specified ID must already exist in the system.

URL

HTTP Request Body

This request does not require a request body. 

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will contain a User Entity Object. Otherwise, on error, the response body will contain a descriptive reason for the error. 

{
    "Addresses": [{
        "AddrLine1": "",
        "AddrLine2": "",
        "AddrLine3": "",
        "AddrLine4": "",
        "AddrType": "",
        "City": "",
        "Country": "",
        "Intersection": "",
        "Lat": "",
        "Lon": "",
        "Region": "",
        "Zip": ""
    }],
    "Contacts": [{
        "Email": "",
        "FirstName": "",
        "IsPrimary": true,
        "LastName": "",
        "Phones": [{
            "PhoneNum": "",
            "PhoneType": ""
        }]
    }],
    "Name": "",
    "SystemID": ""
}

Impersonate a specific User

This REST API will allow the ServicePower Hub admin user or a Super Admin to impersonate another User for testing/debugging purposes. The User with the specified ID must already exist in the system.

URL

HTTP Request Body

The HTTP request body must contain a JSON object containing the details of the ServicePower Hub admin user or Super User that will be impersonating the specified user:

{
	"UserID": "<admin or super admin user id>",
	"Password": "<admin or super admin user password>"
}

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will be a JSON object containing a JWT which can then be used to authenticate API calls via the x-access-token header to impersonate the specified user:

{
	"Token": ""
}

Otherwise, on error, the response body will contain a descriptive reason for the error.