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 | ||||
type | string | Optional | Filter returned credentials to only those with the given type | description | string | Optional | Filter returned credentials to only those whose description matches the given expression
Pagination query string parameters
Sorting query string parameters
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 | ||||
---|---|---|---|---|
| ||||
{ "count": { "totalItems": 1 }, "credential": [ { "id": "AAABcID5GBc=40b305ea-77e1-4874-aa28-964b1cf4a1a8", "type": "filesystem", "description": "Sales HD1 credentials" }, { xxxx", "throttlePolicy": "10653921-1b27-40b5-9d7a-f54ef1e3ad01", "properties": { "iddomain": "AAABcIueWUc=xxxx", "typeuser": "filesystemxxxx", "descriptionpassword": "Sales HD2 credentials""xxxx" } } ] } |
: 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
| ||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||
200 | Success | |||||||||||||||||||||
404 | The given credentials id was not found |
Section | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Addcredentialcredential(s)Add one or more Adds credentials to Aspire, this endpoint need the ADMINISTRATOR role to be executed.
Request Body Parameters
Examples
ExampleAdd a single credential
Add multiple credentials
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 one or more credentials in Aspire, this endpoint needs the ADMINISTRATOR role to be executed.
Path and Request Body Parameters
Other parameters passed in the request body will depend on the type of credential being created - see Add credential(s) above Examples
x - at least one field must be present Update a single credentialExample - update more credentials
Update multiple credentials
Response
Status: 200, 404, 406
Status Response
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | Not found - a given credential identifier was not found |
Status: 200, 406 |
Section | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete credential(s)Delete one or more credentials connectors from Aspire, this endpoint need the ADMINISTRATOR role to be executed.
Path Parameters and Request Body ParametersQuery parameters
Examples Body Parameter
ExamplesDelete a single credential
Delete multiple 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 | ||||||||||||||||||||||||||||||||||||||||||
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
|
Section | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Export credentials(s)Export one or more credential from Aspire, this endpoint needs at least the OPERATOR role to be executed. Get credential type dxfReturns the dxf for a specific credential type
Path Parameters and Query parameters
Body ParameterQuery String Parameters
Examples
Response
Status | |||||||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||||||
200 | Success | 404 | Not found - a given service identifier was not found
"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:
|