Test Log In to API

POST 
/targets/:id/check_api_login/

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

Request

Path Parameters

id stringrequired

application/json

Body

required

media_type string
Possible values: [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_url string

Possible values: <= 2048 characters

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

api_login_payload string

Possible values: <= 4096 characters

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

api_login_payload_is_sensitive boolean
api_login_token_field string

Possible values: <= 256 characters

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

token_prefix string

Possible values: <= 16 characters

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

token_parameter_name string

Possible values: <= 256 characters

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

token_parameter_location stringrequired
Possible values: [cookie, header]
Where to send the parameter name with the authentication token and the prefix:
• cookie - Cookie
• header - Header

application/x-www-form-urlencoded

Body

required

media_type string
Possible values: [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_url string

Possible values: <= 2048 characters

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

api_login_payload string

Possible values: <= 4096 characters

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

api_login_payload_is_sensitive boolean
api_login_token_field string

Possible values: <= 256 characters

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

token_prefix string

Possible values: <= 16 characters

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

token_parameter_name string

Possible values: <= 256 characters

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

token_parameter_location stringrequired
Possible values: [cookie, header]
Where to send the parameter name with the authentication token and the prefix:
• cookie - Cookie
• header - Header

multipart/form-data

Body

required

media_type string
Possible values: [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_url string

Possible values: <= 2048 characters

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

api_login_payload string

Possible values: <= 4096 characters

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

api_login_payload_is_sensitive boolean
api_login_token_field string

Possible values: <= 256 characters

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

token_prefix string

Possible values: <= 16 characters

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

token_parameter_name string

Possible values: <= 256 characters

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

token_parameter_location stringrequired
Possible values: [cookie, header]
Where to send the parameter name with the authentication token and the prefix:
• cookie - Cookie
• header - Header

Responses

200

application/json

Schema

Schema

• Array [

string

• ]

Example (from schema)

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

JSONLogin

JSON Login

{
  "api_login_url": "https://api.example.com/auth/login",
  "api_login_payload": "{\"username\": \"user\", \"password\": \"pass\"}",
  "media_type": "application/json"
}

Form-EncodedLogin

Form-Encoded Login

{
  "api_login_url": "https://api.example.com/auth/login",
  "api_login_payload": "username=user&password=pass",
  "media_type": "application/x-www-form-urlencoded"
}

GraphQLRawQuery

GraphQL Raw Query

{
  "api_login_url": "https://api.example.com/graphql",
  "api_login_payload": "mutation Login { login(email: \"[email protected]\", password: \"pass123\") { token user { id email } } }",
  "media_type": "application/graphql"
}

400

application/json

Schema

Schema

<field name> string[]
non_field_errors string[]

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

404

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Not found."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...