Introduction
© 2024 LEKAB Communication Systems AB. Version 5.1.181, 2024-11-04.
This Web Service is used to handle API Keys and OAuth 2.0 Bearer Tokens.
Authentication method
Username and password shall be given as Basic authentication, i.e, the
header Authorization
should have the value Basic token
, where the
token is the Base64
encoding of (a UTF-8
byte array representation of)
username:password
. Here testuser:testpass
will be encoded as
dGVzdHVzZXI6dGVzdHBhc3M=
and the Authorization
header will have the value
Basic dGVzdHVzZXI6dGVzdHBhc3M=
1. The /apikey
endpoint
2. The /token
endpoint
The /token
endpoint is used to request an OAuth 2.0 Bearer Token.
2.1. POST request example
curl -X POST --location "https://secure.lekab.com/auth/api/v1/token" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d 'grant_type=client_credentials' \
--basic --user username:password
2.1.1. Explanation of parameters
POST param | query param value | Description |
---|---|---|
grant_type |
client_credentials (string) |
The requested grant type. Only |
2.1.2. HTTP response
A successful request will return 200
OK and a JSON object containing the Bearer token.
If the user does not present proper login credentials a 401
Unauthorized will be returned.
3. The /revoke
endpoint
The /revoke
endpoint is used to revoke an OAuth 2.0 Bearer Token.
3.1. POST request example
curl -X POST --location "https://secure.lekab.com/auth/api/v1/revoke" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d 'token=e45c538d-a416-4489-9d5f-a78d3c4fc69a' \
--basic --user username:password