The credential 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

Filter returned seeds to only those whose description matches the given expression

Section

List

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/credential

Query String Parameters

Name Type Required Description

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

description string Optional

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

Response

Code Block

language	js
theme	RDark

{
    "count": {
        "totalItems": 1
    },
    "credential": [
        {
            "id": "AAABcID5GBc=40b305ea-77e1-4874-aa28-964b1cf4a1a8",
            "type": "filesystem",
            ...
  },
   "description": "xxxx",
            "throttlePolicy": "10653921-1b27-40b5-9d7a-f54ef1e3ad01",
            "properties": {
    "id            "domain": "AAABcIueWUc=xxxx",
         "type       "user": "filesystemxxxx",
            ...
  }],
  "messagepassword": "optional response message""xxxx"
            }
        }
    ]
}

Status

Response codeDescription

: 200

Success

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/credential?id=:idGET /aspire_api/credentialcredentials/:id

Query String and 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",
       ...
 },

  "message": "optional response message"
}

Status

Response code Description

200 Success

404 The given seed id was not found

 "description": "xxxx",
        "throttlePolicy": "10653921-1b27-40b5-9d7a-f54ef1e3ad01",
        "properties": {
            "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.

Section

Add credential(s)

Add one or more credentials to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/credentialcredentials

Request Body Parameters

Name	Type	Required	Description
type	string	Required	The type of connector to use for this seed (may be omitted if connector is specified) credential to add
description	string	OptionalRequired	An optional description of the seed

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

Name Description

domain An Active Directory/LDAP domain

username A username

password A password

email A user email address

APIkey An API key

token an access token


throttlePolicy	string	Optional	The throttle policy id
properties	string	Required	Credential properties

Example

Examples

Add a single credential

Code Block

language	js
theme	RDark

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

Add multiple credentials

Code Block

language	js

[{
  "typeproperties": "filesystem"
{
        "descriptiondomain": "Europe Net Appliance"
  ...
},
{
xxxx",
        "typeuser": "sharepointxxxx",
        "descriptionpassword": "SP Onlinexxxx"
   ... }
}]

Response

Code Block

language	js
theme	RDark

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

Status

Response codeDescription201Created406Not acceptable - there was an issue validating the input

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

Status: 201, 406

Not acceptable - there was an issue validating the input

Section

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.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/

credential

credentials/:id

PUT /aspire/_api/credentials

Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the seed credential to update
typedescription	string	Requiredx	The type of connector to use for this seed (may be omitted if connector is specified)description of the credential
properties	object	x	Credential properties
throttlePolicydescription	string	Optional	An optional description of the seed

Other parameters passed in the request body will depend on the type of credential being created - see Credential API 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=": {
    "id": "AAABcID5GBc=",
    "typethrottlePolicy": "filesystem10653921-1b27-40b5-9d7a-f54ef1e3ad01"
  "description},
  "AAABcID5GBd=": "Europe Net Appliance"{
  ...
}

Update multiple credentials

Code Block

language	js

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

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

{
  "update" : {

"type": "filesystem"


    "description" : "

Europe Net Appliance" ... }

DESCRIPTION",

{

id

throttlePolicy" : "

AAABcIueWUc=

THROTTLE_POLICY_ID",
    "

type

properties":

"sharepoint"

{
      "

description

user": "

SP Online

true",
      .....

}],

  }
  }
}

Response

Code Block

language	js
theme	RDark

{
  "message": "

optional

update result response message"
}

Status

Response code Description

201 Created

404 Not found - a given seed identifier was not found

406

: 200, 406

Section

Delete credential(s)

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

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/credential?id=credentials/:id

DELETE /aspire/_api/credential/:idcredentials

POST DELETE /aspire/_api/credentials/credentialdelete

Query String, 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

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
{
  "idids": ["AAABcID5GBc=","AAABcID5GBd"]
}

Delete multiple seedsResponse

Code Block

language	js
theme	RDark

[{
  "idmessage": "AAABcID5GBc="
},
{
  "id": "AAABcIueWUc="
}]

Delete multiple credentials (alternative form)

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

Code Block

language	js

{ "id": ["AAABcID5GBc=", "AAABcIueWUc="] }

Response

Code Block

language	js
theme	RDark

{
  "message": "

optional

delete result response message"
}

Status

Response code Description

200 Success

404 Not found - a given seed identifier was not found

406 Not acceptable - there was an issue validating the input

Section

: 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

Get DXF

Gets the DXF for a credential.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/credential/dxf?type=:typecredentials/export

GET /aspire/_api/credentialcredentials/dxf/:typeexport/: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 parameters

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

Body ParameterQuery String, Path and Request Body Parameters

Name	Type	Required	Description
typeids	string	Required	The type identifier(s) of the credential to get the DXF for(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"]
}

Response

Code Block

language	js
theme	RDark

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

Status

Response code Description

200 Success

404 Not found - a given service identifier was not found

406

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

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": {
            "type": "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 5

New Version Current

Key

Get all credentials

Get all credentials, filtered

Get a single credential

Add credential(s)

Add credential(s)

Update credential(s)

Update credentials, filtered

Delete credential(s)

Delete multiple credentials, filtered

Export credentials(s)

Get DXF

Export multiple credentials, filtered

Import

Filters
Anchor
FiltersAnchor
FiltersAnchor

Page tree

Page History

Versions Compared

Old Version 5

New Version Current

Key

Get all credentials

Get all credentials, filtered

Get a single credential

Add credential(s)

Add credential(s)

Update credential(s)

Update credentials, filtered

Delete credential(s)

Delete multiple credentials, filtered

Export credentials(s)

Get DXF

Export multiple credentials, filtered

Import

Filters AnchorFiltersAnchorFiltersAnchor

Filters
Anchor
FiltersAnchor
FiltersAnchor