Service Credential Actions

https://api.app.wnology.io/applications/APPLICATION_ID/credentials/CREDENTIAL_ID

Below are the various requests that can be performed against the Service Credential resource, as well as the expected parameters and the potential responses.

Delete

Deletes a credential

Method And Url

DELETE https://api.app.wnology.io/applications/APPLICATION_ID/credentials/CREDENTIAL_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, credential.*, or credential.delete.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
CREDENTIAL_ID	ID associated with the credential	575ec76c7ae143cd83dc4a96

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X DELETE \
    https://api.app.wnology.io/applications/APPLICATION_ID/credentials/CREDENTIAL_ID

Successful Responses

Code	Type	Description
200	Success	If credential was successfully deleted

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if credential was not found

Get

Retrieves information on a credential

Method And Url

GET https://api.app.wnology.io/applications/APPLICATION_ID/credentials/CREDENTIAL_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, credential.*, or credential.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
CREDENTIAL_ID	ID associated with the credential	575ec76c7ae143cd83dc4a96

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.app.wnology.io/applications/APPLICATION_ID/credentials/CREDENTIAL_ID

Successful Responses

Code	Type	Description
200	Credential	credential information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if credential was not found

Linked Resources

Retrieves information on resources linked to a credential

Method And Url

GET https://api.app.wnology.io/applications/APPLICATION_ID/credentials/CREDENTIAL_ID/linkedResources

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, credential.*, or credential.linkedResources.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
CREDENTIAL_ID	ID associated with the credential	575ec76c7ae143cd83dc4a96

Request Query Parameters

Name	Required	Description	Default	Example
includeCustomNodes	N	If the result of the request should also include the details of any custom nodes referenced by returned workflows	false	`includeCustomNodes=true`

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.app.wnology.io/applications/APPLICATION_ID/credentials/CREDENTIAL_ID/linkedResources

Successful Responses

Code	Type	Description
200	Credential Linked Resources	Linked resource information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if credential was not found

Patch

Updates information about a credential

Method And Url

PATCH https://api.app.wnology.io/applications/APPLICATION_ID/credentials/CREDENTIAL_ID

Authentication

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
CREDENTIAL_ID	ID associated with the credential	575ec76c7ae143cd83dc4a96

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Credential Patch schema. For example, the following would be a valid body for this request:

{
  "enabled": true,
  "azureConfig": {
    "account": "my account",
    "accountKey": "123abc"
  }
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"enabled":true,"azureConfig":{"account":"my account","accountKey":"123abc"}}' \
    https://api.app.wnology.io/applications/APPLICATION_ID/credentials/CREDENTIAL_ID

Successful Responses

Code	Type	Description
200	Credential	Updated credential information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if credential was not found

Schemas

Credential

Schema for a single Credential

Credential Schema

▶
(root){} 5 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 28 keys▶
id:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
createdById:{} 2 keys
▶
createdByType:{} 2 keys
▶
lastUpdatedById:{} 2 keys
▶
lastUpdatedByType:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
enabled:{} 1 key
▶
type:{} 2 keys
▶
awsConfig:{} 4 keys
▶
azureConfig:{} 3 keys
▶
gcpConfig:{} 4 keys
▶
httpConfig:{} 4 keys
▶
sendgridConfig:{} 3 keys
▶
twilioConfig:{} 4 keys
▶
logglyConfig:{} 3 keys
▶
jwtConfig:{} 4 keys
▶
whatsappConfig:{} 4 keys
▶
sqlConfig:{} 4 keys
▶
mongodbConfig:{} 3 keys
▶
mailgunConfig:{} 3 keys
▶
snowflakeConfig:{} 4 keys
▶
gitConfig:{} 4 keys
▶
datadogConfig:{} 3 keys
▶
certificateKeyPairConfig:{} 3 keys
additionalProperties:false
▶
required:[] 2 items

Credential Example

