Update credential(s)Update one or more credentials in Aspire, this endpoint needs the ADMINISTRATOR role to be executed. Panel |
---|
borderColor | black |
---|
bgColor | #fafafb |
---|
| 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 | typedescription | string | Optionalx | The type description of the credential | properties | object | x | Credential properties | throttlePolicydescription | 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 x - at least one field must be present Example - update more credentials
Code Block |
---|
| PUT /aspire/_api/credentials/AAABcID5GBc%3D
{
"idAAABcID5GBc=": "AAABcID5GBc=",{
"typeid": "filesystemAAABcID5GBc=",
"descriptionthrottlePolicy": "Europe Net Appliance"
} |
Update multiple credentials Code Block |
---|
| PUT /aspire/_api/credentials
{
"AAABcID5GBc10653921-1b27-40b5-9d7a-f54ef1e3ad01"
},
"AAABcID5GBd=": {
"id": "AAABcID5GBcAAABcID5GBd=",
"typeproperties": "filesystem"{
"descriptiondomain": "Europe Net Appliance"
}xxxx",
"AAABcIueWUc=": {
"iduser": "AAABcIueWUc=xxxx",
"typepassword": "sharepointxxxx"
"description": "SP Online"}
}
} |
Response Code Block |
---|
| {{
"credential": [{
"updated":true,"id": "AAABcID5GBc="},
"type{"updated": true,"filesystem"
"description": "Europe Net Appliance",
"created": 1596707252548,id":"AAABcID5GBd="}]} |
Status: 200, 404, 406
Section |
---|
Update credentials, filteredUpdate credentials configured in the Aspire, filtered by a specified criteria, this endpoint needs the ADMINISTRATOR role to be executed. Panel |
---|
borderColor | black |
---|
bgColor | #fafafb |
---|
| PUT /aspire/_api/credentials/updateAll
|
Filters: The credential filter definition here Update body parameter Code Block |
---|
| {
"update" : {
" | updated1596707252548,
properties": { This will be a dynamic JSON object }
},
{idAAABcIueWUc=type"sharepoint"descriptionSP Online"created":1596707252548,
"updated": 1596707252548,
"properties": { This will be a dynamic JSON object } ] | See Body for details regrading the response body returned where multiple items are affected with some (or all) returning errorsStatus Response Description200Success |