You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: tyk-docs/content/advanced-configuration/integrate/sso.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ weight: 0
13
13
### SSO - The generic use case
14
14
15
15
SSO gives users the ability to log in to multiple applications without the need to enter their password more than once.
16
-
[OIDC]({{< ref "/api-management/authentication-authorization#use-openid-connect" >}}) or SAML enables an application to verify the identity of users from an organization without the need to self store and manage them, and without doing the identification process and exposing their passwords to that application. Their lists of users and passwords are kept safe in one single place, in the IDP that the organization has chosen to use. The Authorization server of the IdP identify the users for a pre-registered and approved application (`client` in OAuth and OIDC terminology).
16
+
OpenID Connect and SAML enable an application to verify the identity of users from an organization without the need to self store and manage them, and without doing the identification process and exposing their passwords to that application. Their lists of users and passwords are kept safe in one single place, in the IDP that the organization has chosen to use. The Authorization server of the IdP identify the users for a pre-registered and approved application (`client` in OAuth and OIDC terminology).
| Client certifates | ✅ [Client mTLS]({{<ref "api-management/authentication-authorization#setup-static-mtls-in-tyk-operator-using-the-tyk-classic-api-definition">}}) | ✅ [Client mTLS]({{<ref "api-management/authentication-authorization#setup-static-mtls-in-tyk-operator-using-tyk-oas-api-definition">}}) | Certificate ID can be set in the API Definition but configuring certificates from Secrets in CRD is not supported. |
294
+
| Client certifates | ✅ [Client mTLS]({{<ref "api-management/client-authentication#setup-static-mtls-in-tyk-operator-using-the-tyk-classic-api-definition">}}) | ✅ [Client mTLS]({{<ref "api-management/client-authentication#setup-static-mtls-in-tyk-operator-using-tyk-oas-api-definition">}}) | Certificate ID can be set in the API Definition but configuring certificates from Secrets in CRD is not supported. |
295
295
| Custom domain certificates | ✅ [TLS and SSL]({{<ref "basic-config-and-security/security/tls-and-ssl#tyk-operator-classic">}}) | ✅ [TLS and SSL]({{<ref "basic-config-and-security/security/tls-and-ssl#tyk-operator-oas">}}) | Certificate ID can be set in the API Definition but configuring certificates from Secrets in CRD is not supported. |
296
296
| Public keys pinning | ✅ [Certificate pinning]({{<ref "security/certificate-pinning#tyk-operator-classic">}}) | ✅ [Certificate pinning]({{<ref "security/certificate-pinning#tyk-operator-oas">}}) | Certificate ID can be set in the API Definition but configuring certificates from Secrets in CRD is not supported. |
297
-
| Upstream mTLS | ✅ [Upstream mTLS via Operator]({{<ref "api-management/authentication-authorization#via-tyk-operator-using-the-tyk-classic-api-definition">}}) | ✅ [Upstream mTLS via Operator]({{<ref "api-management/authentication-authorization#tyk-operator-oas">}}) | Certificate ID can be set in the API Definition but configuring certificates from Secrets in CRD is not supported. |
297
+
| Upstream mTLS | ✅ [Upstream mTLS via Operator]({{<ref "api-management/client-authentication#via-tyk-operator-using-the-tyk-classic-api-definition">}}) | ✅ [Upstream mTLS via Operator]({{<ref "api-management/client-authentication#tyk-operator-oas">}}) | Certificate ID can be set in the API Definition but configuring certificates from Secrets in CRD is not supported. |
298
298
299
299
300
300
### Install and Configure Tyk Operator
@@ -823,7 +823,7 @@ In this example, we added the following sections to configure key authentication
823
823
- `security`: Applies the authentication globally to all endpoints.
824
824
- `x-tyk-api-gateway.server.authentication`: Tyk-specific extension to enable the authentication scheme.
825
825
826
-
You can configure your API for any Tyk supported authentication method by following [Authentication with Tyk OAS]({{<ref "getting-started/key-concepts/authentication">}}) documentation.
826
+
You can configure your API for any Tyk supported authentication method by following [Authentication with Tyk OAS]({{<ref "getting-started/key-concepts/authentication">}}) documentation.
827
827
828
828
Save your updated API definition in the same file, `oas-api-definition.json`.
829
829
@@ -1213,7 +1213,7 @@ Client to Gateway Authentication in Tyk ensures secure communication between cli
1213
1213
1214
1214
##### Keyless (Open)
1215
1215
1216
-
This configuration allows [keyless (open)]({{<ref "api-management/authentication-authorization#use-open-keyless-authentication">}}) access to the API without any authentication.
1216
+
This configuration allows [keyless (open)]({{<ref "api-management/client-authentication#open-no-authentication">}}) access to the API without any authentication.
1217
1217
1218
1218
```yaml {hl_lines=["7-7"],linenos=false}
1219
1219
apiVersion: tyk.tyk.io/v1alpha1
@@ -1233,7 +1233,7 @@ spec:
1233
1233
1234
1234
##### Auth Token (Bearer Token)
1235
1235
1236
-
This setup requires a [bearer token]({{<ref "api-management/authentication-authorization#use-bearer-tokens">}}) for access.
1236
+
This setup requires a [bearer token]({{<ref "api-management/client-authentication#use-auth-tokens">}}) for access.
1237
1237
1238
1238
In the below example, the authentication token is set by default to the `Authorization` header of the request. You can customize this behavior by configuring the following fields:
1239
1239
@@ -1242,7 +1242,7 @@ In the below example, the authentication token is set by default to the `Authori
1242
1242
- `use_param`: Set to true to allow the token to be passed as a query parameter.
1243
1243
- `param_name`: Specify the parameter name if use_param is enabled.
1244
1244
- `use_certificate`: Enable client certificate. This allows you to create dynamic keys based on certificates.
This configuration uses [JWT tokens]({{<ref "api-management/authentication-authorization#use-json-web-tokens-jwt">}}) for authentication.
1287
+
This configuration uses [JWT tokens]({{<ref "api-management/client-authentication#use-json-web-tokens-jwt">}}) for authentication.
1288
1288
1289
1289
Users can configure JWT authentication by defining the following fields:
1290
1290
1291
-
- `jwt_signing_method`: Specify the method used to sign the JWT. Refer to [JWT Signing Method]({{<ref "api-management/authentication-authorization#set-up-jwt-signing-method">}}) for supported methods.
1291
+
- `jwt_signing_method`: Specify the method used to sign the JWT. Refer to [JWT Signing Method]({{<ref "api-management/client-authentication#set-up-jwt-signing-method">}}) for supported methods.
1292
1292
- `jwt_source`: Specify the public key used for verifying the JWT.
1293
1293
- `jwt_identity_base_field`: Define the identity source, typically set to `sub` (subject), which uniquely identifies the user or entity.
1294
1294
- `jwt_policy_field_name`: Specify the claim within the JWT payload that indicates the policy ID to apply.
This configuration uses [Basic Authentication]({{<ref "api-management/authentication-authorization#use-basic-authentication">}}), requiring a username and password for access.
1378
+
This configuration uses [Basic Authentication]({{<ref "api-management/client-authentication#use-basic-authentication">}}), requiring a username and password for access.
1379
1379
1380
1380
```yaml {hl_lines=["13-13"],linenos=false}
1381
1381
apiVersion: tyk.tyk.io/v1alpha1
@@ -1460,9 +1460,9 @@ spec:
1460
1460
1461
1461
##### Multiple (Chained) Auth
1462
1462
1463
-
This setup allows for [multiple authentication]({{<ref "api-management/authentication-authorization#multiple-chained-authentication">}}) methods to be chained together, requiring clients to pass through each specified authentication provider.
1463
+
This setup allows for [multiple authentication]({{<ref "api-management/client-authentication#combine-authentication-methods">}}) methods to be chained together, requiring clients to pass through each specified authentication provider.
1464
1464
1465
-
To enable multiple (chained) auth, you should set `base_identity_provided_by` field to one of the supported chained enums. Consult [Enable Multi (Chained) Authentication in your API Definition]({{<ref "api-management/authentication-authorization#enable-multi-chained-authentication-in-your-api-definition">}}) for the supported auths.
1465
+
To enable multiple (chained) auth, you should set `base_identity_provided_by` field to one of the supported chained enums. Consult [Enable Multi (Chained) Authentication in your API Definition]({{<ref "api-management/client-authentication#enable-multi-chained-authentication-in-your-api-definition">}}) for the supported auths.
1466
1466
1467
1467
In this example, we are creating an API definition with basic authentication and mTLS with basic authentication as base identity for `httpbin-multiple-authentications`.
0 commit comments