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

Query String Parameters

Name Type Required Description

type string Optional Filter returned credentials to only those with the given type

description string Optional Filter returned credentials to only those whose description matches the given expression

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

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": {
                "iddomain": "AAABcIueWUc=xxxx",
                "typeuser": "filesystemxxxx",
                "descriptionpassword": "Sales HD2 credentials",
xxxx"
            }
        ...}
  }  ]
}

Status

Response codeDescription200Success

: 200

The given credentials id was not found

: 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

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": "xxxx",
        "throttlePolicy": "Filesystem credentials",
    ...
 "10653921-1b27-40b5-9d7a-f54ef1e3ad01",
        "properties": {
            "domain": "xxxx",
            "user": "xxxx",
            "password": "xxxx"
        }
    }
}

Status

Response code Description

200 Success

404

Not acceptable - there was an issue validating the input

: 201, 406

Section

Add

credential

credential(s)

Add one or more Adds credentials to Aspire, this endpoint need the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/credentials

Request Body Parameters

Name	Type	Required	Description
type	string	Required	The type of credential to add
description	string	OptionalRequired	An optional description of the credential

Other parameters passed in the request body will depend on the type of credential being created - those required by Documentum will be different from those required by SharePoint. Some candidates are shown below

username

Name	Type	Required	Description
domainthrottlePolicy	string	Optional	An Active Directory/LDAP domain	The throttle policy id
properties		string	OptionalRequired	A username
password	string	Optional	A password
email	string	Optional	A user email address
APIkey	string	Optional	An API key
token	string	Optional	an access token

Examples

Add a single credential

Credential properties

Example

Code Block

language	js
theme	RDark

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

Add multiple credentials

Code Block

language	js

POST /aspire/_api/credentials
[{
  "typeproperties": "filesystem"{
  "description": "Europe Net Appliance"
      "usernamedomain": "adminxxxx",
    
  ...
},
{
  "typeuser": "sharepointxxxx",
  "description": "SP Online"
      "usernamepassword": "adminxxxx",
  
  ...}
}]

Response

Code Block

language	js
theme	RDark

{
    "credential": [
        {
            "id": "AAABcID5GBc=43d1a498-c672-46b7-902f-082222122481",
            "type": "filesystem",
            "description": "Europe Net Appliance"
xxxx",
            "usernameproperties": "admin",{
  
    ...
   },
   {
    "iddomain": "AAABcIueWUc=xxxx",
                "typeuser": "sharepointxxxx",
                "descriptionpassword": "SP Onlinexxxx"
      "username": "admin",      }
    ...
    }
    }]
}

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

Section

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

x	The throttle policy id

x - at least one field must be present

Update a single credentialExample - update more credentials

Code Block

language	js
theme	RDark

PUT /aspire/_api/credentials/AAABcID5GBc%3D
{
  "idAAABcID5GBc=": "AAABcID5GBc=",{
    "typeid": "filesystemAAABcID5GBc=",
  "description": "Europe Net Appliance"
  "username"throttlePolicy": "admin",  10653921-1b27-40b5-9d7a-f54ef1e3ad01"
  ...
}

Update multiple credentials

Code Block

language	js

PUT /aspire/_api/credentials
{
},
  "AAABcID5GBcAAABcID5GBd=": {
    "id": "AAABcID5GBcAAABcID5GBd=",
    "typeproperties": "filesystem"
{
       "descriptiondomain": "Europexxxx",
  Net Appliance"
    "usernameuser": "adminxxxx",  
    ...
  },
  "AAABcIueWUc=password": {"xxxx"
    "id": "AAABcIueWUc=",
    "type": "sharepoint"
    "description": "SP Online"
    "username": "admin",  
    ...
  }
}

Response

}
  }
}

Response

Code Block

language	js
theme	RDark

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

Status: 200, 404, 406

js

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

Code Block

language

{
  "

credential

update" :

[

{
    "

id

description" : "

AAABcID5GBc=

DESCRIPTION",
    "

type

throttlePolicy" : "

filesystem

THROTTLE_POLICY_ID",
    "

description

properties":

"Europe

Net

Appliance"

username

user": "

admin

true",

    .....
    }

,

}
}

Response

Code Block

language	js
theme	RDark

id

message": "

AAABcIueWUc=",

update result response

"type": "sharepoint" "description": "SP Online" "username": "admin", ... }] }

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

message"
}

Status: 200, 406

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

Filters: The credential filter definition here

Response

Code Block

language	js
theme	RDark

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

Status: 200

Not acceptable - there was an issue validating the input

Section

Export credentials(s)

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

Delete credentials

Delete one or more credentials from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/credentials/export

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

DELETE 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 Request Body ParametersQuery parameters

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

Examples

Delete a single credential

export

Body Parameter

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

Examples

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"]
}

ResponseDelete multiple credentials

Code Block

language	js
theme	RDark

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

Status: 200, 404, 406

Section

DELETE /aspire/_api/credentials
{
  "id": [ "AAABcID5GBc=", "AAABcIueWUc=" ]
}

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.

Panel

borderColor	black
bgColor	#fafafb

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

message

type": "

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

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

Status: 200

Section

Import

The import usage can be found here

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

Credential filter:

Code Block

language	js
theme	RDark

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

Page tree

Versions Compared

Old Version 20

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)

Delete multiple credentials, filtered

Export credentials(s)

Delete credentials

Export multiple credentials, filtered

Import

Filters
Anchor
FiltersAnchor
FiltersAnchor

Page tree

Page History

Versions Compared

Old Version 20

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)

Delete multiple credentials, filtered

Export credentials(s)

Delete credentials

Export multiple credentials, filtered

Import

Filters AnchorFiltersAnchorFiltersAnchor

Filters
Anchor
FiltersAnchor
FiltersAnchor