Warning

title	Page in development

This page is in development and as such, its contents may be incorrect

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

Table of Contents

Success

: 200

Section

Get all credentials

Lists all the credentials configured in the Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/credentials

Pagination query string parameters

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

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

Pagination query string parameters

Common filter

: 200, 404

Section

Get a single credential

Get information about a single credential configured in Aspire

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

Query String Parameter

expand

string

Optional

List of fields to expand, * will expand everything

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

Not acceptable - there was an issue validating the input

: 200

Section

Add credentials

Adds 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",
   "properties": { This will be a dynamic JSON object } 
},
{
  "type": "sharepoint"
  "description": "SP Online",
  "properties": { This will be a dynamic JSON object } 
}]

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

: 200, 404, 406

Section

Update credentials

Update 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

: 200, 404, 406

Section

Delete multiple credentials, filtered

Delete multiple credentials from Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/credentials/deleteAll

Body Parameters

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

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

Not acceptable - there was an issue validating the input

: 200, 404, 406

Section

Delete single credential

Delete a credentials from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/credentials/:id

Path 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 found - a given service identifier was not found

: 200, 404

Section

Get credential type dxf (TODO)

Returns the dxf for a specific credential type

Panel

borderColor	black
bgColor	#fafafb

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

Path 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

Page tree

Versions Compared

Old Version 44

New Version 45

Key

Get all credentials

Get all credentials, filtered

Get a single credential

Add credentials

Update credentials

Delete multiple credentials, filtered

Delete single credential

Get credential type dxf (TODO)

Page tree

Page History

Versions Compared

Old Version 44

New Version 45

Key

Get all credentials

Get all credentials, filtered

Get a single credential

Add credentials

Update credentials

Delete multiple credentials, filtered

Delete single credential

Get credential type dxf (TODO)