The credentials API provides functionality that allows a administrator to add, delete or update credentials
Lists all the credentials configured in the Aspire
GET /aspire/_api/credentials
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 |
Response
{ "credential": [{ "id": "AAABcID5GBc=", "type": "filesystem", "description": "Sales HD1 credentials" }, { "id": "AAABcIueWUc=", "type": "filesystem", "description": "Sales HD2 credentials" }] }
Status
Response code | Description |
---|---|
200 | Success |
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" } }
Status
Response code | Description |
---|---|
200 | Success |
404 | The given credentials id was not found |
Add one or more credentials to Aspire
POST /aspire/_api/credentials
Request Body Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Required | The type of credential to add |
description | string | Required | An optional description of the credential |
Examples
Add a single credential
POST /aspire/_api/credentials { "type": "filesystem" "description": "Europe Net Appliance" }
Add multiple credentials
POST /aspire/_api/credentials [{ "type": "filesystem" "description": "Europe Net Appliance" "username": "admin" }, { "type": "sharepoint" "description": "SP Online" "username": "admin" }]
Response
{ "credential": [{ "id": "AAABcID5GBc=", "type": "filesystem" "description": "Europe Net Appliance" }, { "id": "AAABcIueWUc=", "type": "sharepoint" "description": "SP Online" }] }
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 |
---|---|
201 | Created |
406 | Not acceptable - there was an issue validating the input |
Update one or more credentials in Aspire.
PUT /aspire/_api/credentials/:id
PUT /aspire/_api/credentials
Path and Request 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
Examples
Update a single credential
PUT /aspire/_api/credentials/AAABcID5GBc%3D { "id": "AAABcID5GBc=", "type": "filesystem" "description": "Europe Net Appliance" }
Update multiple 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" }, { "id": "AAABcIueWUc=", "type": "sharepoint" "description": "SP Online" }] }
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 |
Delete one or more credentials from Aspire.
DELETE /aspire/_api/credentials/:id
DELETE /aspire/_api/credentials
Path and Request Body Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier(s) of the credential(s) to delete |
Examples
Delete a single credential
DELETE /aspire/_api/credentials/AAABcID5GBc=
Delete multiple credentials
DELETE /aspire/_api/credentials { "id": [ "AAABcID5GBc=", "AAABcIueWUc=" ] }
Response
{ "message": "optional response message" }
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 |