Create a user

post

https://sentinel.whitehatsec.com/api/user

This operation enables you to create a new user.

Query Params

format

string

enum

Defaults to application/xml

Selects the requested response representation format.

Allowed:

Body Params

Holds the sentinel user information.

action_items_email

number

enum

If this field is set, the user will receive action items emails.

Allowed:

address

string

The user's mailing address.

city

string

The city in which the user resides or works.

client_id

number

required

New user's Client ID.

company

string

The company the user works for.

country

string

The country in which the user resides or works.

expose_hostnames

number

enum

If this field is set, hostnames of sites the user has an association with will be exposed in emails sent to the user.

Allowed:

fax

number

A fax number where the user or user's company can be reached.

first_name

string

The user's first name.

immediate_email

number

enum

If this field is set, the user will receive hourly emails on new vulnerabilities.

Allowed:

job_title

string

The user's job title.

last_name

string

The user's last name.

middle_initial

string

First initial of the user's middle name. NOTE: Only a single character is acceptable for this field. If more characters are used, no data will be inserted into this field.

monthly_email

number

enum

If this field is set, the user will receive monthly summary emails on vulnerabilities and other issues.

Allowed:

notes

string

Any additional notes about the user.

phone

number

A phone number where the user can be reached.

require_mfa

number

enum

If this field is set, multi-factor authentication for Sentinel login is required for this user.

Allowed:

role

string

New user's Sentinel role. If not specified, defaults to 'Viewer'.

state

string

The state in which the user resides or works.

timezone

string

The user's time zone. Only valid time zones with the accepted timezone format are allowed. EXAMPLE: 'America/New_York'

type

string

required

New user's type. Currently, this should always be 'sentinel'.

update_email

number

enum

If this field is set, the user will receive daily emails on new vulnerabilities.

Allowed:

username

string

required

New user's username. This should be a well-formed, valid email address.

weekly_email

number

enum

If this field is set, the user will receive weekly summary emails on vulnerabilities and other issues.

Allowed:

zipcode

number

The zip code associated with the user's address.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

BadRequestResponse indicates a request with invalid parameters.

401

UnauthorizedResponse signals an unauthorized API access.

403

ForbiddenResponse signals a request for a resource that does not exist or is not authorized.

500

GenericError generic error.

Language

Response

Choose an example:

application/json

application/xml

201Provides the sentinel user information.