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
Query String Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get all credentials, filteredLists credentials configured in the Aspire, filtered by a specified criteria
Query String Parameters
Body Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single credentialGet information about a single credential configured in Aspire
Query String Parameters
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add multiple credentialsAdds multiple credentials to Aspire
Body Parameters
Example
Response
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors Status
|
Section |
---|
Panel | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/credentials |
Body Parameters
Example
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/credentials
{
"type": "filesystem"
"description": "Europe Net Appliance"
} |
Response
Code Block | ||
---|---|---|
| ||
{
"credential": [{
"id": "AAABcID5GBc=",
"type": "filesystem"
"description": "Europe Net Appliance",
"created": 1596707252548,
"updated": 1596707252548,
"properties": { This will be a dynamic JSON object }
}]
} |
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors
Status
Update multiple credentials in Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the credential to update |
type | string | Optional | The type of credential |
description | string | Optional | An optional description of the credential |
Other parameters passed in the request body will depend on the type of credential being created - see Add credential(s) above
Example
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/credentials { "AAABcID5GBc=": { "id": "AAABcID5GBc=", "type": "filesystem" "description": "Europe Net Appliance" }, "AAABcIueWUc=": { "id": "AAABcIueWUc=", "type": "sharepoint" "description": "SP Online" } } |
Response
Code Block | ||
---|---|---|
| ||
{ "credential": [{ "id": "AAABcID5GBc=", "type": "filesystem" "description": "Europe Net Appliance", "created": 1596707252548, "updated": 1596707252548, "properties": { This will be a dynamic JSON object } }, { "id": "AAABcIueWUc=", "type": "sharepoint" "description": "SP Online", "created": 1596707252548, "updated": 1596707252548, "properties": { This will be a dynamic JSON object } }] } |
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors
Status
Update a credential in Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Query String Parameters
Body Parameters
Other parameters passed in the request body will depend on the type of credential being created - see Add credential(s) above
Example
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/credentials/AAABcID5GBc%3D
{
"id": "AAABcID5GBc=",
"type": "filesystem"
"description": "Europe Net Appliance"
} |
Response
Code Block | ||
---|---|---|
| ||
{
"credential": [{
"id": "AAABcID5GBc=",
"type": "filesystem"
"description": "Europe Net Appliance",
"created": 1596707252548,
"updated": 1596707252548,
"properties": { This will be a dynamic JSON object }
}]
} |
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 | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete multiple credentials, filteredDelete multiple credentials from Aspire, filtered by a specified criteria
Body Parameters
Response
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors Status
|
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete single credentialDelete a credentials from Aspire.
Query String Parameters
Example
Response
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors Status
|
Section | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get credential type dxfReturns the dxf for a specific credential type
Query String Parameters
Response
Status
|
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Credentials filter:
|