Modify a user

put

https://sentinel.whitehatsec.com/api/user/{user_id}

This operation enables you to modify an existing user.

NOTE: < and > characters are not allowed in any updateable field.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

user_id

int32

required

User ID.

Query Params

format

string

enum

Defaults to application/xml

Selects the requested response representation format.

Allowed:

Body Params

Holds the sentinel user information for PUT operation.

role

string

The user's Sentinel role.

address

string

The user's mailing address.

city

string

The city in which the user resides or works.

company

string

The company the user works for.

country

string

The country in which the user resides or works.

first_name

string

The user's first name.

last_name

string

The user's last name.

phone

number

A phone number where the user can be reached.

state

string

The state in which the user resides or works.

zipcode

number

The zip code associated with the user's address.

fax

number

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

job_title

string

The user's job title.

notes

string

Any additional notes about the user.

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, the update will not be applied.

timezone

string

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

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

Loading…

Response

Choose an example:

application/json

application/xml

200Provides information about the modified user.