Last updated
Last updated
API key used in and is represented by class.
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
.
GET
http://{server-address}/apikeys
Returns all API keys that matches query parameters. Result is of type .
GET
http://{server-address}/apikeys/{id}
POST
http://{server-address}/apikeys
Required rights
PUT
http://{server-address}/apikeys/{id}
Required rights
DELETE
http://{server-address}/apikeys/{id}
Required rights
Result is of type .
Creates new API key. Result is of type .
Authorized user must have ApiKeyCreate
assigned.
Creates new or updates existing API key. Result is of type .
Authorized user must have assigned ApiKeyCreate
or ApiKeyUpdate
.
Authorized user must have ApiKeyDelete
assigned.
id*
string
Unique identifier.
Authorization*
string
Authorization header with authorization token.
Authorization*
string
Authorization header with authorization token.
(body)*
ApiKey
Model to create.
id*
string
Unique identifier.
Authorization*
string
Authorization header with authorization token.
(body)*
ApiKey
Model to create or update.
id*
string
Unique identifier.
Authorization*
string
Authorization header with authorization token.
This page provides a description of the available API routes for managing API keys.
id
string
Supports NData syntax.
isActive
bool
Supports NData syntax.
$skip
int
Pagination property. Describing number of records to skip from beginning of result collection.
$take
int
Pagination property. Maximum count of items to be returned.
$sort
string[]
Comma separated list of property names. Please see NData syntax.
$count
bool
If set to true
, response will not contain items
collection. Use to get resource count, not the resources themselves.
Authorization*
string
Authorization header with authorization token.