Skip to main content

Get user

ON THIS PAGE

Get user

Note: STABLE.

This API is reliable and breaking changes are unlikely.

Path

/{virtual proxy}/qps/user

/{virtual proxy}/qps/user?targetUri={uri}

Method

GET

Description

Get the current user's login status and the URI to log in or log out.

To obtain a login URI, you must include the targetUri request parameter. Its value must be the URI for QPS to redirect the user to after the user logs in. The targetUri parameter is valid only if it contains one of the following:

  • the fully qualified domain name of the computer the proxy is running on
  • the machine name of the computer the proxy is running on
  • any of the machine names or domain names specified in the Host white list of the virtual proxy settings in the QMC.

Returns

If the user is logged in:

{
  "userDirectory": "<user directory>",
  "userId": "<user ID>",
  "userName": "<user name>",
  "logoutUri": "<URI>"
}

If an anonymous user is logged in and a valid targetUri parameter is specified:

{
  "userDirectory": "NONE",
  "userId": "anonymous<GUID>",
  "session": "inactive",
  "loginUri": "<URI>"
}

If an anonymous user is logged in and no valid targetUri parameter is specified:

{
  "userDirectory": "NONE",
  "userId": "anonymous<GUID>",
  "session": "inactive"
}

If the user is not logged in and a valid targetUri parameter is specified:

{
  "session": "inactive",
  "loginUri": "<URI>"				
}

If the user is not logged in and no valid targetUri parameter is specified:

{
  "session": "inactive"
}