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

Pagination query string parameters

Sorting query string parameters

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

Query String Parameters

Name Type Required Description

from integer Optional Indicates the initial page to be retrieved

size integer Optional Specifies the size of results page

sortBy string Optional Field by which results are sorted

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

sortModestringOptional

Sort mode

"asc" for ascending sort,

"desc" for descending sort

Response

Code Block

language	js
theme	RDark

{
    "credentialcount": [{
    "id": "AAABcID5GBc=",
    "typetotalItems": "filesystem",1
    "description": "Sales HD1 credentials"},
    "createdcredential": 1596707252548,[
    "updated": 1596707252548,
	"properties": { This will be a{
 dynamic JSON object } 
  },
  {
    "id": "AAABcIueWUc=40b305ea-77e1-4874-aa28-964b1cf4a1a8",
            "type": "filesystem",
    "description": "Sales HD2 credentials",
        "createddescription": 1596707252548,
    "updatedxxxx": 1596707252548,
	"properties": { This will be a dynamic JSON object }  
  }]
}

Status

Response codeDescription200Success Section

Get all credentials, filtered

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

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/credentials/getAll

Query String Parameters

NameTypeRequiredDescriptionfromintegerOptionalIndicates the initial page to be retrievedsizeintegerOptionalSpecifies the size of results pagesortBystringOptionalField by which results are sortedsortModestringOptional

Sort mode

"asc" for ascending sort,
"desc" for descending sort

Body Parameters

NameTypeRequiredDescriptionfilterJSONRequiredFilters retrieved credentials. Check the filter definition here

Response

Code Block

language	js

{
  "credential": [{
    "id": "AAABcID5GBc=",
"throttlePolicy": "10653921-1b27-40b5-9d7a-f54ef1e3ad01",
            "typeproperties": "filesystem",{
    "description": "Sales HD1 credentials",
    "created": 1596707252548,
    "updateddomain": 1596707252548"xxxx",
	"properties": { This will be a dynamic JSON object } 
  },
  {
    "iduser": "AAABcIueWUc=xxxx",
     "type": "filesystem",
           "descriptionpassword": "xxxx"Sales
 HD2 credentials",
    "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object }  
  } }
        }
    ]
}

Status

Response codeDescription200Success

: 200

: 200, 404

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

Query String 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": {
     "created       "domain": 1596707252548"xxxx",
            "updateduser": 1596707252548"xxxx",
	"properties            "password": {"xxxx"
 This will be a dynamic JSON object }
   
 }
}

Status

Response code Description

200 Success

404 The given credentials id was not found

: 201, 406

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": "Europexxxx",
 Net Appliance"
  "usernameproperties": "admin"
},
{
  "type      "domain": "sharepointxxxx",
        "descriptionuser": "SP Onlinexxxx",
        "usernamepassword": "admin"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

Response code Description

201 Created

406 Not acceptable - there was an issue validating the input

Not acceptable - there was an issue validating the input

Section

Update credential(s)

Update 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

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

x	The throttle policy id

x - at least one field must be present

ExampleExample - 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="},{"updated":true,"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

type

update" :

"filesystem"

{
    "description" : "

Europe Net Appliance

DESCRIPTION",
    "

created

throttlePolicy" :

1596707252548

"THROTTLE_POLICY_ID",
    "

updated

properties":

1596707252548, "properties

{
      "user":

{

"true",

This

will

be

a

dynamic JSON object }

 .....
    }

,

Response

Code Block

language	js
theme	RDark

id

message": "

AAABcIueWUc=",

update result response

"type": "sharepoint" "description": "SP Online", "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

Response code Description

200 Success

404 Not found - a given credential identifier was not found

406

message"
}

Status: 200, 406

Filters retrieved credentials. Check the filter definition

Section

Delete credential(s)

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

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/credentials/:id

DELETE /aspire/_api/credentials

POST /aspire/_api/credentials/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": "delete 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

Body Parameters

Name Type Required Description

filter JSON Required

Filters: The credential filter definition here

Response

Code Block

language	js
theme	RDark

{
  "message": "

optional

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

Response codeDescription200Success404Not found - a given credential identifier was not found406Not acceptable - there was an issue validating the input Section

Status: 200

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

Section

Export credentials(s)

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

Delete single credential

Delete a credentials from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/credentials/export

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

POST /aspire/_api/credentials/exportAll

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 String Parametersparameters

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 export

ExamplesExample

Code Block

language	js
theme	RDark

GET /aspire/_api/credentials/export/AAABcID5GBc

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

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

Response

Code Block

language	js
theme	RDark

{
  "export": {
    "credentials": {
      "credential": [
        {
   "message": "optional response message"
}

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

Section

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

Status: 200, 404, 406

Section

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.

Get credential type dxf

Returns the dxf for a specific credential type

Panel

borderColor	black
bgColor	#fafafb

GET

POST /aspire/_api/credentials/

type/:typeId/dxf

Query String Parameters

exportAll

Filters: The connection filter definition here

Name Type Required Description

typeId string Required

Response

Code Block

language	js
theme	RDark

{
  "export": {

"dxf

"credentials": {
      "credential": [
        {
          "id": "<credential_id>",
          "type": "rest-api",
          "description": "REST",
          "properties": {

...}

message

type":

"optional response message" }

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

Status: 200

Not found - a given service identifier was not found

Section
Import The import usage can be found here Status
Response code	Description
200	Success
404

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

Some endpoint queries require a filter. A filter is basically a JSON object with the following format:

Credentials filterCredential filter:

Code Block

language	js
theme	RDark

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

Note

When using delete endpoints, ids in the filter are mandatory.

Page tree

Versions Compared

Old Version 38

New Version Current

Key

Get all credentials

Get all credentials, filtered

Get all credentials, filtered

Get a single credential

Add credential(s)

Update credential(s)

Update credentials, filtered

Delete credential(s)

Delete multiple credentials, filtered

Export credentials(s)

Delete single credential

Export multiple credentials, filtered

Get credential type dxf

Import

Filters
Anchor
FiltersAnchor
FiltersAnchor

Page tree

Page History

Versions Compared

Old Version 38

New Version Current

Key

Get all credentials

Get all credentials, filtered

Get all credentials, filtered

Get a single credential

Add credential(s)

Update credential(s)

Update credentials, filtered

Delete credential(s)

Delete multiple credentials, filtered

Export credentials(s)

Delete single credential

Export multiple credentials, filtered

Get credential type dxf

Import

Filters AnchorFiltersAnchorFiltersAnchor

Filters
Anchor
FiltersAnchor
FiltersAnchor