Parameters for defining Users

Permissions

user_role={role}

Specifies the user role. A valid value is: manager, unit_manager, scanner, reader, contact or administrator. The first user added to a new custom business unit must be unit_manager.

Add request: Required (Invalid for Express Lite user)

Edit request: Invalid

business_unit={title}

Specifies the user’s business unit. A valid value is “Unassigned”, or the title of an existing custom business unit. Note a custom business unit may be added using the Qualys user interface.

Add request: Required (Invalid for Express Lite user)

Edit request: Invalid

asset_groups={grp1,grp2...}

Specifies the asset groups assigned to the user, when the user role is Scanner, Reader or Contact. Multiple asset groups are comma separated. This parameter is invalid when the user role is Manager or Unit Manager.

Add request: Optional | Edit request: Optional

General Info

first_name={name}

Specifies the user's first name. The name may include a maximum of 50 characters.

Add request: Required | Edit Request: Optional

last_name={name}

Specifies the user's last name. The name may include a maximum of 50 characters.

Add request: Required | Edit request: Optional

title={title}

Specifies the user's job title. The title may include a maximum of 100 characters.

Add request: Required | Edit request: Optional

phone={value}

Specifies the user's phone number. This value may include a maximum of 40 characters.

Add request: Required | Edit request: Optional

fax={value}

The user's FAX number. This value may include a maximum of 40 characters.

Add request: Optional | Edit request: Optional

email={value}

Specifies the user's email address. The address must be a properly formatted address with a maximum of 100 characters.

Add request: Required | Edit request: Optional

address1={value}

Specifies the user’s address line 1. This value may include a maximum of 80 characters.

Add request: Required | Edit request: Optional

address2={value}

Specifies the user’s address line 2. This value may include a maximum of 80 characters.

Add request: Optional | Edit request: Optional

city={value}

Specifies the user’s city. This value may include a maximum of 50 characters.

Add request: Required | Edit request: Optional

country={code}

Specifies the user’s country code. View Country Codes

Add request: Required | Edit request: Optional

state={code}

Specifies the user’s state code. A valid value depends on the country code specified for the country parameter. You must enter a state code using the state parameter when the country code is one of: “United States of America”, “Australia”, “Canada” or “India”. View State Codes

For other country codes, a state code does not need to be specified. If specified, enter the state code “none”.

Add request: Required for some country codes | Edit request: Optional

zip_code={zipcode}

(Optional) Specifies the user’s zip code. This value may include a maximum of 20 characters. If not specified, this is set to the zip code in the API user’s account.

external_id={value}

A custom external ID value. The external ID value can have a maximum of 256 characters, and it is case sensitive. The characters can be in uppercase, lowercase or mixed case. HTML or PHP tags cannot be included.

Specify external_id= or external_id=”” to delete an external ID value from an existing account.

Add request: Optional | Edit request: Optional

time_zone_code={value}

Set user profile to a time zone code i.e. US-NY. To set the profile to the browser's timezone pass empty/null, i.e. time_zone_code="

Looking for timezone codes? Run <platform API server>/msp/time_zone_code_list.php

Add request: Optional | Edit request: Optional