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
Pagination query string parameters
Response
Status: 200 |
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single credentialGet information about a single credential configured in Aspire
Path Parameters
Response
Status: 200, 404 |
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add credential(s)Adds credentials to Aspire
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: 201, 406 |
Section | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update credential(s)Update credentials in Aspire.
Body Parameters
+ fields from "Add" section... Example - update more credentials
Response
See Response Body for details regrading regarding the response body returned where multiple items are affected with some (or all) returning errors Status: 200, 404, 406 |
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Update credentials, filteredUpdate credentials configured in the Aspire, filtered by a specified criteria
Response
Status: 200, 406 |
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete multiple credentials, filteredDelete multiple credentials from Aspire, filtered by a specified criteria
Response
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors Status: 200 |
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete credential(s)Delete one or more connectors from Aspire.
Path Parameters and Query parameters
Body Parameter
Examples
Response
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors Status: 200, 404, 406 |
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get credential type dxf (TODO)Returns the dxf for a specific credential type
Path Parameters
Response
Status: 200, 404 |