Document Basic Auth for API authentication #89
Description
Description
The Kosli API supports Basic Auth (Authorization: Basic header), but this
isn't documented. Users trying to use Basic Auth may use the wrong credential
format and get Access denied errors.
How Basic Auth works in Kosli
The API key goes in the username field. The password is ignored.
curl -u "${API_KEY}:unused" https://app.kosli.com/api/v2/environments/{org}
Or equivalently:
Authorization: Basic <base64(API_KEY:unused)>
Why this matters
Some CI/CD platforms (e.g. Azure DevOps Service Connections) only support
username:password style credentials, not Bearer tokens. Users need to
know they can use Basic Auth and that the API key must be in the username
position.
Tasks
- Add Basic Auth as a documented authentication method alongside Bearer tokens
- Show curl examples for both methods
- Clarify that for Basic Auth, the API key is the username and the password is ignored
- Mention the Azure DevOps Service Connection use case as a practical example