Test authentication credentials

This operations tests the Oauth or APIKey credentials provided for the specified API asset.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

SiteID specifies the API asset to be used for testing the credentials

Body Params

Contains the credentials to be tested

customHeaders
object

CustomHeaders contains the list of headers applied on top of all requests, used to test the authentication

string
required

Definition is the OpenAPI3 definition that contains the endpoint marked with x-wh-scan: true. The parsed endpiont will be used to validate the authentication

static
object

StaticAuthentication is the structure of data required to create a static api key login handler

tokenRequest
object
Responses

401

UnauthorizedResponse signals an unauthorized API access

403

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

404

NotFoundResponse indicates a request for a resource that does not exist

500

GenericError generic error

Language
LoadingLoading…
Response
Choose an example:
application/json