The credentials API provides functionality that allows a administrator to add, delete or update credentials

toc

Easy Heading Free

navigationTitle	On this Page
navigationExpandOption	expand-all-by-default

Section

Get all credentials

Lists all the credentials configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/credentials

Pagination query string parameters

Sorting query string parameters

Section

Get all credentials, filtered

Lists credentials configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/credentials/getAll

Pagination query string parameters

Sorting query string parameters

Filters: The credential filter definition here Common filter

Response

Code Block

language	js
theme	RDark

{
    "count": {
        "totalItems": 1
    },
    "credential": [
        {
            "id": "AAABcID5GBc=40b305ea-77e1-4874-aa28-964b1cf4a1a8",
            "type": "filesystem",
            "description": "Sales HD1 credentials",
	"xxxx",
            "throttlePolicy": "10653921-1b27-40b5-9d7a-f54ef1e3ad01",
            "properties": {
 This will be a dynamic JSON object } 
  },
  {
    "iddomain": "AAABcIueWUc=xxxx",
         "type       "user": "filesystemxxxx",
    "description            "password": "xxxx"Sales
  HD2 credentials",
	"properties": { This will be a dynamic JSON object }
        }
    }]
}

Status: 200

Section

Get a single credential

Get information about a single credential configured in Aspire, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/credentials/:id

Path Parameters

Name	Type	Required	Description
id	string	Required	The id of the credential to return

Response

Code Block

language	js
theme	RDark

{
    "credential": {
        "id": "AAABcID5GBc=40b305ea-77e1-4874-aa28-964b1cf4a1a8",
        "type": "filesystem",
        "description": "Filesystem credentials",
	"xxxx",
        "throttlePolicy": "10653921-1b27-40b5-9d7a-f54ef1e3ad01",
        "properties": { This will be a dynamic JSON object }  

            "domain": "xxxx",
            "user": "xxxx",
            "password": "xxxx"
        }
    }
}

Status: 200, 404

Section

Add credential(s)

Adds credentials to Aspire, this endpoint need the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/credentials

Body Parameters

Name	Type	Required	Description
type	string	Required	The type of credential to add
description	string	Required	An optional description of the credential
throttlePolicy	string	Optional	The throttle policy id
properties	string	Required	Credential properties

Example

Code Block

language	js
theme	RDark

POST /aspire/_api/credentials
[{
    "type": "filesystem",
    "description": "Europe Net Appliancexxxx",
    "properties": {
 This will be a dynamic JSON object } 
},
{
  "typedomain": "sharepointxxxx",
        "descriptionuser": "SP Onlinexxxx",
  "properties": { This will be a dynamic JSON object } 
}]      "password": "xxxx"
    }
}

Response

Code Block

language	js
theme	RDark

{
    "credential": [
        {
            "id": "AAABcID5GBc=43d1a498-c672-46b7-902f-082222122481",
            "type": "filesystem",
            "description": "Europe Net Appliancexxxx",
    "created": 1596707252548,
       "updated": 1596707252548,
	"properties": {
 This will be a dynamic JSON object }  
   },
   {
    "iddomain": "AAABcIueWUc=xxxx",
    "type            "user": "sharepointxxxx",
    "description": "SP Online",
       "created": 1596707252548,
    "updatedpassword": 1596707252548,
	"properties": { This will be a dynamic JSON object }  
  }xxxx"
            }
        }
    ]
}

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

Status: 201, 406

Section

Update credential(s)

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

note

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/credentials/:id

PUT /aspire/_api/credentials

The existing document will be replaced by the new one provided in the body

Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the credential to update	...
description	string	x	The description of the credential
properties	object	x	Credential properties
throttlePolicy	string	x	The throttle policy id

x - at least one field must be present+ fields from "Add" section...

Example - update more credentials

Code Block

language	js
theme	RDark

PUT /aspire/_api/credentials
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "typethrottlePolicy": "filesystem10653921-1b27-40b5-9d7a-f54ef1e3ad01"
  },
  "descriptionAAABcID5GBd=": {
    "Europe Net Appliance"id": "AAABcID5GBd=",
  },
  "AAABcIueWUc=properties": {
       "iddomain": "AAABcIueWUc=xxxx",
       "typeuser": "sharepointxxxx",
       "descriptionpassword": "SP Online"xxxx"
    }
  }
}

Response

Code Block

language	js
theme	RDark

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

Status: 200, 404, 406

