Home
API reference
Platform API reference
Platform API
Credentials
Get auth credentials

Get auth credentials

get/v1/environments/{environmentId}/authcredentials
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.

Get auth credentials

Retrieve a list of existing auth credentials in a configured environment. The response contains the metadata for each defined auth credential.

You can use this query to find the IDs for auth credentials. If you'd like to review details for a specific auth credential, you can retrieve an auth credential by its ID instead.

Request parameters

cURL request example

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

Path Parameters

  • environmentId
    required, string

    Identifies the specific environment that you're operating in or on behalf of.

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "credentials": [
7
      {
8
        "organization": 118,
9
        "name": "Sample Auth Credential",
10
        "environmentId": "a31a92e5-43b7-45df-8085-4ac5a746d105",
11
        "id": "string",
12
        "createdAt": "string",
13
        "updatedAt": "string",
14
        "authStrategy": "GoogleWIF"
15
      }
16
    ]
17
  }
18
}
  • 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
    • credentials
      Array of object

      Contains auth credentials.

      • organization
        required, number

        Contains your unique Redox organization identifier.

      • name
        required, string

        Displays the name of the auth credential.

      • environmentId
        required, string

        Identifies the specific environment that the auth credential is used in.

      • id
        required, string

        Contains a unique identifier assigned to the auth credential. Use this value when querying for this auth credential in future API requests.

      • createdAt
        required, string

        Displays the timestamp of when the auth credential was created. This value is set by Redox.

      • updatedAt
        required, string

        Displays the timestamp of the last time this auth credential was updated. This value is set by Redox.

      • authStrategy
        string

        Indicates the specific strategy type that this auth credential belongs to.

        Possible Values: GoogleWIF, OAuth_2.0_2-legged, SMART_Backend, JWT_Bearer, AwsSigV4, OAuth_2.0_JWT_GCP