List users

/msp/user_list.php

[GET]  [POST]

List user accounts in the subscription that are visible to the API user. This API does not support session based authentication.

Permissions - Click here for user related permissions

Input Parameters

Parameter

Description

external_id_contains={string}

(Optional) Show only user accounts with an external ID value that contains a certain string. The string you specify can have a maximum of 256 characters. The characters can be in uppercase, lowercase or mixed case (the service performs case sensitive matching). HTML or PHP tags cannot be included.

external_id_contains or external_id_assigned can be specified in same request.

external_id_assigned={0|1}

(Optional) Specify 1 to show only user accounts which have an external ID value assigned. Specify 0 to show only user accounts which do not have an external ID value assigned.

external_id_contains or external_id_assigned can be specified in same request.

Sample - List users

API request

https://qualysapi.qualys.com/msp/user_list.php"

XML output

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE USER_LIST_OUTPUT SYSTEM "https://qualysapi.qualys.com/user_list_output.dtd">

<USER_LIST_OUTPUT>

  <USER_LIST>

    <USER>

      <USER_LOGIN>acme_ab1</USER_LOGIN>

      <USER_ID>63</USER_ID>

      <CONTACT_INFO>

        <FIRSTNAME><![CDATA[Alex]]></FIRSTNAME>

        <LASTNAME><![CDATA[Kim]]></LASTNAME>

        <TITLE><![CDATA[Manager, Security]]></TITLE>

        <PHONE><![CDATA[650 801 6100]]></PHONE>

        <FAX><![CDATA[650 801 6101]]></FAX>

        <EMAIL><![CDATA[[email protected]]]></EMAIL>

        <COMPANY><![CDATA[Acme, Inc.]]></COMPANY>

        <ADDRESS1><![CDATA[100 Summer Street]]></ADDRESS1>

        <ADDRESS2><![CDATA[]]></ADDRESS2>

        <CITY><![CDATA[San Francisco]]></CITY>

        <COUNTRY>United States of America</COUNTRY>

        <STATE>California</STATE>

        <ZIP_CODE><![CDATA[94111]]></ZIP_CODE>

        <TIME_ZONE_CODE><![CDATA[Auto]]></TIME_ZONE_CODE>

      </CONTACT_INFO>

      <USER_STATUS>Active</USER_STATUS>

      <CREATION_DATE>2017-07-26T19:43:01Z</CREATION_DATE>

      <LAST_LOGIN_DATE>2018-04-26T22:41:56Z</LAST_LOGIN_DATE>

      <USER_ROLE>Manager</USER_ROLE>

      <BUSINESS_UNIT><![CDATA[Unassigned]]></BUSINESS_UNIT>

      <UNIT_MANAGER_POC>0</UNIT_MANAGER_POC>

      <MANAGER_POC>1</MANAGER_POC>

      <UI_INTERFACE_STYLE>standard_blue</UI_INTERFACE_STYLE>

      <PERMISSIONS>

        <CREATE_OPTION_PROFILES>1</CREATE_OPTION_PROFILES>

        <PURGE_INFO>1</PURGE_INFO>

        <ADD_ASSETS>1</ADD_ASSETS>

        <EDIT_REMEDIATION_POLICY>1</EDIT_REMEDIATION_POLICY>

        <EDIT_AUTH_RECORDS>1</EDIT_AUTH_RECORDS>

      </PERMISSIONS>

      <NOTIFICATIONS>

        <LATEST_VULN>weekly</LATEST_VULN>

        <MAP>ags</MAP>

        <SCAN>ags</SCAN>

        <DAILY_TICKETS>0</DAILY_TICKETS>

      </NOTIFICATIONS>

    </USER>

    <USER>

 ...   

    <USER>

      <USER_LOGIN>acme_gh</USER_LOGIN>

      <USER_ID>213036</USER_ID>

      <CONTACT_INFO>

        <FIRSTNAME><![CDATA[Geoff]]></FIRSTNAME>

        <LASTNAME><![CDATA[Holden]]></LASTNAME>

        <TITLE><![CDATA[Security Scanner]]></TITLE>

        <PHONE><![CDATA[650 801 6100]]></PHONE>

        <FAX><![CDATA[650 801 6101]]></FAX>

        <EMAIL><![CDATA[[email protected]]]></EMAIL>

        <COMPANY><![CDATA[Acme, Inc.]]></COMPANY>

        <ADDRESS1><![CDATA[100 Summer Street]]></ADDRESS1>

        <ADDRESS2><![CDATA[]]></ADDRESS2>

        <CITY><![CDATA[San Francisco]]></CITY>

        <COUNTRY>United States of America</COUNTRY>

        <STATE>California</STATE>

        <ZIP_CODE><![CDATA[94111]]></ZIP_CODE>

        <TIME_ZONE_CODE><![CDATA[US-CA]]></TIME_ZONE_CODE>

      </CONTACT_INFO>

      <ASSIGNED_ASSET_GROUPS>

          <ASSET_GROUP_TITLE><![CDATA[AG 24]]></ASSET_GROUP_TITLE>

      </ASSIGNED_ASSET_GROUPS>

      <USER_STATUS>Pending Activation</USER_STATUS>

      <CREATION_DATE>2018-04-06T21:02:26Z</CREATION_DATE>

      <LAST_LOGIN_DATE>N/A</LAST_LOGIN_DATE>

      <USER_ROLE>Scanner</USER_ROLE>

      <BUSINESS_UNIT><![CDATA[Unassigned]]></BUSINESS_UNIT>

      <UNIT_MANAGER_POC>0</UNIT_MANAGER_POC>

      <MANAGER_POC>0</MANAGER_POC>

      <UI_INTERFACE_STYLE>standard_blue</UI_INTERFACE_STYLE>

      <PERMISSIONS>

        <CREATE_OPTION_PROFILES>1</CREATE_OPTION_PROFILES>

        <PURGE_INFO>0</PURGE_INFO>

        <ADD_ASSETS>0</ADD_ASSETS>

        <EDIT_REMEDIATION_POLICY>0</EDIT_REMEDIATION_POLICY>

        <EDIT_AUTH_RECORDS>0</EDIT_AUTH_RECORDS>

      </PERMISSIONS>

      <NOTIFICATIONS>

        <LATEST_VULN>weekly</LATEST_VULN>

        <MAP>ags</MAP>

        <SCAN>ags</SCAN>

        <DAILY_TICKETS>0</DAILY_TICKETS>

      </NOTIFICATIONS>

    </USER>

...

DTD

<platform API server>/user_list_output.dtd