Get auth configs API in Website Scanner
Use this API to get a list of auth configs created for your website scans.
get auth configs
If Geo Region Restriction (GRR) is enabled for your account, add your region code to the host name:
api-accessibility-<region>.browserstack.com. See Geo Region Restriction endpoints for the region codes and examples.
Request parameters
Request
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://api-accessibility.browserstack.com/api/website-scanner/v1/auth_configs
-
No parameter required.
Response attributes 200 OK JSON
Response
{
"success": true,
"data": {
"authConfigs": [
{
"id": 1560,
"name": "sampleform",
"type": "form",
"authData": {
"url": "https://sampleurl.com",
"username": "sample@sample.com",
"password": "sample_password",
"usernameSelector": "input[name=\"userName\"]",
"passwordSelector": "input[name=\"password\"]",
"submitSelector": "button[type=\"submit\"]"
}
},
{
"id": 1561,
"name": "samplebasic",
"type": "basic",
"data": {
"username": "sample@sample.com",
"password": "sample_password"
}
}
]
}
}
-
success Boolean
Indicates whether the request was successful.
-
data Object
â–¶ SHOW VALUESContains the list of authentication configurations.
-
authConfigs Array
â–¶ SHOW VALUESList of authentication configuration objects.
-
id Integer
The unique ID of the authentication configuration.
-
name String
The name of the authentication configuration.
-
type String
The authentication type. Possible values are
basic(HTTP basic auth) orform_2(form-based auth). -
authData Object
The authentication credentials. The fields vary based on the
type(seeAuthConfigBasicDataorAuthConfigFormData).
-
-
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.