The credentials API provides functionality that allows a administrator to add, delete or update credentials
Easy Heading Free | ||||
---|---|---|---|---|
| ||||
Section | |||||||
---|---|---|---|---|---|---|---|
Get all credentialsLists all the credentials configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed.
Query String Parameters | |||||||
Name | Type | Required | Description | ||||
from | integer | Optional | Retrieves the specified page of results | ||||
size | integer | Optional | Specifies the size of results page | ||||
sortBy | string | Optional | Field by which results are sorted |
Section | |||||||
---|---|---|---|---|---|---|---|
Get all credentials, filteredLists credentials configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the OPERATOR role to be executed.
Pagination query string parameters |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "credentialcount": [{ "id "totalItems": "AAABcID5GBc=" 1 }, "typecredential": "filesystem",[ "description": "Sales HD1 credentials", { "created": 1596707252548, "updatedid": 1596707252548, "properties": { This will be a dynamic JSON object } }, { "40b305ea-77e1-4874-aa28-964b1cf4a1a8", "idtype": "AAABcIueWUc=filesystem", "type": "filesystem", "description": "Sales HD2 credentialsxxxx", "created "throttlePolicy": 1596707252548, "10653921-1b27-40b5-9d7a-f54ef1e3ad01", "updated": 1596707252548, "properties": { This will be a dynamic JSON object } }] } |
Status
"domain": "xxxx",
"user": "xxxx",
"password": "xxxx"
}
}
]
} |
Status: 200
Section | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single credentialGet information about a single credential configured in Aspire, this endpoint need the at least the OPERATOR role to be executed.
Path Parameters
| |||||||||||||||
Section | |||||||||||||||
Get all credentials, filteredLists credentials configured in the Aspire, filtered by a specified criteria
Query String Parameters | |||||||||||||||
Name | Type | Required | Description | ||||||||||||
from | integer | Optional | Retrieves the specified page of results | ||||||||||||
size | integer | Optional | Specifies the size of results page | ||||||||||||
sortBy | string | Optional | Field by which results are sorted | ||||||||||||
sortMode | string | Optional | "asc" for ascending sort, "desc" for descending sort |
Name | Type | Required | Description |
---|---|---|---|
Filter | JSON | Required | Filters retrieved credentials. Check the filter definition here
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "credential": [{ "id": "AAABcID5GBc=40b305ea-77e1-4874-aa28-964b1cf4a1a8", "type": "filesystem", "description": "Sales HD1 credentialsxxxx", "createdthrottlePolicy": 1596707252548"10653921-1b27-40b5-9d7a-f54ef1e3ad01", "updatedproperties": 1596707252548, "properties": { This will be a dynamic JSON object } }{ "domain": "xxxx", { "id": "AAABcIueWUc=", "typeuser": "filesystemxxxx", "description": "Sales HD2 credentials", "createdpassword": 1596707252548, "updated": 1596707252548, "properties": { This will be a dynamic JSON object } }] } |
Status
"xxxx"
}
}
} |
Status: 200, 404
Section | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add credential(s)Adds credentials to Aspire, this endpoint need the ADMINISTRATOR role to be executed. Get a single credentialGet information about a single credential configured in Aspire
Query String Body Parameters
Response
Example
StatusResponse Response
| |||||||||||||||||||||||||||||||||||||||||||||||
404 | The given credentials id was not found | ||||||||||||||||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||||||||||||||||
Add multiple credentialsAdds multiple credentials to Aspire
Body Parameters | |||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||
type | string | Required | The type of credential to add | ||||||||||||||||||||||||||||||||||||||||||||
description | string | Required | An optional description of the credential |
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/credentials [{ "type": "filesystem", "description": "Europe Net Appliance" xxxx", "usernameproperties": "admin" }, { "type": "sharepoint" "description": "SP Online" "usernamedomain": "adminxxxx" }] |
Response
Code Block | ||
---|---|---|
| ||
{ "credential": [{ , "id": "AAABcID5GBc=", "typeuser": "filesystemxxxx", "description": "Europe Net Appliance", "created": 1596707252548, "updatedpassword": 1596707252548, "properties": { This will be a dynamic JSON object } xxxx" }, { "id": "AAABcIueWUc=", } "type": "sharepoint" "description": "SP Online", "created": 1596707252548, "updated": 1596707252548, "properties": { This will be a dynamic JSON object } }] } |
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors
Status
]
} |
See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors
Status: 201, 406
Section | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update credential(s)Update credentials in Aspire, this endpoint needs the ADMINISTRATOR role to be executed.
Body Parameters
Add single credentialAdd a credential to Aspire
Body Parameters
x - at least one field must be present Example - update more credentials
Response
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors Status | |||||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
201 | Created | ||||||||||||||||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input | ||||||||||||||||||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||||||||||||||||||
Response
Status: 200, 404, 406
Update multiple credentialsUpdate multiple credentials in Aspire.
Body Parameters | |||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||
id | string | Required | The identifier of the credential to update | ||||||||||||||||||||||||||||||||||||||||||||||
type | string | Optional | The type of credential | ||||||||||||||||||||||||||||||||||||||||||||||
description | string | Optional | An optional description of the credential |
Filters: The credential filter definition here
|
Other parameters passed in the request body will depend on the type of credential being created - see Add credential(s) above
Example
Code Block | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
PUT /aspire/_api/credentials
{
"AAABcID5GBc=": {
"id": "AAABcID5GBc="
Response
|
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors
Status
Status: 200, 406 |
Section | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete credential(s)Delete one or more connectors from Aspire, this endpoint need the ADMINISTRATOR role to be executed.
Path Parameters and Query parameters
Body Parameter
Examples
Response
Status: 200, 404, 406
Update single credentialUpdate a credential in Aspire
Query String Parameters | |||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||
id | string | Required | The identifier of the credential to update | ||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||
id | string | Required | The identifier of the credential to update | ||||||||||||||||||||||||||||||||||||||||||||
type | string | Optional | The type of credential | ||||||||||||||||||||||||||||||||||||||||||||
description | string | Optional | An optional description of the credential |
Filters: The credential filter definition here Response
Status: 200 |
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Export credentials(s)Export one or more credential from Aspire, this endpoint needs at least the OPERATOR role to be executed.
Response
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors Status | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | Success | ||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | Not found - a given credential identifier was not found | ||||||||||||||||||||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
|
Body Parameters
|
Info |
---|
Every configuration item has the option to export from the UI, using the single menu or by the bulk actions: |
Note |
---|
Something important that you need to know is that when you export a config item that depends on another, the export will contain also all the dependencies. |
Note |
---|
Take into consideration that components with resources loaded into elastic, will be exported, but the resource itself will not, so you will need to reupload the resource and go and select your resource in the component again. |
Path Parameters and Query parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier(s) of the credential(s) to export |
Body Parameter
Name | Type | Required | Description |
---|---|---|---|
ids | string | Required | The identifier(s) of the credential(s) to export |
Examples
Code Block | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/credentials/export/AAABcID5GBc
DELETE /aspire/_api/credentials/export?id=AAABcID5GBc&id=AAABcID5GBd
POST /aspire/_api/credentials/export
{
"ids":["AAABcID5GBc","AAABcID5GBd"]
}
|
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{
"export": {
"credentials": {
"credential": [
{
"id": "<credential_id>",
"type": "rest-api",
"description": "REST",
"properties": {
"type": "bearer",
"query": {
...
}
}
},
...
]
}
}
} |
Status: 200, 404, 406
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Export multiple credentials, filteredExport multiple credentials from Aspire, filtered by a specified criteria, this endpoint needs at least the OPERATOR role to be executed.
Filters: The connection filter definition here Response
Status: 200 |
Section |
---|
ImportThe import usage can be found here |
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Credential filter:
| |||||||||||||
Name | Type | Required | Description | ||||||||||
Filter | JSON | Required | Filters retrieved credentials. Check the filter definition here |
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors
Status
Delete a credentials from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Query String Parameters
Example
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/credentials/AAABcID5GBc= |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors
Status
Returns the dxf for a specific credential type
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/credentials/type/:typeId/dxf |
Query String Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"dxf": {...}
"message": "optional response message"
} |
Status
Some endpoint queries require a filter. A filter is basically a JSON object with the following format:
Credentials filter:
Code Block | ||
---|---|---|
| ||
"filter" : { "ids" : ["id1ID1", "id2ID2", "id3ID3", ...], "type" : "TYPE", "description" : "DESCRIPTION", "throttlePolicy" : "THROTTLE_POLICY_ID" } | ||
Note | ||
When using delete endpoints, ids in the filter are mandatory.} |