POST /aspire/_api/credentials
{
    "type": "filesystem",
    "description": "Europe Net Appliancexxxx",
  ...
}

{
    "credential": [
        {
            "id": "AAABcID5GBc=43d1a498-c672-46b7-902f-082222122481",
            "type": "filesystem",
            "description": "Europe Net Appliance"
xxxx",
            "properties": {
      ...
   },
   {
    "iddomain": "AAABcIueWUc=xxxx",
                "typeuser": "sharepointxxxx",
          "description      "password": "SP Onlinexxxx"
           ...
 }
        }],
  "message": "optional response message" ]
}

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.

Request Body Parameters

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

x - at least one field must be present

Example - update more credentials

PUT /aspire/_api/credentials
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "typethrottlePolicy": "filesystem10653921-1b27-40b5-9d7a-f54ef1e3ad01"
  "description},
  "AAABcID5GBd=": "Europe Net Appliance"{
  ...
}

Update multiple credentials

[{
  "id": "AAABcID5GBcAAABcID5GBd=",
    "typeproperties": "filesystem"{
       "descriptiondomain": "Europexxxx",
  Net Appliance"
  ...
},
{
  "iduser": "AAABcIueWUc=xxxx",
       "typepassword": "sharepointxxxx"
  "description": "SP Online"}
  ...}
}]

Response

{
  "credential": [{
    "updated":true,"id": "AAABcID5GBc="},{"updated":true,"id":"AAABcID5GBd="}]}

Status: 200, 404, 406

{
  

"

update" : 

{
    "description" : "

DESCRIPTION",
   

"

throttlePolicy" : "

THROTTLE_POLICY_ID",
    "

properties": 

{
      "

user": "

true",
      .....
    }
  

}
}

{
  "message": "

update result response message"
}

: 200, 406

Delete credential(s)

Delete one or more credentials connectors from Aspire, this endpoint need the ADMINISTRATOR role to be executed.

Path Parameters and Query parametersQuery String, Path and Request Body Parameters

Examples

Body Parameter

ExamplesDelete a single credential

DELETE /aspire/_api/credentials/AAABcID5GBc

DELETE /aspire/_api/credentials?id=AAABcID5GBc&id=AAABcID5GBd

POST /aspire/_api/credentials/delete
{
  "idids": ["AAABcID5GBc=","AAABcID5GBd"]
}

Delete multiple credentialsResponse

[{
  "idmessage": "AAABcID5GBc=delete result response message"
},

Status: 200, 404, 406

{
  "

message": "

Delete multiple credentials (alternative form)

delete result response message"
}

export": {
    "credentials": {
      "credential": [
        {
          "id": "<credential_id>",
          "type": "rest-api",
          "description": "REST",
          "properties": {
            "type": "bearer",
            "query": {
              ...
            }
          }
        },
		...
      ]
    }
  }
}