▶
(root){} 12 keysid:"575ece2b7ae143cd83dc4a9b"
applicationId:"575ece2b7ae143cd83dc4a9c"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
lastUpdatedByType:"user"
lastUpdatedById:"575ece2b7ae143cd83dc4a9d"
createdByType:"user"
createdById:"575ece2b7ae143cd83dc4a9d"
name:"Dave"
type:"azure"
enabled:true
▶
azureConfig:{} 1 key

Credential Linked Resources

The body of an credential linked resources response

Credential Linked Resources Schema

▶
(root){} 4 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys▶
integrations:{} 4 keys
▶
flows:{} 4 keys
▶
flowVersions:{} 4 keys
additionalProperties:false

Credential Linked Resources Example

▶
(root){} 3 keys▶
integrations:{} 8 keys
▶
flows:{} 8 keys
▶
flowVersions:{} 9 keys

Credential Patch

Schema for a Credential update request

Credential Patch Schema

▶
(root){} 4 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 19 keys▶
name:{} 3 keys
▶
description:{} 2 keys
▶
enabled:{} 1 key
▶
awsConfig:{} 3 keys
▶
azureConfig:{} 3 keys
▶
gcpConfig:{} 3 keys
▶
httpConfig:{} 3 keys
▶
sendgridConfig:{} 3 keys
▶
twilioConfig:{} 3 keys
▶
logglyConfig:{} 3 keys
▶
jwtConfig:{} 3 keys
▶
whatsappConfig:{} 3 keys
▶
sqlConfig:{} 3 keys
▶
mongodbConfig:{} 3 keys
▶
mailgunConfig:{} 3 keys
▶
snowflakeConfig:{} 3 keys
▶
gitConfig:{} 3 keys
▶
datadogConfig:{} 3 keys
▶
certificateKeyPairConfig:{} 3 keys
additionalProperties:false

Credential Patch Example

▶
(root){} 2 keysenabled:true
▶
azureConfig:{} 2 keys

Error

Schema for errors returned by the API

Error Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
(root){} 2 keystype:"NotFound"
message:"Application was not found"

Success

Schema for reporting a successful operation

Success Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 1 key▶
success:{} 2 keys

Success Example

▶
(root){} 1 keysuccess:true

Was this page helpful?

Still looking for help? You can also search the WEGnology Forums or submit your question there.

Delete​

Method And Url ​

Authentication ​

Request Path Components ​

Request Headers ​

Curl Example ​

Successful Responses ​

Error Responses ​

Get​

Method And Url ​

Authentication ​

Request Path Components ​

Request Headers ​

Curl Example ​

Successful Responses ​

Error Responses ​

Linked Resources​

Method And Url ​

Authentication ​

Request Path Components ​

Request Query Parameters ​

Request Headers ​

Curl Example ​

Successful Responses ​

Error Responses ​

Patch​

Method And Url ​

Authentication ​

Request Path Components ​

Request Headers ​

Request Body ​

Curl Example ​

Successful Responses ​

Error Responses ​

Schemas​

Credential​

Credential Schema​

Credential Example​

Credential Linked Resources​

Credential Linked Resources Schema​

Credential Linked Resources Example​

Credential Patch​

Credential Patch Schema​

Credential Patch Example​

Error​

Error Schema​

Error Example​

Success​

Success Schema​

Success Example​

Was this page helpful?

Delete

Method And Url

Authentication

Request Path Components

Request Headers

Curl Example

Successful Responses

Error Responses

Get

Method And Url

Authentication

Request Path Components

Request Headers

Curl Example

Successful Responses

Error Responses

Linked Resources

Method And Url

Authentication

Request Path Components

Request Query Parameters

Request Headers

Curl Example

Successful Responses

Error Responses

Patch

Method And Url

Authentication

Request Path Components

Request Headers

Request Body

Curl Example

Successful Responses

Error Responses

Schemas

Credential

Credential Schema

Credential Example

Credential Linked Resources

Credential Linked Resources Schema

Credential Linked Resources Example

Credential Patch

Credential Patch Schema

Credential Patch Example

Error

Error Schema

Error Example

Success

Success Schema

Success Example