Credential Actions

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

Below are the various requests that can be performed against the 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.Organization, all.User, 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.read, all.Organization, all.Organization.read, all.User, 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.read, all.Organization, all.Organization.read, all.User, 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

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.Organization, all.User, credential.*, or credential.patch.

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

Was this page helpful?

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