Warning | ||
---|---|---|
| ||
This page is in development and as such, its contents may be incorrect |
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", ... }, { "id": "AAABcIueWUc=", "type": "filesystem", ... }] } |
Status
"description": "xxxx",
"throttlePolicy": "10653921-1b27-40b5-9d7a-f54ef1e3ad01",
"properties": {
"domain": "xxxx",
"user": "xxxx",
"password": "xxxx"
}
}
]
} |
Status: 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
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 |
throttlePolicy | string | Optional | The throttle policy id |
properties | string | Required | Credential properties |
Example
Examples
Add a single credential
Code Block | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/credentials { "type": "filesystem", "description": "Europe Net Appliance" ... } |
Add multiple credentials
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/credentials [{ "typexxxx", "properties": { "domain": "filesystemxxxx", "description": "Europe Net Appliance" ... }, { "typeuser": "sharepointxxxx", "descriptionpassword": "SP Onlinexxxx" ... } }] |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "credential": [ { "id": "AAABcID5GBc=43d1a498-c672-46b7-902f-082222122481", "type": "filesystem", "description": "Europe Net Appliance"xxxx", "properties": { ... }, { "iddomain": "AAABcIueWUc=xxxx", "typeuser": "sharepointxxxx", "descriptionpassword": "SP Onlinexxxx" ... } } ] } |
See Response Body for details regrading regarding the response body returned where multiple items are affected with some (or all) returning errors
: 201, 406
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update credential(s)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, 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 Update a single credential
x - at least one field must be present Example - update more credentials
Update multiple credentials
Response
Status: 200, 404, 406
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
Response
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.
Path Parameters and Query parameters
Body Parameter
Examples
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
"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:
|