The credentials API provides functionality that allows a administrator to add, delete or update credentials
Get all credentials
Lists all the credentials configured in the Aspire
GET /aspire/_api/credentials
Pagination query string parameters
Get all credentials, filtered
Lists credentials configured in the Aspire, filtered by a specified criteria
Response
{
"credential": [{
"id": "AAABcID5GBc=",
"type": "filesystem",
"description": "Sales HD1 credentials",
"properties": { This will be a dynamic JSON object }
},
{
"id": "AAABcIueWUc=",
"type": "filesystem",
"description": "Sales HD2 credentials",
"properties": { This will be a dynamic JSON object }
}]
}
Status: 200
Get a single credential
Get information about a single credential configured in Aspire
GET /aspire/_api/credentials/:id
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | The id of the credential to return |
Response
{
"credential": {
"id": "AAABcID5GBc=",
"type": "filesystem",
"description": "Filesystem credentials",
"properties": { This will be a dynamic JSON object }
}
}
Status: 200, 404
Add credential(s)
Adds credentials to Aspire
POST /aspire/_api/credentials
Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| type | string | Required | The type of credential to add |
| description | string | Required | An optional description of the credential |
| properties | string | Required | Credential properties |
Example
POST /aspire/_api/credentials
[{
"type": "filesystem"
"description": "Europe Net Appliance",
"properties": { This will be a dynamic JSON object }
},
{
"type": "sharepoint"
"description": "SP Online",
"properties": { This will be a dynamic JSON object }
}]
Response
{
"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: 201, 406
Update credential(s)
Update credentials in Aspire.
PUT /aspire/_api/credentials/:id
PUT /aspire/_api/credentials
The existing document will be replaced by the new one provided in the body
Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | The identifier of the credential to update |
| ... |
+ fields from "Add" section...
Example - update more credentials
PUT /aspire/_api/credentials
{
"AAABcID5GBc=": {
"id": "AAABcID5GBc=",
"type": "filesystem"
"description": "Europe Net Appliance"
},
"AAABcIueWUc=": {
"id": "AAABcIueWUc=",
"type": "sharepoint"
"description": "SP Online"
}
}
Response
{
"credential": [{
"id": "AAABcID5GBc=",
"type": "filesystem"
"description": "Europe Net Appliance",
"properties": { This will be a dynamic JSON object }
},
{
"id": "AAABcIueWUc=",
"type": "sharepoint"
"description": "SP Online",
"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: 200, 404, 406
Update credentials, filtered
Update credentials configured in the Aspire, filtered by a specified criteria
POST /aspire/_api/credentials/updateAll
Response
{
"message": "update result response message"
}
Status: 200, 406
Delete multiple credentials, filtered
Delete multiple credentials from Aspire, filtered by a specified criteria
POST /aspire/_api/credentials/deleteAll
Response
{
"message": "delete result response message"
}
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors
Status: 200
Delete credential(s)
Delete one or more connectors from Aspire.
DELETE /aspire/_api/credentials/:id
DELETE /aspire/_api/credentials
POST /aspire/_api/credentials/delete
Path Parameters and Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | The identifier(s) of the credential(s) to delete |
Body Parameter
| Name | Type | Required | Description |
|---|---|---|---|
| ids | string | Required | The identifier(s) of the credential(s) to delete |
Examples
DELETE /aspire/_api/credentials/AAABcID5GBc
DELETE /aspire/_api/credentials?id=AAABcID5GBc&id=AAABcID5GBd
POST /aspire/_api/credentials/delete
{
"ids":["AAABcID5GBc","AAABcID5GBd"]
}
Response
{
"message": "delete result response message"
}
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
Get credential type dxf (TODO)
Returns the dxf for a specific credential type
GET /aspire/_api/credentials/type/:typeId/dxf
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| typeId | string | Required | The id of the type for which dxf is going to be retrieved |
Response
{
"dxf": {...}
"message": "optional response message"
}
Status: 200, 404
Overview
Content Tools
Copyright © 2024 Accenture
