To enable API key usage, the API key must be activated by setting the isActive field to true. Once the API key is authorized on the server, the request will be executed within the context of the user specified by their userName, operating on the device specified by the deviceName.
API methods
Get API keys
GEThttp://{server-address}/apikeys
Returns all API keys that matches query parameters. Result is of type QueryResult<ApiKey>.
Query Parameters
Headers
{"items": [ {"id":"64b00bc5ba312b6744126a87","clientId":"60f33924e92a4262763a08230c6c385f33c497f3","clientSecret":"df80d7cae59b9a9c3ee76a3750f80ef9d0c9398083d0dc591952cd675926944c","isActive":true,"createdAt":"2023-07-13T14:35:49.506Z","name":"My API key","description":"This is an API key description","userName":"john.doe","deviceName":"BackOffice","permissions": [],"_v":1 } ],"count": 1,"totalCount": 1}
{"id": "64b00bc5ba312b6744126a87","clientId": "60f33924e92a4262763a08230c6c385f33c497f3","clientSecret": "df80d7cae59b9a9c3ee76a3750f80ef9d0c9398083d0dc591952cd675926944c","isActive": true,"createdAt": "2023-07-13T14:35:49.506Z","name": "My API key","description": "This is an API key description","userName": "john.doe","deviceName": "BackOffice","permissions": [],"_v": 1}
Authorized user must have ApiKeyCreateright assigned.
Headers
Request Body
{"id": "64b00bc5ba312b6744126a87","clientId": "60f33924e92a4262763a08230c6c385f33c497f3","clientSecret": "df80d7cae59b9a9c3ee76a3750f80ef9d0c9398083d0dc591952cd675926944c","isActive": true,"createdAt": "2023-07-13T14:35:49.506Z","name": "My API key","description": "This is an API key description","userName": "john.doe","deviceName": "BackOffice","permissions": [],"_v": 1}
Create or update API key
PUThttp://{server-address}/apikeys/{id}
Creates new or updates existing API key. Result is of type API key.
Required rights
Authorized user must have assigned ApiKeyCreate or ApiKeyUpdateright.
Path Parameters
Headers
Request Body
{"id": "64b00bc5ba312b6744126a87","clientId": "60f33924e92a4262763a08230c6c385f33c497f3","clientSecret": "df80d7cae59b9a9c3ee76a3750f80ef9d0c9398083d0dc591952cd675926944c","isActive": true,"createdAt": "2023-07-13T14:35:49.506Z","name": "My API key","description": "This is an API key description","userName": "john.doe","deviceName": "BackOffice","permissions": [],"_v": 2}
Delete API key
DELETEhttp://{server-address}/apikeys/{id}
Required rights
Authorized user must have ApiKeyDeleteright assigned.
Path Parameters
Headers
{"id": "64b00bc5ba312b6744126a87","clientId": "60f33924e92a4262763a08230c6c385f33c497f3","clientSecret": "df80d7cae59b9a9c3ee76a3750f80ef9d0c9398083d0dc591952cd675926944c","isActive": true,"createdAt": "2023-07-13T14:35:49.506Z","name": "My API key","description": "This is an API key description","userName": "john.doe","deviceName": "BackOffice","permissions": [],"_v": 1}