Skip to content

Commit d154911

Browse files
authored
[DX-1778] Improve documentation of Tyk as authorization server (#5798)
1 parent c79bab3 commit d154911

File tree

36 files changed

+2792
-2675
lines changed

36 files changed

+2792
-2675
lines changed

tyk-docs/content/advanced-configuration/integrate/sso.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ weight: 0
1313
### SSO - The generic use case
1414

1515
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).
1717

1818
### SSO in Tyk
1919

tyk-docs/content/advanced-configuration/transform-traffic/endpoint-designer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The **Core Settings** tab provides access to configure basic settings for the AP
2525
- [Service Discovery]({{< ref "planning-for-production/ensure-high-availability/service-discovery" >}})
2626
- [API Ownership]({{< ref "product-stack/tyk-dashboard/advanced-configurations/user-management/api-ownership" >}})
2727
- [API level rate limiting]({{< ref "basic-config-and-security/control-limit-traffic/rate-limiting#configuring-the-rate-limiter-at-the-api-level" >}})
28-
- [Authentication]({{< ref "/api-management/authentication-authorization" >}})
28+
- [Authentication]({{< ref "/api-management/client-authentication" >}})
2929

3030
## Versions
3131

tyk-docs/content/api-management/automations.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -291,10 +291,10 @@ To address this challenge, Tyk Operator allows you to directly reference certifi
291291

292292
| Certificate Type | Supported in ApiDefinition | Supported in TykOasApiDefinition | Supported in TykStreamsApiDefinition |
293293
|------------------|-------------|---------|---------|
294-
| 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. |
295295
| 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. |
296296
| 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. |
298298

299299

300300
### Install and Configure Tyk Operator
@@ -823,7 +823,7 @@ In this example, we added the following sections to configure key authentication
823823
- `security`: Applies the authentication globally to all endpoints.
824824
- `x-tyk-api-gateway.server.authentication`: Tyk-specific extension to enable the authentication scheme.
825825

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.
827827

828828
Save your updated API definition in the same file, `oas-api-definition.json`.
829829

@@ -1213,7 +1213,7 @@ Client to Gateway Authentication in Tyk ensures secure communication between cli
12131213

12141214
##### Keyless (Open)
12151215

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.
12171217

12181218
```yaml {hl_lines=["7-7"],linenos=false}
12191219
apiVersion: tyk.tyk.io/v1alpha1
@@ -1233,7 +1233,7 @@ spec:
12331233

12341234
##### Auth Token (Bearer Token)
12351235

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.
12371237

12381238
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:
12391239

@@ -1242,7 +1242,7 @@ In the below example, the authentication token is set by default to the `Authori
12421242
- `use_param`: Set to true to allow the token to be passed as a query parameter.
12431243
- `param_name`: Specify the parameter name if use_param is enabled.
12441244
- `use_certificate`: Enable client certificate. This allows you to create dynamic keys based on certificates.
1245-
- `validate_signature`: Enable [signature validation]({{<ref "api-management/authentication-authorization#use-bearer-tokens">}}).
1245+
- `validate_signature`: Enable [signature validation]({{< ref "api-management/client-authentication#auth-token-signature-validation">}}).
12461246

12471247
```yaml {hl_lines=["13-35"],linenos=false}
12481248
apiVersion: tyk.tyk.io/v1alpha1
@@ -1284,11 +1284,11 @@ spec:
12841284

12851285
##### JWT
12861286

1287-
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.
12881288

12891289
Users can configure JWT authentication by defining the following fields:
12901290

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.
12921292
- `jwt_source`: Specify the public key used for verifying the JWT.
12931293
- `jwt_identity_base_field`: Define the identity source, typically set to `sub` (subject), which uniquely identifies the user or entity.
12941294
- `jwt_policy_field_name`: Specify the claim within the JWT payload that indicates the policy ID to apply.
@@ -1375,7 +1375,7 @@ curl http://localhost:8080/httpbin-jwt1/get -H 'Authorization: Bearer eyJhbGciOi
13751375

13761376
##### Basic Authentication
13771377

1378-
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.
13791379

13801380
```yaml {hl_lines=["13-13"],linenos=false}
13811381
apiVersion: tyk.tyk.io/v1alpha1
@@ -1460,9 +1460,9 @@ spec:
14601460

14611461
##### Multiple (Chained) Auth
14621462

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.
14641464

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.
14661466

14671467
In this example, we are creating an API definition with basic authentication and mTLS with basic authentication as base identity for `httpbin-multiple-authentications`.
14681468

0 commit comments

Comments
 (0)