UserManagementService

Control user access.

Symitar eDocs References: User Control, Resetting User Password Using Security Control

Operations

verifyUser

post

This operation Verifies a user with the system.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/verifyUser

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/usermanagement/verifyUser HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 187

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserToVerify": {
    "UserNumber": 1995,
    "Password": "2dfKQYR!TeXJwe"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Status": {
    "Message": "",
    "StatusCode": "0"
  }
}

resetUserPassword

post

This operation Resets a user's password.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

UserNumberintegerRequired

The Symitar user number.

Example: 1995

Responses

200

Successful operation.

application/json

PasswordstringOptional

The Symitar user password.

Example: P@ssw0rd123

post

/resetUserPassword

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/usermanagement/resetUserPassword HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 1995,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Status": {
    "Message": "",
    "StatusCode": "0"
  },
  "Password": "P@ssw0rd123"
}

setUserPassword

post

This operation Sets the user's password.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

UserNumberintegerOptional

The Symitar user number.

Example: 1995

PasswordstringOptional

The Symitar user password.

Example: P@ssw0rd123

Responses

200

Successful operation.

application/json

post

/setUserPassword

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/usermanagement/setUserPassword HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 167

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 1995,
  "Password": "P@ssw0rd123",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Status": {
    "Message": "",
    "StatusCode": "0"
  }
}

logon

post

This operation Logs on a user to the system.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

StatusMessagestringOptional

Additional message detailing the status.

Example: ["object Object"]

TokenIdstringOptional

The ID from using the logon operation in the UserManagementService.

post

/logon

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/usermanagement/logon HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "",
  "TokenId": "iEG+nkqW+Qi3RfTt0STT3QYgxoM4p3ZCqPXI7Ibkg1d5ExB98ottVJJTByff6Kz0WETI1aR03AJZkev5O3J0Cg==",
  "customFields": {
    "appId": "glaci"
  }
}

logoff

post

This operation Logs off a user from the system.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

StatusMessagestringOptional

Additional message detailing the status.

post

/logoff

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/usermanagement/logoff HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "Credentials": {
    "TokenCredentials": {
      "TokenId": "iEG+nkqW+Qi3RfTt0STT3QYgxoM4p3ZCqPXI7Ibkg1d5ExB98ottVJJTByff6Kz0WETI1aR03AJZkev5O3J0Cg=="
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "",
  "customFields": {
    "appId": "glaci"
  }
}