| Note | ||
|---|---|---|
| ||
As of July 25th, 2023, there is a content freeze on this page. |
There are 4 parts to controlling who can call your APIs:
...
The API Framework will attempt to authenticate to a single user with that "X-API-KEY" value.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"openapi": "3.0.3",
"info": {
"title": "My Company APIs",
"version": "1.0.0"
},
"components": {
"securitySchemes": {
"MyAPIKey": {
"type": "apiKey",
"in": "header",
"name": "X-API-Key"
}
}
},
"x-allowAnonymous": false,
"security": [
{
"MyAPIKey": []
}
]
} |
An example of a configuration that secures all APIs to require an API key credentials
...