Continuous Dynamic Help DocsContinuous Dynamic Portal Login (US)Continuous Dynamic Portal Login (EU)Customer Support
API Reference

Add a site credential

post
https://sentinel.whitehatsec.com/api/site//site_credentials

This operation enables you to add a single credential to allow the WhiteHat scanner (or TRC consultant) to log into your site. A maximum of 2 scanning credentials may be added per site, except for BE sites, which can only have one. Additionally, for sites at the PE service level, an unlimited number of Business Logic credentials may be added.

Path Params
int32
required

Site ID.

Query Params
string
enum
Defaults to xml

The response representation format for results.

Allowed:
Body Params

Holds the information to update a single, existing site credential.

string

A valid username for logging into the site. Optional if pam_integration_id is provided.

string

A valid password to go with the username to be used for this credential. Optional if pam_integration_id is provided.

string
required

Credentials are associated with a 'cred_group', which must have a name that is less than 64 characters in length. This parameter is required in the POST request content for Business Logic credentials, and in the PUT request content for all credentials.

number

Priority/sorting order for site credentials (1=primary, 2=secondary, 3=tertiary. etc). If a credential of the specified priority already exists, the request will not succeed.

number
enum

Specify whether this credential will be used for scanning or not. If this is set to '0' for a PE site, the credential will be used for business logic testing. For sites of other service levels, only scanning credentials are allowed.

Allowed:
string
required

The URL (entry portal) where login will be attempted with these credentials.

string
required

The URL where the logged-in user is expected to land.

string

Any additional login instructions or other information for this credential.

string

Target or Secret Path (for Vault app_role) identifier for PAM credential retrieval. Required if pam_integration_id is provided.

number

ID of the PAM integration to use. If provided, username and password become optional.

string

Additional options/configuration for the credential

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.

409

Conflict indicates that the request could not be processed because of conflict in the request, such as an edit conflict.

500

GenericError generic error.

Updated 4 months ago

Language
Response 
 Choose an example:
application/json
application/xml
Updated 4 months ago