Home
API reference
Platform API reference
Platform API
Credentials
Delete auth credential

Delete auth credential

delete/v1/authcredentials/{id}
Page View

Credential endpoints allow you to manage custom authentication strategies for your organization's destinations. Destinations are the endpoints in your system that receive data from Redox.

You may choose custom authentication for your destinations if you want more secure authentication credentials for any data coming into your system.

With this set of Platform API endpoints, you can:

  • retrieve a list of existing auth credentials for an environment;
  • retrieve one auth credential by its ID;
  • retrieve a list of supported auth strategies;
  • create a new auth credential;
  • update an existing auth credential; or
  • delete an existing auth credential.

Delete auth credential

Delete an existing auth credential if it's not being used. The request only requires the auth credential ID.

The response contains an OK acknowledgement if the delete is successful. If the delete isn't successful, the auth credential is likely in use. Any auth credentials that are in use can't be deleted.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/authcredentials/{id}' \
2
--request DELETE \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Path Parameters

  • id
    required, string

    Displays the unique identifier of the auth credential.

Response fields and example

Example
json
1
{
2
  "meta": "1.0.0",
3
  "payload": {
4
    "message": "Auth credential id [98765] was successfully deleted."
5
  }
6
}

    Describes the outcome of the delete request.

  • meta
    object
    • version
      string

      Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.

  • payload
    object
    • message
      string

      Explains that the delete request was successful, so the auth credential no longer exists within the specified environment.