Home
API reference
Platform API reference
Platform API
Credentials
Get auth strategies

Get auth strategies

get/v1/authcredentials/strategies
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 strategies

Retrieve a list of supported auth strategies that you can configure for your destinations.

cURL request example

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

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "strategies": {
7
      "GoogleWIF": {
8
        "availableFields": [
9
          "audience",
10
          "delegates",
11
          "lifetime",
12
          "options",
13
          "scope",
14
          "service_account_impersonation_url",
15
          "sts_scope",
16
          "token_url"
17
        ]
18
      },
19
      "OAuth_2.0_2-legged": {
20
        "availableFields": [
21
          "grantType",
22
          "username",
23
          "password",
24
          "url",
25
          "grantTypeName",
26
          "clientIdName",
27
          "clientSecretName",
28
          "refreshTokenName",
29
          "clientId",
30
          "clientSecret",
31
          "accessTokenName",
32
          "expiresFieldName",
33
          "refreshGrantType",
34
          "audience",
35
          "scopes",
36
          "contentType",
37
          "noBasic",
38
          "resource",
39
          "customFieldName",
40
          "customFieldValue",
41
          "defaultExpirationSeconds"
42
        ]
43
      },
44
      "SMART_Backend": {
45
        "availableFields": [
46
          "grantType",
47
          "username",
48
          "password",
49
          "url",
50
          "grantTypeName",
51
          "clientIdName",
52
          "clientSecretName",
53
          "refreshTokenName",
54
          "clientId",
55
          "clientSecret",
56
          "accessTokenName",
57
          "expiresFieldName",
58
          "refreshGrantType",
59
          "audience",
60
          "scopes",
61
          "contentType",
62
          "noBasic",
63
          "resource",
64
          "customFieldName",
65
          "customFieldValue",
66
          "defaultExpirationSeconds",
67
          "privateKey",
68
          "algorithm",
69
          "keyId",
70
          "clientCert",
71
          "clientCertKey"
72
        ]
73
      },
74
      "JWT_Bearer": {
75
        "availableFields": [
76
          "privateKey",
77
          "algorithm",
78
          "keyId",
79
          "clientCert",
80
          "clientCertKey",
81
          "clientId",
82
          "clientSecret",
83
          "url"
84
        ]
85
      }
86
    }
87
  }
88
}
  • 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

    Contains the response body with the list of available auth credential strategies that you can use.

    • strategies
      object

      Contains the supported auth credential strategies and their respective available fields. You can use any of these auth strategies when setting up custom authentication for an endpoint that receives data from Redox.

      • GoogleWIF
        object
        • availableFields
          Array of string

          Displays the available fields for this strategy, which are audience, delegates, lifetime, options, scope, service_account_impersonation_url, sts_scope, and token_url.

      • OAuth_2.0_2-legged
        object
        • availableFields
          Array of string

          Displays the available fields for this strategy, which are grantType, username, password, url, grantTypeName, clientIdName, clientSecretName, refreshTokenName, clientId, clientSecret, accessTokenName, expiresFieldName, refreshGrantType, audience, scopes, contentType, noBasic, resource, customFieldName,customFieldValue, and defaultExpirationSeconds.

      • SMART_Backend
        object
        • availableFields
          Array of string

          Displays the available fields for this strategy, which are grantType, username, password, url, grantTypeName, clientIdName, clientSecretName, refreshTokenName, clientId, clientSecret, accessTokenName, expiresFieldName, refreshGrantType, audience, scopes, contentType, noBasic, resource, customFieldName, customFieldValue, defaultExpirationSeconds, privateKey, algorithm, keyId, clientCert, and clientCertKey.

      • JWT_Bearer
        object
        • availableFields
          Array of string

          Displays the available fields for this strategy, which are privateKey, algorithm, keyID, clientCert, ClientCertKey, clientID, clientSecret, and url.