Add user

/msp/user.php/?action=add

[GET]  [POST]

Add a user account to the API user's subscription. This API does not support session based authentication.

User registration - Click here for registration process

Permissions - Click here for user related permissions

Input Parameters

Parameter

Description

action=add

(Required)

send_email={0|1}

(Optional) A flag that indicates whether the new user will receive an email notification with a secure link to their login credentials. This parameter is invalid when the user role is Contact.

1 - When unspecified or set to 1, an email notification will be sent to the new user. The user clicks a secure link in the email to view the login ID and password.

0 - When set to 0 an email notification will not be sent to the new user, and the XML report returned by the function will include the login ID and password for the user account as XML value pairs.

{parameters}

(Some parameters are required) Click here for listing of user parameters

Sample - Add user

API request

https://qualysapi.qualys.com/msp/user.php?action=add&user_role=scanner&business_unit=Unassigned&first_name=Chris&last_name=Washington&title=Security+Consultant&phone=2126667777&fax=2126667778&[email protected]&address1=500+Charles_Avenue&address2=Suite+1260&city=New+York&country=United+States+of+America&state=New+York&zip_code=10004

XML output

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

<!DOCTYPE USER_OUTPUT SYSTEM "https://qualysapi.qualys.com/user_output.dtd">

<USER_OUTPUT>

  <API name="user.php" username="sabkl_av1" at="2018-07-20T22:54:25Z" />

  <RETURN status="SUCCESS">

    <MESSAGE>quays_cw4 user has been successfully created.</MESSAGE>

  </RETURN>

</USER_OUTPUT>

DTD

<platform API server>/user_output.dtd