This article explains the steps for retrieving API keys for all users in BlueDolphin. Only the Administrator's role in BlueDolphin enables the user to retrieve personalized API keys of other users.
HTTP responses
HTTP response status code | Interpretation |
200 OK | A list of API keys retrieved successfully |
400 Bad Request | One or more parameters are missing or incorrect. The response body returns a specific error:
|
401 Unauthorized | Invalid or missing API key secret and/or tenant |
Curl command to retrieve user keys,
EU:
curl --location 'https://public-api.eu.bluedolphin.app/v1/user-api-keys' \
--header 'x-api-key: {api-key}' \
--header 'tenant: {tenant}' \
--header 'Content-Type: application/json'
US:
curl --location 'https://public-api.us.bluedolphin.app/v1/user-api-keys' \
--header 'x-api-key: {api-key}' \
--header 'tenant: {tenant}' \
--header 'Content-Type: application/json'
Response Properties
Property | Type | Description |
|
id | string | Unique identifier for the API key |
|
user_id | string | Unique identifier for the user |
|
name | string | Key name, use a descriptive name to recognize this later. |
|
expiration_date | string | The date of expiration in ISO-8601 date format (YYYY-MM-DD) |
|
created_on | string | The date of creation in ISO-8601 date-time Zulu format |
|
updated_on | string | null | The date of the last update in ISO-8601 date-time Zulu format, or null when not updated yet |
|
scopes | string[] | The list of scope identifiers. Currently, there is one value available, which is 'public_api'. |
|
A successful call returns a response with a 200 OK HTTP status code and the following array:
[
{
"id": "63c57b3882345012d9e7a157",
"user_id": "72f62077d23a6eeb4a772836",
"name": "NewKey",
"expiration_date": "2024-08-08",
"created_on": "2023-08-08T09:15:00Z",
"updated_on": "2023-08-09T10:15:00Z",
"scopes": [
"public_api"
]
},
{
"id": "57b57c2197287115e4a3e397",
"user_id": "72f62077d23a6eeb4a772836",
"name": "NewAPIKey",
"expiration_date": "2024-07-08",
"created_on": "2023-07-08T09:15:00Z",
"updated_on": "2023-07-08T10:15:00Z",
"scopes": [
"public_api"
]
}
]