Check whether a specific user exists

Check whether a specific user is defined on your system based on his or her ID.

For security reasons, you need to perform a Login action before making any other public calls to the WorldServer API. The sessionId in the response is your session token. Use this token in all the other calls that you make.

Also, make sure that you have the appropriate user type permissions to perform this API call. To view or update your permissions, in WorldServer, go to Management > User Setup > User Types, and then select your user type.

API call

<protocol>://<ws-host>:<ws-port>/ws-api/v1/users/<userId>?token=<sessionId>

Details

  • HEAD method
  • Content-Type in the header: application/json
  • Mandatory parameters: the session token (as a query string parameter or as a key-value pair in the header) and the ID of the user (as a URI parameter)

Response

  • The response does not have a body.
  • Status code:
    • 302 Found (If the user exists.)
    • 404 Not Found (If the user does not exist.)
    • 500 Internal Server Error (If the ID you entered is not a valid number.)

Error messages

No session token provided or invalid token (401 Unauthorized)