Warning | ||
---|---|---|
| ||
This page is in development and as such, its contents may be incorrect |
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.
Pagination query string parameters Sorting query string parameters
Response
| |||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||
200 | Success |
Section | |||||||
---|---|---|---|---|---|---|---|
Get all credentials, filteredLists credentials configured in the Aspire, filtered by a specified criteria
|
: 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
Query String Parameter | |||||||||||||||
expand | string | Optional | List of fields to expand, * will expand everything |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "credential": { "id": "AAABcID5GBc=40b305ea-77e1-4874-aa28-964b1cf4a1a8", "type": "filesystem", "description": "Filesystem credentialsxxxx", "throttlePolicy": "10653921-1b27-40b5-9d7a-f54ef1e3ad01", "created "properties": { "domain": 1596707252548"xxxx", "updated "user": 1596707252548"xxxx", "properties "password": {"xxxx" This will be a dynamic JSON object } } } |
: 200, 404
Section | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add credential(s)Adds credentials to Aspire, this endpoint need the ADMINISTRATOR role to be executed.
Body Parameters
Example
Response
See Response Body for details regrading regarding the response body returned where multiple items are affected with some (or all) returning errors | |||||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||||
201 | Created | ||||||||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update credential(s)Update credentials in Aspire, this endpoint needs the ADMINISTRATOR role to be executed.
Body Parameters
Other parameters passed in the request body will depend on the type of credential being created - see Add credential(s) above
x - at least one field must be present ExampleExample - update more credentials
Response
Status: 200, 404, 406
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
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
Body Parameters | ||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | filter | JSON | Required | Filters retrieved credentials. Check the filter definition
Filters: The credential filter definition here 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 |
Section | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Export credentials(s)Export one or more credential from Aspire, this endpoint needs at least the OPERATOR role to be executed Delete single credentialDelete a credentials from Aspire.
Path Parameters and Query parameters
Body Parameter
ExamplesExample
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 | |||||||||||||||||||||||||||||||||||||||||||
Status: 200, 404, 406
Get credential type dxf (TODO)Returns the dxf for a specific credential type
|
Section |
---|
ImportThe import usage can be found here |
Section | ||||||
---|---|---|---|---|---|---|
Filters
Credential filter: Path Parameters | ||||||
Name | Type | Required | Description | |||
typeId | string | Required | The id of the type for which dxf is going to be retrieved |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "filter" "dxf": {...} "message": "optional response message" } |
Status
: {
"ids" : ["ID1", "ID2", "ID3", ...],
"type" : "TYPE",
"description" : "DESCRIPTION",
"throttlePolicy" : "THROTTLE_POLICY_ID"
}
} |