Last updated 10 months ago
Was this helpful?
Control user access.
Symitar eDocs References: ,
This operation Verifies a user with the system.
The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.
{"AdministrativeCredentials":{"Password":"suwn37834b91&"}}
The Symitar user number and password to verify.
{"UserNumber":1995,"Password":"2dfKQYR!TeXJwe"}
The custom object for NexumAPI request attributes.
{"customFields":{"appId":"glaci"}}
POST /nexum/627/persistent/usermanagement/verifyUser HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 187 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "UserToVerify": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "Status": { "Message": "", "StatusCode": "0" } }
This operation Resets a user's password.
The Symitar user number.
1995
POST /nexum/627/persistent/usermanagement/resetUserPassword HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 142 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "UserNumber": 1995, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "Status": { "Message": "", "StatusCode": "0" }, "Password": "P@ssw0rd123" }
This operation Sets the user's password.
The Symitar user password.
P@ssw0rd123
POST /nexum/627/persistent/usermanagement/setUserPassword HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 167 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "UserNumber": 1995, "Password": "P@ssw0rd123", "nxAttributes": { "customFields": { "appId": "glaci" } } }
This operation Logs on a user to the system.
{"UserNumberCredentials":{"UserNumber":1995,"Password":"2dfKQYR!TeXJwe"}}
POST /nexum/627/persistent/usermanagement/logon HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 139 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "StatusMessage": [ "object Object" ], "TokenId": "iEG+nkqW+Qi3RfTt0STT3QYgxoM4p3ZCqPXI7Ibkg1d5ExB98ottVJJTByff6Kz0WETI1aR03AJZkev5O3J0Cg==" }
This operation Logs off a user from the system.
{"TokenCredentials":{"TokenId":"iEG+nkqW+Qi3RfTt0STT3QYgxoM4p3ZCqPXI7Ibkg1d5ExB98ottVJJTByff6Kz0WETI1aR03AJZkev5O3J0Cg=="}}
POST /nexum/627/persistent/usermanagement/logoff HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 189 { "Credentials": { "TokenCredentials": { "TokenId": "iEG+nkqW+Qi3RfTt0STT3QYgxoM4p3ZCqPXI7Ibkg1d5ExB98ottVJJTByff6Kz0WETI1aR03AJZkev5O3J0Cg==" } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "StatusMessage": [ "object Object" ] }