API Keys - API DOCS
This feature is only available in Arcentry Enterprise, the commercial on-premise version of Arcentry. You can learn more about it here or contact us at info@arcentry.com.
API keys authenticate clients that programmatically access Arcentry's REST APIs. To create an API key, users require the ACCESS_API permission.
Create a new API key
Creates a new API key for the given user. This request can be authenticated with either an existing session or email and password parameters or an existing SSO token.
Request Parameter for email/password authentication
-
The email for the user.
-
password for the user.
Request Parameter for SSO token authentication
-
The JSON Web Token. Alternatively, this can also be provided as a cookie
POST
/api/v1/api-key/create
{
"success": true,
"apiKey": "16841ea10211cad8c5dfeb6e8a674c4571559129a103368aedea86cb621291b4",
"expirationTime": 1578763402956
}
List API Keys
Provides a list of all registered API keys for the given user, including their expiration date.
GET
/api/v1/api-key/list
[
{
"key": "16841ea10211cad8c5dfeb6e8a674c4571559129a103368aedea86cb621291b4",
"user_id": "171754ea-9997-438d-a88e-6e54d8bef87f",
"expirationTime": 1578763402956
},
{
"key": "598637da646ab39c957d59b276191f3db4514211755f4ed16e5598cf7c888e5c",
"user_id": "171754ea-9997-438d-a88e-6e54d8bef87f",
"expirationTime": 1578763601271
}
]
Get Meta Information about a key
Provides meta data for the key provided in the Bearer Authorization header.
GET
/api/v1/api-key/get-details
{
"userId": "171754ea-9997-438d-a88e-6e54d8bef87f",
"orgId": "120f7d4e-18c1-4eb4-b54c-e146705b372f",
"firstname": "ADMIN",
"lastname": "ADMIN",
"email": "admin@arcentry.com",
"creationDate": 1578158801271,
"expirationDate": 1578763601271
}
Delete a key
Provides meta data for the key provided in the Bearer Authorization header.
POST
/api/v1/api-key/delete
{
"key": "598637da646ab39c957d59b276191f3db4514211755f4ed16e5598cf7c888e5c"
}
{
"success": true
}