Operation
post /data/plat/usermgt/createuser
Create User (createPerson : /data/plat/usermgt/createuser)
Mandatory Parameters:
name :Name of User to create
almapOsprofiles :Administrator,Constructor,Viewer,Operator or custom Profile
userPassword :Password ( Nokia rules)
almapPwdReset: TRUE/FALSE ( TRUE first time ask to change)almapPwdLocked: TRUE/FALSE (TRUE Lock the user)
name :Name of User to create
almapOsprofiles :Administrator,Constructor,Viewer,Operator or custom Profile
userPassword :Password ( Nokia rules)
almapPwdReset: TRUE/FALSE ( TRUE first time ask to change)almapPwdLocked: TRUE/FALSE (TRUE Lock the user)
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | form | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Example Request Data
https://{{serverIp:port}}/oms1350/data/plat/usermgt/createuser Request Body: { "name": "prova3", "almapOsprofiles": "Administrator", "userPassword": "Nokia1.!", "almapPwdReset": "TRUE", "almapPwdLocked": "FALSE" }
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
Example Response Data
{ "ok": true, "id": "3781538607828699", "responseMessage": null, "responseList": null, "HTTPResponse": 0, "httpresponse": 0 }
External Docs
See Also :
Operation
delete /data/plat/usermgt/deleteuser/{id}
Delete User (deletePerson : /data/plat/usermgt/deleteuser/{id})
id is obtained from GET users
Can retrieve the 'id' from /data/plat/usermgt/users
Can retrieve the 'id' from /data/plat/usermgt/users
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | Can retrieve the 'id' from /data/plat/usermgt/users | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Example Request Data
https://{{serverIp:port}}/oms1350/data/plat/usermgt/deleteuser/7
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
Example Response Data
{ "ok": true, "id": "3781710284569822", "responseMessage": null, "responseList": null, "HTTPResponse": 0, "httpresponse": 0 }
Operation
get /data/plat/usermgt/users
List of All Users (getallusers : /data/plat/usermgt/users)
getallusers
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[DefinedUser]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
GET: https://{{serverIp:port}}/oms1350/data/plat/usermgt/users
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
Example Response Data
{ "userPassword": "e0NSWVBUfSQ2JFI2T2RuYjZPMkxUSFoyR3AkbmdSbUNMb2trdFgvN1BScXhPaGF6T01xcUNDdTVOVDdYaDBsaGZtWkx4a3RNRlEyOXQxY2g0V0xCN24yTjUvTmU3YmhpQjZSLlNhbjViSTVWNWYwSTA=", "almapPwdLocked": "FALSE", "almapPwdReset": "FALSE", "telephoneNumber": null, "loginShell": "", "gidNumber": "100", "uidNumber": "100", "uid": "myview", "homeDirectory": "", "almapOsprofiles": "Viewer", "almapPwdHistory": "1576240249000", "sn": "myview", "cn": "myview", "distinguishedName": "", "name": null, "displayName": null, "listId": 1, "radiusRole": null, "base": null, "sAMAccountName": null, "userPrincipalName": null, "primaryGroupID": null, "userAccountControl": null, "id": 1, "extLDAPHostname": null, "extLDAPPort": null, "extLDAPSuffixDC": null, "memberOf": null, "adsymbolicName": null, "userAuthType": null }
External Docs
See Also :
Operation
post /data/plat/usermgt/updateuser
Update User (updatePerson : /data/plat/usermgt/updateuser)
Parameters:
Syntax {'name':'','attrlist':[{: almapOsprofiles :Administrator,Constructor,Viewer,Operator or custom Profile
userPassword :Password ( Nokia rules)
almapPwdReset: TRUE/FALSE ( TRUE first time ask to change)almapPwdLocked: TRUE/FALSE (TRUE Lock the user)
Syntax {'name':'
userPassword :Password ( Nokia rules)
almapPwdReset: TRUE/FALSE ( TRUE first time ask to change)almapPwdLocked: TRUE/FALSE (TRUE Lock the user)
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | form | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Example Request Data
POST:https://{{serverIp}}:8443/oms1350/data/plat/usermgt/updateuser
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
Example Response Data
Response { "ok": true, "id": "3205398395161980", "responseMessage": "update User Passed", "responseList": null, "HTTPResponse": 200, "httpresponse": 200 }
External Docs
See Also :
DefinedUser
Name |
Type |
Description |
Enum |
---|---|---|---|
ObjectId | Integer integer |
--- | --- |
EventType | String string |
--- | --- |
ClassType | String string |
--- | --- |
IdClass | Integer integer |
--- | --- |
userPassword | array[String] string |
--- | --- |
almapPwdLocked | String string |
Password Locked | --- |
almapPwdReset | String string |
Password Reset | --- |
telephoneNumber | String string |
User Telephone Number | --- |
loginShell | String string |
--- | --- |
gidNumber | String string |
--- | --- |
uidNumber | String string |
--- | --- |
uid | String string |
--- | --- |
homeDirectory | String string |
--- | --- |
almapOsprofiles | String string |
User Profile (Administrator,Constructor...) | --- |
almapPwdHistory | String string |
Password History | --- |
sn | String string |
--- | --- |
cn | String string |
User Name | --- |
distinguishedName | String string |
--- | --- |
name | String string |
--- | --- |
displayName | String string |
--- | --- |
listId | Integer integer |
--- | --- |
radiusRole | String string |
--- | --- |
base | String string |
--- | --- |
sAMAccountName | String string |
--- | --- |
userPrincipalName | String string |
--- | --- |
primaryGroupID | String string |
--- | --- |
userAccountControl | String string |
--- | --- |
id | Integer integer |
--- | --- |
extLDAPSuffixDC | String string |
--- | --- |
extLDAPPort | String string |
--- | --- |
userAuthType | String string |
--- | --- |
extLDAPHostname | String string |
--- | --- |
memberOf | array[String] string |
--- | --- |