The {auth} placeholder
Overview
{auth}
Either:
- The user's API Key can be provided within the request's
Authorization
header as aBearer
token.
Example:Authorization: Bearer 27c03f58-7c79-45d1-aa8f-76d697bbb10d
- The user's username and password can be provided within the request's
Authorization
header using aBasic
authentication string, which is a base64-encoded string containingusername:password
.
Example:Authorization: Basic am9obi5zbWl0aDpqb2huMTIz
- Request parameters
u
andp
for username and password, orapiKey
for the user's API Key.
Examples:u=john.smith&p=john123
ORapiKey=27c03f58-7c79-45d1-aa8f-76d697bbb10d
- Authentication can also be provided in body in JSON format for POST requests only.
Examples:"authentication": {
"username": "john.smith",
"password": "john123"
}
"authentication": {
"apiKey": "27c03f58-7c79-45d1-aa8f-76d697bbb10d"
}