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/persistent/usermanagement/verifyUser HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 231

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "UserToVerify": {
    "UserNumber": 1995,
    "Password": {
      "symx-user-password": null
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Status": {
    "StatusCode": 0,
    "Message": null
  },
  "MessageId": "verifyUser"
}

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.

Responses

200

Successful operation.

application/json

PasswordstringOptional

The Symitar user password.

post/resetUserPassword

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "UserNumber": 1,
  "nxAttributes": {
    "customFields": {}
  }
}

200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "Password": "text"
}

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.

PasswordstringOptional

The Symitar user password.

Responses

200

Successful operation.

application/json

post/setUserPassword

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "UserNumber": 1,
  "Password": "text",
  "nxAttributes": {
    "customFields": {}
  }
}

200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  }
}

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.

TokenIdstringOptional

The ID from using the logon operation in the UserManagementService.

post/logon

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": {
        "symx-user-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": null,
  "TokenId": "{token-id}",
  "MessageId": "logon",
  "StatusCode": 0
}

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/persistent/usermanagement/logoff HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "Credentials": {
    "TokenCredentials": {
      "TokenId": "{token-id}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": null,
  "Version_1": null,
  "_value_1": null,
  "MessageId": null,
  "StatusCode": 0
}