Sign in

v1

latestOpenAPI 3.0.32026-07-134103031.5 MB
Targets

Test Log In to API

Test the API login configuration by making a login request
and returning available JSON selectors from the response.

Supported media types:

  • application/json: JSON-formatted payload in request body
  • application/x-www-form-urlencoded: Form-encoded payload in URL
  • application/graphql: Raw GraphQL query string
post/targets/{id}/check_api_login/

Path parameters

idstring required

A unique Base58 value identifying this object.

Request body

media_type'application/json' | 'application/x-www-form-urlencoded' | 'application/graphql'

Format of the payload:

  • application/json - The payload is in JSON format in the request body.
  • application/x-www-form-urlencoded - The payload is encoded in the request URL.
  • application/graphql - The payload is a raw GraphQL query string.
api_login_urlstring

URL to make the authentication request to the API.
The maximum length is 2048 characters.

api_login_payloadstring

Payload to send in the authentication request.
The maximum length is 4096 characters.

api_login_payload_is_sensitiveboolean
api_login_token_fieldstring

Field containing the authentication token in the response to the authentication request.
The maximum length is 256 characters.

token_prefixstring

Prefix to add to the authentication token.
For example, "Bearer" or "JWT".
The maximum length is 16 characters.

token_parameter_namestring

Parameter name to send the authentication token.
For example, "Authorization".
The maximum length is 256 characters.

token_parameter_location'cookie' | 'header' required

Where to send the parameter name with the authentication token and the prefix:

  • cookie - Cookie
  • header - Header

Response

string[] required

Example response

[
  "[\"user.username\", \"user.email\"]"
]