Resource URL Summary
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
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} 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 |
API Specific Parameters
Parameter | Description |
---|---|
| Identifies the REST Object Definitions User Related Objects User Object. |
Include Page | ||||
---|---|---|---|---|
|
API Specifics
Panel | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Retrieve the details of a specific UserThis 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 BodyThis request does not require a request body. HTTP Response BodyOn 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.
|
Panel | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
Insert or Update the details of a specific UserThis 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 BodyThe HTTP request body must contain a valid REST Object Definitions User Related Objects User Object. HTTP ResponseOn success the API will return a response code of 200. |
Panel | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
Delete a specific UserURL
HTTP Request BodyThis request does not require a request body. HTTP ResponseOn 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 . |
Panel | ||
---|---|---|
| ||
Reset a User's PasswordThis REST API will automatically generate a new password and email it to the user. URL
HTTP Request BodyThis request does not require a request body. HTTP ResponseOn success an HTTP response code of 200 will be returned. |
Panel | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
Change a User's PasswordThis REST API will change a user's password to the supplied value. URL
HTTP Request BodyThe HTTP Request Body must contain the following JSON, where the supplied value is the password that is to be set.
HTTP ResponseOn success an HTTP response code of 200 will be returned. |
Panel | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
Assign Service Teams to a UserThis REST API will assign supplied Service Teams to a user. URL
HTTP Request BodyThe HTTP Request Body must contain a collection of valid Service Teams.
HTTP ResponseOn success an HTTP response code of 200 will be returned. |
Panel | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Retrieve the details of a specific User's EntityThis 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 BodyThis request does not require a request body. HTTP Response BodyOn 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.
|