Versions Compared

Old Version 12

changes.mady.by.user Steve Denny

Saved on

compared with

New Version 13

changes.mady.by.user Steve Denny

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning
titlePage 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

Section

Get all credentials

Lists all the credentials configured in the Aspire

Panel
borderColorblack
bgColor#fafafb
GET /aspire/_api/credentials

Query String Parameters

NameTypeRequiredDescription
typestringOptionalFilter returned credentials to only those with the given type
descriptionstringOptionalFilter returned credentials to only those whose description matches the given expression

Response

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

Status

Response codeDescription
200Success



Section

Get a single credential

Get information about a single credential configured in Aspire

Panel
borderColorblack
bgColor#fafafb

GET /aspire/_api/credentials/:id

Path Parameters

NameTypeRequiredDescription
idstringRequiredThe id of the credential to return

Response

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

  "message": "optional response message"
}

Status

Response codeDescription
200Success
404The given credentials id was not found



Section

Add credentials

Add one or more credentials to Aspire

Panel
borderColorblack
bgColor#fafafb
POST /aspire/_api/credentials

Request Body Parameters

NameTypeRequiredDescription
typestringRequiredThe type of credential to add
descriptionstringOptionalAn 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

NameDescription
domainAn Active Directory/LDAP domain
usernameA username
passwordA password
emailA user email address
APIkeyAn API key
tokenan access token

Examples

Add a single credential

Code Block
languagejs
POST /aspire/_api/credentials
{
  "type": "filesystem"
  "description": "Europe Net Appliance"
  ...
}

Add multiple credentials

Code Block
languagejs
POST /aspire/_api/credentials
[{
  "type": "filesystem"
  "description": "Europe Net Appliance"
  ...
},
{
  "type": "sharepoint"
  "description": "SP Online"
  ...
}]

Response

Code Block
languagejs
{
  "credential": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem"
    "description": "Europe Net Appliance"
    ...
   },
   {
    "id": "AAABcIueWUc=",
    "type": "sharepoint"
    "description": "SP Online"
    ...
  }],
  "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 codeDescription
201Created
406Not acceptable - there was an issue validating the input



Section

Update credentials

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
borderColorblack
bgColor#fafafb

PUT /aspire/_api/credentials/:id

PUT /aspire/_api/credentials

Path and Request Body Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the credential to update
typestringOptionalThe type of credential
descriptionstringOptionalAn 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

Update a single credential

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

Update multiple credentials

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

Response

Code Block
languagejs
{
  "credential": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem"
    "description": "Europe Net Appliance"
    ...
   },
   {
    "id": "AAABcIueWUc=",
    "type": "sharepoint"
    "description": "SP Online"
    ...
  }],
  "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 codeDescription
201Created
404Not found - a given credential identifier was not found
406Not acceptable - there was an issue validating the input



Section

Delete credentials

Delete one or more credentials from Aspire.

Panel
borderColorblack
bgColor#fafafb

DELETE /aspire/_api/credentials/:id

DELETE /aspire/_api/credentials

Path and Request Body Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the credential(s) to delete

Examples

Delete a single credential

Code Block
languagejs
DELETE /aspire/_api/credentials/AAABcID5GBc=

Delete multiple credentials

Code Block
languagejs
DELETE /aspire/_api/credential?id=AAABcID5GBc%3D&id=AAABcIueWUc%3D

Response

Code Block
languagejs
{
  "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 codeDescription
200Success
404Not found - a given credential identifier was not found
406Not acceptable - there was an issue validating the input