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
Status: 200 | |||||||||||||||||||||||
Section | |||||||||||||||||||||||
Get all credentials, filteredLists credentials configured in the Aspire, filtered by a specified criteria
|
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
Response
Status: 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 Status: 200201, 406 |
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
|
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
|
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
ExampleExamples
Response
Status: 200, 404, 406
Get credential type dxf (TODO)
Path Parameters
|
Section |
---|
ImportThe import usage can be found here |
Section | ||||||
---|---|---|---|---|---|---|
Filters
Credential filter: | ||||||
Name | Type | Required | Description | |||
typeId | string | Required | The id of the type for which dxf is going to be retrieved |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "filter" : { "dxfids" : {...} ["ID1", "ID2", "ID3", ...], "type" : "TYPE", "messagedescription" : "optional response message" } |
"DESCRIPTION",
"throttlePolicy" : "THROTTLE_POLICY_ID"
}
} |