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

Table of Contents

Section

List credentials

Lists all the credentials configured in the Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/credential

Query String Parameters

Name	Type	Required	Description
type	string	Optional	Filter returned seeds credentials to only those with the given type
description	string	Optional	Filter returned seeds credentials to only those whose description matches the given expression

Response

Code Block

language	js

{
  "credential": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem",
    ...
  },
  {
    "id": "AAABcIueWUc=",
    "type": "filesystem",
    ...
  }],
  "message": "optional response message"
}

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

GET /aspire_api/credential/: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

{
  "credential": {
    "id": "AAABcID5GBc=",
    "type": "filesystem",
    ...
 },

  "message": "optional response message"
}

Status

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

Section

Add credential(s)

Add one or more credentials to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire_api/credential

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	Optional	An optional description of the seed 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

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

Examples

Add a single credential

Code Block

language	js

{
  "type": "filesystem"
  "description": "Europe Net Appliance"
  ...
}

Add multiple credentials

Code Block

language	js

[{
  "type": "filesystem"
  "description": "Europe Net Appliance"
  ...
},
{
  "type": "sharepoint"
  "description": "SP Online"
  ...
}]

Response

Code Block

language	js

{
  "credential": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem"
    "description": "Europe Net Appliance"
    ...
   },
   {
    "id": "AAABcIueWUc=",
    "type": "sharepoint"
    "description": "SP Online"
    ...
  }],
  "message": "optional response message"
}

Status

Response code	Description
201	Created
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

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire_api/credential

Request Body Parameters

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

Other parameters passed in the request body will depend on the type of credential being created - see Credential API above

Examples

Update a single credential

Code Block

language	js

{
  "id": "AAABcID5GBc=",
  "type": "filesystem"
  "description": "Europe Net Appliance"
  ...
}

Update multiple credentials

Code Block

language	js

[{
  "id": "AAABcID5GBc=",
  "type": "filesystem"
  "description": "Europe Net Appliance"
  ...
},
{
  "id": "AAABcIueWUc=",
  "type": "sharepoint"
  "description": "SP Online"
  ...
}]

Response

Code Block

language	js

{
  "credential": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem"
    "description": "Europe Net Appliance"
    ...
   },
   {
    "id": "AAABcIueWUc=",
    "type": "sharepoint"
    "description": "SP Online"
    ...
  }],
  "message": "optional response message"
}

Status

Response code	Description
201	Created
404	Not found - a given seed credential identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Delete credential(s)

Delete one or more credentials from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire_api/credential?id=:id

DELETE /aspire_api/credential/:id

DELETE /aspire_api/credential

Query String, Path and Request Body Parameters

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

Examples

Delete a single credential

Code Block

language	js

{
  "id": "AAABcID5GBc="
}

Delete multiple seeds credentials

Code Block

language	js

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

Delete multiple credentials (alternative form)

Code Block

language	js

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

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given seed credential identifier was not found
406	Not acceptable - there was an issue validating the input

Page tree

Versions Compared

Old Version 6

New Version 7

Key

List credentials

Get a single credential

Add credential(s)

Update credential(s)

Delete credential(s)

Page tree

Page History

Versions Compared

Old Version 6

New Version 7

Key

List credentials

Get a single credential

Add credential(s)

Update credential(s)

Delete credential(s)