The credential API provides functionality that allows a administrator to add, delete or update credentials
Lists all the credentials configured in the Aspire
GET /aspire_api/credential
Query String Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Optional | Filter returned seeds to only those with the given type |
description | string | Optional | Filter returned seeds to only those whose description matches the given expression |
Response
{ "credential": [{ "id": "AAABcID5GBc=", "type": "filesystem", ... }, { "id": "AAABcIueWUc=", "type": "filesystem", ... }], "message": "optional response message" }
Status
Response code | Description |
---|---|
200 | Success |
Get information about a single credential configured in Aspire
GET /aspire_api/credential?id=:id
GET /aspire_api/credential/:id
Query String and Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The id of the credential to return |
Response
{ "credential": { "id": "AAABcID5GBc=", "type": "filesystem", ... }, "message": "optional response message" }
Status
Response code | Description |
---|---|
200 | Success |
404 | The given seed id was not found |
Add one or more credentials to Aspire
POST /aspire_api/credential
Request Body Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Required | The type of connector to use for this seed (may be omitted if connector is specified) |
description | string | Optional | An optional description of the seed |
Other parameters passed in the request body will depend on the type of credential being created - those required by Documentum will be different from those required by SharePoint. Some candidates are shown below
Name | Description |
---|---|
domain | An Active Directory/LDAP domain |
username | A username |
password | A password |
A user email address | |
APIkey | An API key |
token | an access token |
Examples
Add a single credential
{ "type": "filesystem" "description": "Europe Net Appliance" ... }
Add multiple credentials
[{ "type": "filesystem" "description": "Europe Net Appliance" ... }, { "type": "sharepoint" "description": "SP Online" ... }]
Response
{ "credential": [{ "id": "AAABcID5GBc=", "type": "filesystem" "description": "Europe Net Appliance" ... }, { "id": "AAABcIueWUc=", "type": "sharepoint" "description": "SP Online" ... }], "message": "optional response message" }
Status
Response code | Description |
---|---|
201 | Created |
406 | Not acceptable - there was an issue validating the input |
Update one or more credentials in Aspire. Updates will be treated as partial updates rather than overwrites. If a field is not present in the input, any previous value will remain after the update. If you wish to "delete" a value, pass a value of null
PUT /aspire_api/credential
Request Body Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the seed to update |
type | string | Required | The type of connector to use for this seed (may be omitted if connector is specified) |
description | string | Optional | An optional description of the seed |
Other parameters passed in the request body will depend on the type of credential being created - see Credential API above
Examples
Update a single credential
{ "id": "AAABcID5GBc=", "type": "filesystem" "description": "Europe Net Appliance" ... }
Update multiple credentials
[{ "id": "AAABcID5GBc=", "type": "filesystem" "description": "Europe Net Appliance" ... }, { "id": "AAABcIueWUc=", "type": "sharepoint" "description": "SP Online" ... }]
Response
{ "credential": [{ "id": "AAABcID5GBc=", "type": "filesystem" "description": "Europe Net Appliance" ... }, { "id": "AAABcIueWUc=", "type": "sharepoint" "description": "SP Online" ... }], "message": "optional response message" }
Status
Response code | Description |
---|---|
201 | Created |
404 | Not found - a given seed identifier was not found |
406 | Not acceptable - there was an issue validating the input |
Delete one or more credentials from Aspire.
DELETE /aspire_api/credential?id=:id
DELETE /aspire_api/credential/:id
DELETE /aspire_api/credential
Query String, 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
{ "id": "AAABcID5GBc=" }
Delete multiple seeds
[{ "id": "AAABcID5GBc=" }, { "id": "AAABcIueWUc=" }]
Delete multiple credentials (alternative form)
{ "id": ["AAABcID5GBc=", "AAABcIueWUc="] }
Response
{ "message": "optional response message" }
Status
Response code | Description |
---|---|
200 | Success |
404 | Not found - a given seed identifier was not found |
406 | Not acceptable - there was an issue validating the input |
Gets the DXF for a credential.
GET /aspire_api/credential/dxf?type=:type
GET /aspire_api/credential/dxf/:type
Query String, Path and Request Body Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Required | The type of the credential to get the DXF for |
Response
{ "dxf": {...} "message": "optional response message" }
Status
Response code | Description |
---|---|
200 | Success |
404 | Not found - a given service identifier was not found |
406 | Not acceptable - there was an issue validating the input |