POST /administrator-ms/administrator/v1
Upgrade user into administrator.
-
Perform the authentication and login to the API. For more information, see POST /auth/login.
Use POST /administrator-ms/administrator/v1 to send an HTTP POST request to the authentication service.
Click Try it Out option.
-
Under Request body select application/json from drop-down list.
-
Enter the request body parameter values as follows:Note: The highlighted parameters are mandatory and it must be configured in the request body.
{ "userId": "string", "securityProfile": 0, "accessToDepartment": [ 0 ], "accessToSubsystemsInLocation": [ 0 ] }The following table describes the request body parameters. <TBD: New>Parameter Name
Sample Value
Description
>userId
String
Enter the user ID.
Maximum Length: 30
Minimum Length: 0
Pattern: ^[^,'"\\&<>?*]*$Note: This parameter is mandatory.>securityProfile
Integer (int32)
Enter a Security Profile for the administrator. The security profile defines the administrator's access privileges.
Options: A list of available security profiles with the same or a subset of the logged on Administrator's access privileges.Note: This parameter is mandatory.>accessToDepartment
Integer (int32)
Enter the departments the administrator will have access to
Options: Existing Department(s); Location(s) Available departments, added in the Department task.Note: This field is displayed after a user has been selected in the list of search results for User Name. If 0 is entered the administrator will have access to all Departments.Note: This parameter is mandatory.>accessToSubsystemsInLocation Integer (int32)
Select which locations the administrator shall have access to. The administrator will have access to the subsystems, and their services, associated with the chosen locations.
Options: List of available locations defined in the Location task.
Note: This field is displayed after a user has been selected in the list of search results for User Name. If 0 is entered the administrator will have access to all locations.Note: This parameter is mandatory. Click on Execute to generate the request URL.
Request URL:
The following table lists the expected responses.https://<IP_Address>:<PORT>/administrator-ms/administrator/v1?search=%2A&pageno=0&pageSize=200&orderby=userId%20ascResponse Type
Value
Schema
Valid Response
201 Created
Not applicable
Error Response
400 Bad Request
Not applicable
401 Authentication Failure
Not applicable
403 Forbidden
Not applicable
404 Not found
Not applicable