The credentials API provides functionality that allows a administrator to add, delete or update credentials
Table of Contents |
---|
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
Response
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
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 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
x - at least one field must be present Example - update more credentials
Response
Status: 200, 404, 406 |
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update credentials, filteredUpdate credentials configured in the Aspire, filtered by a specified criteria, this endpoint needs the ADMINISTRATOR role to be executed.
Filters: The credential filter definition here
Response
Status: 200, 406 |
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete multiple credentials, filteredDelete multiple credentials from Aspire, filtered by a specified criteria, this endpoint need the ADMINISTRATOR role to be executed.
Filters: The credential filter definition here Response
Status: 200 |
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 |
Section |
---|
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/credentials/type/:typeId/dxf |
Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"dxf": {...}
"message": "optional response message"
} |
Status: 200, 404
Anchor | ||||
---|---|---|---|---|
|
Credential filter:
Code Block | ||
---|---|---|
| ||
"filter" : { "ids" : ["ID1", "ID2", "ID3", ...], "type" : "TYPE", "description" : "DESCRIPTION", "throttlePolicy" : "THROTTLE_POLICY_ID" } |