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.

Internal attributes

Any attributes beginning with x-redox are for internal use by Redox dashboards.

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
      "AwsSigv4": {
8
        "availableFields": [
9
          "accessKey",
10
          "secretKey",
11
          "serviceName",
12
          "awsRegion",
13
          "sessionToken"
14
        ]
15
      },
16
      "GoogleWIF": {
17
        "availableFields": [
18
          "audience",
19
          "delegates",
20
          "lifetime",
21
          "options",
22
          "scope",
23
          "service_account_impersonation_url",
24
          "sts_scope",
25
          "token_url"
26
        ]
27
      },
28
      "OAuth_2.0_2-legged": {
29
        "availableFields": [
30
          "grantType",
31
          "username",
32
          "password",
33
          "url",
34
          "grantTypeName",
35
          "clientIdName",
36
          "clientSecretName",
37
          "refreshTokenName",
38
          "clientId",
39
          "clientSecret",
40
          "accessTokenName",
41
          "expiresFieldName",
42
          "refreshGrantType",
43
          "audience",
44
          "scopes",
45
          "contentType",
46
          "noBasic",
47
          "resource",
48
          "customFieldName",
49
          "customFieldValue",
50
          "defaultExpirationSeconds"
51
        ]
52
      },
53
      "Oauth_2.0_JWT_GCP": {
54
        "availableFields": [
55
          "grantType",
56
          "url",
57
          "grantTypeName",
58
          "clientIdName",
59
          "clientSecretName",
60
          "refreshTokenName",
61
          "clientId",
62
          "clientSecret",
63
          "accessTokenName",
64
          "expiresFieldName",
65
          "refreshGrantType",
66
          "audience",
67
          "scopes",
68
          "contentType",
69
          "noBasic",
70
          "resource",
71
          "customFieldName",
72
          "customFieldValue",
73
          "defaultExpirationSeconds",
74
          "basicNoForm",
75
          "password",
76
          "username",
77
          "customGrantType",
78
          "privateKey",
79
          "algorithm",
80
          "keyId",
81
          "clientCert",
82
          "clientCertKey"
83
        ]
84
      },
85
      "SMART_Backend": {
86
        "availableFields": [
87
          "grantType",
88
          "username",
89
          "password",
90
          "url",
91
          "grantTypeName",
92
          "clientIdName",
93
          "clientSecretName",
94
          "refreshTokenName",
95
          "clientId",
96
          "clientSecret",
97
          "accessTokenName",
98
          "expiresFieldName",
99
          "refreshGrantType",
100
          "audience",
101
          "scopes",
102
          "contentType",
103
          "noBasic",
104
          "resource",
105
          "customFieldName",
106
          "customFieldValue",
107
          "defaultExpirationSeconds",
108
          "privateKey",
109
          "algorithm",
110
          "keyId",
111
          "clientCert",
112
          "clientCertKey"
113
        ]
114
      },
115
      "JWT_Bearer": {
116
        "availableFields": [
117
          "privateKey",
118
          "algorithm",
119
          "keyId",
120
          "clientCert",
121
          "clientCertKey",
122
          "clientId",
123
          "clientSecret",
124
          "url"
125
        ]
126
      },
127
      "AwsSigV4": {
128
        "availableFields": [
129
          "accessKey",
130
          "secretKey",
131
          "serviceName",
132
          "awsRegion",
133
          "sessionToken"
134
        ]
135
      }
136
    }
137
  }
138
}

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.
  AwsSigv4
  object
  availableFields
  Array of string
  Displays the available fields for this strategy, which are accessKey, secretKey, serviceName, awsRegion and sessionToken.
  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.
  Oauth_2.0_JWT_GCP
  object
  availableFields
  Array of string
  Displays the available fields for this strategy.
  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.
  AwsSigV4
  object
  availableFields
  Array of string
  Displays the available fields for this strategy, which are accessKey, secretKey, serviceName, awsRegion and sessionToken.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.