Update credential(s)

Update credentials in Aspire, this endpoint needs the ADMINISTRATOR role to be executed.

Add single credential

Add a credential to Aspire

Body Parameters

x - at least one field must be present

Example - update more credentials

PUTPOST /aspire/_api/credentials
{
  "typeAAABcID5GBc=": "filesystem"{
    "descriptionid": "Europe Net Appliance"
}

Response

{AAABcID5GBc=",
    "throttlePolicy": "10653921-1b27-40b5-9d7a-f54ef1e3ad01"
  },
  "credentialAAABcID5GBd=": [{
    "id": "AAABcID5GBcAAABcID5GBd=",
    "typeproperties": "filesystem"
{
       "descriptiondomain": "Europe Net Appliance"xxxx",
       "createduser": 1596707252548"xxxx",
       "updatedpassword": 1596707252548,
	"properties": { This will be a dynamic JSON object }  
 xxxx"
    }
  }]
}

See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors

Status

Response

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

Status: 200, 404, 406

Update multiple credentials

Update multiple credentials in Aspire.

Body Parameters

Delete credential(s)

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

Path Parameters and Query parameters

Body Parameter

Examples

DELETE /aspire/_api/credentials/AAABcID5GBc

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

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

Response

{
  "message": "delete result response message"
}

Status: 200, 404, 406

Update single credential

Query String Parameters

Export credentials(s)

Export one or more credential from Aspire, this endpoint needs at least the OPERATOR role to be executed.

Response

{
  "credential": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem"
    "description": "Europe Net Appliance",
    "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object }  
   }]
}

See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors

Status

Every configuration item has the option to export from the UI, using the single menu or by the bulk actions:

Image AddedImage Added

Something important that you need to know is that when you export a config item that depends on another, the export will contain also all the dependencies.

Take into consideration that components with resources loaded into elastic, will be exported, but the resource itself will not, so you will need to reupload the resource and go and select your resource in the component again.

GET /aspire/_api/credentials/export/AAABcID5GBc

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

POST /aspire/_api/credentials/export
{
  "ids":["AAABcID5GBc","AAABcID5GBd"]
}

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

Export multiple credentials, filtered

Export 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

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

Status: 200

Import

The import usage can be found here

Filters

Anchor
FiltersAnchor FiltersAnchor

Credential filter:

{