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

Table of Contents

Section

Get all credentials

Lists all the credentials configured in the Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/credentials

Query String Parameters

Name	Type	Required	Description
startfrom	integer	Optional	Retrieves the specified page of results
size	integer	Optional	Specifies the size of results page
sortBy	string	Optional	Field by which results are sorted
sortMode	string	Optional	"asc" for ascending sort, "desc" for descending sort

Response

Code Block

language	js

{
  "credential": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem",
    "description": "Sales HD1 credentials",
    "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object } 
  },
  {
    "id": "AAABcIueWUc=",
    "type": "filesystem",
    "description": "Sales HD2 credentials",
    "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object }  
  }]
}

Status

Response code	Description
200	Success

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

Name	Type	Required	Description
startfrom	integer	Optional	Retrieves the specified page of results
size	integer	Optional	Specifies the size of results page
sortBy	string	Optional	Field by which results are sorted
sortMode	string	Optional	"asc" for ascending sort, "desc" for descending sort

Body Parameters

Name	Type	Required	Description
Filter	JSON	Required	Filters retrieved credentials. Check the filter definition here

Response

Code Block

language	js

{
  "credential": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem",
    "description": "Sales HD1 credentials",
    "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object } 
  },
  {
    "id": "AAABcIueWUc=",
    "type": "filesystem",
    "description": "Sales HD2 credentials",
    "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object }  
  }]
}

Status

Response code	Description
200	Success

Section

Get a single credential

Get information about a single credential configured in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/credentials/:id

Query String Parameters

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

Response

Code Block

language	js

{
  "credential": {
    "id": "AAABcID5GBc=",
    "type": "filesystem",
    "description": "Filesystem credentials",
    "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object }  
 }
}

Status

Response code	Description
200	Success
404	The given credentials id was not found

Section

Add multiple credentials

Adds multiple credentials to Aspire

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

Example

Code Block

language	js

POST /aspire/_api/credentials
[{
  "type": "filesystem"
  "description": "Europe Net Appliance"
  "username": "admin"
},
{
  "type": "sharepoint"
  "description": "SP Online"
  "username": "admin"
}]

Response

Code Block

language	js

{
  "credential": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem"
    "description": "Europe Net Appliance",
    "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object }  
   },
   {
    "id": "AAABcIueWUc=",
    "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
201	Created
406	Not acceptable - there was an issue validating the input

Section

Add single credential

Add a credential to Aspire

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

Example

Code Block

language	js

POST /aspire/_api/credentials
{
  "type": "filesystem"
  "description": "Europe Net Appliance"
}

Response

Code Block

language	js

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

Response code	Description
201	Created
406	Not acceptable - there was an issue validating the input

Section

Update multiple credentials

Update multiple credentials in Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/credentials

Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the credential to update
type	string	Optional	The type of credential
description	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

Example

Code Block

language	js

PUT /aspire/_api/credentials
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "type": "filesystem"
    "description": "Europe Net Appliance"
  },
  "AAABcIueWUc=": {
    "id": "AAABcIueWUc=",
    "type": "sharepoint"
    "description": "SP Online"
  }
}

Response

Code Block

language	js

{
  "credential": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem"
    "description": "Europe Net Appliance",
    "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object }  
   },
   {
    "id": "AAABcIueWUc=",
    "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	Not acceptable - there was an issue validating the input

Section

Update single credential

Update a credential in Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/credentials/:id

Query String Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the credential to update

Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the credential to update
type	string	Optional	The type of credential
description	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

Example

Code Block

language	js

PUT /aspire/_api/credentials/AAABcID5GBc%3D
{
  "id": "AAABcID5GBc=",
  "type": "filesystem"
  "description": "Europe Net Appliance"
}

Response

Code Block

language	js

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

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

Delete multiple credentials, filtered

Delete multiplefrom Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/credentials/deleteAll

Body Parameters

Name	Type	Required	Description
Filter	JSON	Required	Filters retrieved credentials. Check the filter definition here

Example

Code Block

language	js

POST /aspire/_api/credentials

Response

Code Block

language	js

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

Delete single credential

Delete a credentials from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/credentials/:id

Query String Parameters

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

Example

Code Block

language	js

DELETE /aspire/_api/credentials/AAABcID5GBc=

Response

Code Block

language	js

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

Get credential type dxf

Returns the dxf for a specific credential type

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/credentials/type/:typeId/dxf

Query String Parameters

Name	Type	Required	Description
typeId	string	Required	The id of the type for which dxf is going to be retrieved

Response

Code Block

language	js

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

Status

Response code	Description
200	Success
404	Not found - a given service identifier was not found

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

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

Credentials filter:

Code Block

language	js

  "filter" : {
    "ids" : ["id1", "id2", "id3"],
    "type" : "TYPE",
    "description" : "DESCRIPTION"
  }

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

Page tree

Versions Compared

Old Version 29

New Version 30

Key

Get all credentials

Get all credentials, filtered

Get a single credential

Add multiple credentials

Add single credential

Update multiple credentials

Update single credential

Delete multiple credentials, filtered

Delete single credential

Get credential type dxf

Filters
Anchor
FiltersAnchor
FiltersAnchor

Page tree

Page History

Versions Compared

Old Version 29

New Version 30

Key

Get all credentials

Get all credentials, filtered

Get a single credential

Add multiple credentials

Add single credential

Update multiple credentials

Update single credential

Delete multiple credentials, filtered

Delete single credential

Get credential type dxf

Filters AnchorFiltersAnchorFiltersAnchor

Filters
Anchor
FiltersAnchor
FiltersAnchor