Section

Update credentials, filtered

Update 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

theme	RDark

{
  "update" : {
    "description" : "DESCRIPTION",
    "throttlePolicy" : "THROTTLE_POLICY_ID",
    "

type

properties":

"sharepoint"

{
      "

description

user": "

SP Online

true",

"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

Response

Code Block

language	js
theme	RDark

{
  "message": "update result response message"
}

Status: 200,

404,

406

Section

Delete credential(s)

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

Update credentials, filtered

Update credentials configured in the Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/credentials/:id

DELETE /aspire/_api/credentials

POST /aspire/_api/credentials/updateAll

Common filter

Update body parameter

delete

Path Parameters and Query parameters

Name	Type	Required	Description
id	string	Required	The identifier(s) of the credential(s) to delete

Body Parameter

Name	Type	Required	Description
ids	string	Required	The identifier(s) of the credential(s) to delete

Examples

Code Block

language	js
theme	RDark

DELETE /aspire/_api/credentials/AAABcID5GBc

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

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

Response

Code Block

language	js
theme	RDark

{
  "message": "updatedelete result response message"
}

Status: 200, 404, 406

Section

Delete multiple credentials, filtered

Delete multiple credentials from Aspire, filtered by a specified criteria, this endpoint need the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/credentials/deleteAll

Common filter

Filters: The credential filter definition here

Response

Code Block

language	js
theme	RDark

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

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

Status: 200

Section

Delete credential

Export credentials(s)

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

Panel

borderColor	black
bgColor	#fafafb

DELETE GET /aspire/_api/credentials/:idexport

DELETE GET /aspire/_api/credentials/export/:id

POST /aspire/_api/credentials/deleteexportAll

Info

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

Image AddedImage Added

Note
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.

Note
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.

Path Parameters and Query parameters

Name	Type	Required	Description
id	string	Required	The identifier(s) of the credential(s) to deleteexport

Body Parameter

Name	Type	Required	Description
ids	string	Required	The identifier(s) of the credential(s) to deleteexport

Examples

Code Block

language	js
theme	RDark

GETDELETE /aspire/_api/credentials/export/AAABcID5GBc

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

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

Response

Code Block

language	js
theme	RDark

{
  "export": {
    "credentials": {
      "credential": [
        {
          "id": "<credential_id>",
          "type": "rest-api",
          "description": "REST",
          "properties": {
   "message         "type": "delete result response message"
}

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

"bearer",
            "query": {
              ...
            }
          }
        },
		...
      ]
    }
  }
}

Status: 200, 404, 406

Section

Get credential type dxf (TODO)

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.

Returns the dxf for a specific credential type

Panel

borderColor	black
bgColor	#fafafb

GET

POST /aspire/_api/credentials/

type/:typeId/dxf

Path Parameters

exportAll

Filters: The connection filter definition here

Response

Code Block

language	js
theme	RDark

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

Status: 200

Section

Import

The import usage can be found here

Response

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

Credential filter:

Name

Type

Required

Description

typeId

string

Required

The id of the type for which dxf is going to be retrieved

Code Block

language	js
theme	RDark

{ 
 "filter" "dxf": {...}
  "message": "optional response message"
}

Status: 200, 404

: {
    "ids" : ["ID1", "ID2", "ID3", ...],
    "type" : "TYPE",
    "description" : "DESCRIPTION",
	"throttlePolicy" : "THROTTLE_POLICY_ID"
  }
}

Page tree

Versions Compared

Old Version 49

New Version Current

Key

Get all credentials

Get all credentials, filtered

Get a single credential

Add credential(s)

Update credential(s)

Update credentials, filtered

Delete credential(s)

Update credentials, filtered

Delete multiple credentials, filtered

Export credentials(s)

Get credential type dxf (TODO)

Export multiple credentials, filtered

Import

Filters
Anchor
FiltersAnchor
FiltersAnchor

Page tree

Page History

Versions Compared

Old Version 49

New Version Current

Key

Get all credentials

Get all credentials, filtered

Get a single credential

Add credential(s)

Update credential(s)

Update credentials, filtered

Delete credential(s)

Update credentials, filtered

Delete multiple credentials, filtered

Export credentials(s)

Get credential type dxf (TODO)

Export multiple credentials, filtered

Import

Filters AnchorFiltersAnchorFiltersAnchor

Filters
Anchor
FiltersAnchor
FiltersAnchor