Skip to content

Commit 54aca32

Browse files
bugerletzya
andauthored
Merging to release-5.4: [DX-1437] organise --> organize (PR 2) (#5077)
[DX-1437] organise --> organize (PR 2) (#5077) * organise 2 * organise fix 1 * Update tyk-docs/content/basic-config-and-security/security/dashboard/organisations.md --------- Co-authored-by: Yaara <[email protected]>
1 parent 1c83f4d commit 54aca32

File tree

45 files changed

+122
-122
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+122
-122
lines changed

tyk-docs/content/advanced-configuration/integrate/3rd-party-identity-providers/dashboard-login-ldap-tib.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ TIB ships with a default `profiles.json` file which contains many example config
127127
The key attributes for LDAP profile are:
128128

129129
* `ID`: The ID by which we will activate the profile by calling the appropriate TIB endpoint
130-
* `OrgId`: The organisation id which the profile is connected to - make sure this is the correct id for your organisation (see the [Dashboard Admin API documentation]({{< ref "dashboard-admin-api/organisations" >}}) for details on how to retrieve this)
130+
* `OrgId`: The organization id which the profile is connected to - make sure this is the correct id for your organization (see the [Dashboard Admin API documentation]({{< ref "dashboard-admin-api/organisations" >}}) for details on how to retrieve this)
131131
* `IdentityHandlerConfig.DashboardCredential`: The Dashboard API Access credential which is used as authorization header
132132
* `ProviderConfig.FailureRedirect`: The URL which TIB will redirect to if the authentication fails
133133
* `ProviderConfig.LDAPPort`: The port through which TIB can communicate with your LDAP server

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

+2-2
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 "basic-config-and-security/security/authentication-authorization/openid-connect" >}}) or SAML enables an application to verify the identity of users from an organisation 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 organisation 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+
[OIDC]({{< ref "basic-config-and-security/security/authentication-authorization/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).
1717

1818
### SSO in Tyk
1919

@@ -67,7 +67,7 @@ The provider config for SAML has the following values that can be configured in
6767

6868
`FailureRedirect` - Where to redirect failed login requests.
6969

70-
`IDPMetaDataURL` - The metadata URL of your IDP which will provide Tyk Identity Broker with information about the IDP such as EntityID, Endpoints (Single Sign On Service Endpoint, Single Logout Service Endpoint), its public X.509 cert, NameId Format, Organisation info and Contact info.
70+
`IDPMetaDataURL` - The metadata URL of your IDP which will provide Tyk Identity Broker with information about the IDP such as EntityID, Endpoints (Single Sign On Service Endpoint, Single Logout Service Endpoint), its public X.509 cert, NameId Format, Organization info and Contact info.
7171

7272
This metadata XML can be signed providing a public X.509 cert and the private key.
7373

tyk-docs/content/apim-best-practice/api-security-best-practice/governance.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ tags: ["API Security", "governance"]
55
description: "Management and governance of APIs"
66
---
77

8-
APIs need to be managed and governed just like any other resource, otherwise organisations risk losing track of their API estate and becoming unaware of potentially vulnerable APIs running within their infrastructure. This risk is magnified as the number of teams, environments and APIs increases. Use API management as part of overarching business processes to control how APIs are accessed, managed and deployed.
8+
APIs need to be managed and governed just like any other resource, otherwise organizations risk losing track of their API estate and becoming unaware of potentially vulnerable APIs running within their infrastructure. This risk is magnified as the number of teams, environments and APIs increases. Use API management as part of overarching business processes to control how APIs are accessed, managed and deployed.
99

1010
**Restrict Version Availability**: Enforce the expiry of [API versions]({{< ref "getting-started/key-concepts/versioning" >}}) that are planned for deprecation, by setting a sunset date, beyond which they will not be accessible.
1111

tyk-docs/content/basic-config-and-security/report-monitor-trigger-events/event-types.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ The events currently raised by Tyk are:
1515

1616
* `QuotaExceeded`: Quota for a specific key has been exceeded
1717
* `RatelimitExceeded`: Rate limit has been exceeded for a specific key
18-
* `OrgQuotaExceeded`: Quota for a specific organisation has been exceeded
19-
* `OrgRateLimitExceeded`: Rate limit has been exceeded for a specific organisation
18+
* `OrgQuotaExceeded`: Quota for a specific organization has been exceeded
19+
* `OrgRateLimitExceeded`: Rate limit has been exceeded for a specific organization
2020
* `AuthFailure`: A key has failed authentication or has attempted access and was denied
2121
* `KeyExpired`: A key has attempted access but is expired
2222
* `VersionFailure`: A key has attempted access to a version it does not have permission to access

tyk-docs/content/basic-config-and-security/report-monitor-trigger-events/monitors.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ menu:
99
weight: 5
1010
---
1111

12-
Tyk enables you to actively monitor both users and organisation quotas. The machinery that manages these active notifications is the same as webhooks and provides an easy way to notify your stakeholders, your own organisation or the API end user when certain thresholds have been reached for their token.
12+
Tyk enables you to actively monitor both users and organization quotas. The machinery that manages these active notifications is the same as webhooks and provides an easy way to notify your stakeholders, your own organization or the API end user when certain thresholds have been reached for their token.
1313

1414
## Enabling Monitors In Your Tyk Node?
1515

@@ -43,11 +43,11 @@ From Dashboard v1.8.2, if you are using our [Developer Portal]({{< ref "tyk-deve
4343

4444

4545
* `monitor_user_keys`: Set to `true` to monitor individual tokens, this may result in a large amount of webhooks.
46-
* `monitor_org_keys`: Set to `true` to have global organisation quotas monitored.
46+
* `monitor_org_keys`: Set to `true` to have global organization quotas monitored.
4747

48-
## Setting custom triggers on a per-key or a per-organisation basis
48+
## Setting custom triggers on a per-key or a per-organization basis
4949

50-
Sometimes you will not want to have every user have a trigger event at the same levels, you can set manual trigger levels by adding a `monitor` section to the Session Object that defines a key's access details, this can also be added to the session object of an organisation ID:
50+
Sometimes you will not want to have every user have a trigger event at the same levels, you can set manual trigger levels by adding a `monitor` section to the Session Object that defines a key's access details, this can also be added to the session object of an organization ID:
5151

5252
```json
5353
"monitor": {
@@ -71,4 +71,4 @@ The webhook payload will take the following format:
7171
}
7272
```
7373

74-
If the event is triggered by an organisation, then the `key` field will be empty, if it is an auth token, then the `key` field will have raw representation of the token that caused the quota trigger to fire.
74+
If the event is triggered by an organization, then the `key` field will be empty, if it is an auth token, then the `key` field will have raw representation of the token that caused the quota trigger to fire.

tyk-docs/content/basic-config-and-security/security/authentication-authorization/basic-auth.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ curl -X POST -H "x-tyk-authorization: 352d20fe67be67f6340b4c0605b044c3" \
135135

136136
You use `POST` to create a new user and `PUT` to update an existing entry.
137137

138-
Be careful to ensure that the `org_id` is set correctly and consistently so that the Basic Authentication user is created in the correct organisation.
138+
Be careful to ensure that the `org_id` is set correctly and consistently so that the Basic Authentication user is created in the correct organization.
139139
{{< /note >}}
140140

141141
### Using the Tyk Dashboard API
@@ -180,7 +180,7 @@ curl -X POST -H "Authorization: 907aed9f88514f175f1dccf8a921f741"
180180

181181
You use `POST` to create a new user and `PUT` to update an existing entry.
182182

183-
Be careful to ensure that the `org_id` is set correctly and consistently so that the Basic Authentication user is created in the correct organisation.
183+
Be careful to ensure that the `org_id` is set correctly and consistently so that the Basic Authentication user is created in the correct organization.
184184
{{< /note >}}
185185

186186
## Extracting credentials from the request body

tyk-docs/content/basic-config-and-security/security/dashboard.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ menu:
99
weight: 3
1010
---
1111

12-
The Tyk Dashboard is a key system in Tyk that has multiple security options and concepts. In particular, this section covers how Tyk Dashboard's security model is organised, its key components and how you can interact with them to apply security settings to your dashboard in various contexts.
12+
The Tyk Dashboard is a key system in Tyk that has multiple security options and concepts. In particular, this section covers how Tyk Dashboard's security model is organized, its key components and how you can interact with them to apply security settings to your dashboard in various contexts.
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
11
---
22
date: 2017-03-23T14:40:22Z
3-
title: Organisations
4-
tags: ["Organisations", "Dashboard", "API governance", "Admin API"]
5-
description: "How organisations are created and used with the Tyk Dashboard"
3+
title: Organizations
4+
tags: ["Organizations", "Dashboard", "API governance", "Admin API"]
5+
description: "How organizations are created and used with the Tyk Dashboard"
66
menu:
77
main:
88
parent: "Dashboard"
99
weight: 1
1010
---
1111

12-
Many businesses have a complex structure, for example a lot of distinct departments where each department has its own teams. You might also need to deploy and manage multiple environments such as Production, Staging and QA for different stages in your product workflow. The Tyk Dashboard is multi-tenant capable which allows you to use a single Tyk Dashboard to host separate *organisations* for each team or environment.
12+
Many businesses have a complex structure, for example a lot of distinct departments where each department has its own teams. You might also need to deploy and manage multiple environments such as Production, Staging and QA for different stages in your product workflow. The Tyk Dashboard is multi-tenant capable which allows you to use a single Tyk Dashboard to host separate *organizations* for each team or environment.
1313

14-
An Organisation is a completely isolated unit, and has its own:
14+
An Organization is a completely isolated unit, and has its own:
1515
- API Definitions
1616
- API Keys
1717
- Users
1818
- Developers
1919
- Domain
2020
- Tyk Classic Portal
2121

22-
When bootstrapping your Dashboard, the first thing the bootstrap script does is to create a new default Organisation.
22+
When bootstrapping your Dashboard, the first thing the bootstrap script does is to create a new default Organization.
2323

24-
Additional organisations can be created and managed using the [Dashboard Admin API]({{< ref "dashboard-admin-api/organisations" >}}).
24+
Additional organizations can be created and managed using the [Dashboard Admin API]({{< ref "dashboard-admin-api/organisations" >}}).
2525

26-
### Tyk Gateway and organisations
27-
The concept of an organisation does not exist within the Tyk Gateway. Gateways only proxy and validate the rules imposed on them by the definitions and keys that are being processed, however at their core there are some security checks within the Gateway that ensure organisational ownership of objects.
26+
### Tyk Gateway and organizations
27+
The concept of an organization does not exist within the Tyk Gateway. Gateways only proxy and validate the rules imposed on them by the definitions and keys that are being processed, however at their core there are some security checks within the Gateway that ensure organizational ownership of objects.
2828

29-
Tyk allows each organisation to own its own set of Gateways, for example when you want to use different hosting providers you can segregate them in terms of resources, or just for security reasons.
29+
Tyk allows each organization to own its own set of Gateways, for example when you want to use different hosting providers you can segregate them in terms of resources, or just for security reasons.
3030

31-
Self-Managed users should use [API tagging]({{< ref "advanced-configuration/manage-multiple-environments/with-tyk-on-premises" >}}) and enforce a tagging standard across all organisations.
31+
Self-Managed users should use [API tagging]({{< ref "advanced-configuration/manage-multiple-environments/with-tyk-on-premises" >}}) and enforce a tagging standard across all organizations.
3232

33-
All actions in a Self-Managed installation of Tyk must use a base Organisation, and all actions should stem from a User owned by that organisation.
33+
All actions in a Self-Managed installation of Tyk must use a base Organization, and all actions should stem from a User owned by that organization.
3434

3535
{{< note success >}}
3636
**Note**
3737

38-
A user that does not belong to an Organisation is sometimes referred to as an *unbounded user*. These users have visibility across all Organisations, but should be granted read-only access.
38+
A user that does not belong to an Organization is sometimes referred to as an *unbounded user*. These users have visibility across all Organizations, but should be granted read-only access.
3939
{{< /note >}}

tyk-docs/content/basic-config-and-security/security/key-hashing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To set a custom algorithm, you need to set `hash_key_function` in your `tyk.conf
3030
* `murmur128`
3131
* `sha256`
3232

33-
MurMur non-cryptographic hash functions are considered as the industry fastest and conflict-prone algorithms up to date, which gives a nice balance between security and performance. With this change you now you can choose the different hash length, depending on your organisation security policies. We have also introduced a new `sha256` cryptographic key hashing algorithm, for cases when you are willing to sacrifice some performance for additional security.
33+
MurMur non-cryptographic hash functions are considered as the industry fastest and conflict-prone algorithms up to date, which gives a nice balance between security and performance. With this change you now you can choose the different hash length, depending on your organization security policies. We have also introduced a new `sha256` cryptographic key hashing algorithm, for cases when you are willing to sacrifice some performance for additional security.
3434

3535
Performance wise, setting new key hashing algorithms can increase the key hash length, as well as key length itself, so expect that your analytics data size to grow (but not that much, up to about 10%). Additionally, if you set the `sha256` algorithm, it will significantly slowdown Tyk, because cryptographic functions are slow by design but very secure.
3636

tyk-docs/content/basic-config-and-security/security/mutual-tls/concepts.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,9 @@ Returns array of meta info objects, similar to above.
7070
The Dashboard Admin API is very similar, except for a few minor differences:
7171

7272
* Endpoints start with `/api` instead of `/tyk`, e.g. `/api/certs`, `/api/certs/<cert-id>`, etc.
73-
* All certificates are managed in the context of the organisation. In other words, certificates are not shared between organisations.
73+
* All certificates are managed in the context of the organization. In other words, certificates are not shared between organizations.
7474

75-
Certificate storage uses a hex encoded certificate SHA256 fingerprint as its ID. When used with the Dashboard API, Tyk additionally appends the organisation id to the certificate fingerprint. It means that certificate IDs are predictable, and you can check certificates by their IDs by manually
75+
Certificate storage uses a hex encoded certificate SHA256 fingerprint as its ID. When used with the Dashboard API, Tyk additionally appends the organization id to the certificate fingerprint. It means that certificate IDs are predictable, and you can check certificates by their IDs by manually
7676
generating certificate SHA256 fingerprint using the following command:
7777

7878
```{.copyWrapper}

tyk-docs/content/basic-config-and-security/security/owasp-top-ten.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ In addition, it is best practice to consider any definition of done to include c
120120

121121
Attackers may identify and target the third party APIs/services used by an API. This can lead to leaked sensitive information, denial of service, injection attacks etc.
122122

123-
It is the responsibility of the API to provide protection against these attacks. However, if the organisation uses the Gateway as a forwarding proxy to third party APIs, then the following features could be used:
123+
It is the responsibility of the API to provide protection against these attacks. However, if the organization uses the Gateway as a forwarding proxy to third party APIs, then the following features could be used:
124124

125125
- [JSON Schema validation]({{< ref "product-stack/tyk-gateway/middleware/validate-request-tyk-classic" >}}) to validate that an incoming data payload meets a defined schema. Payloads that do not adhere to the schema are rejected.
126126
- [TLS]({{< ref "basic-config-and-security/security/tls-and-ssl" >}}) to ensure that clients use the right service and encrypt traffic.

tyk-docs/content/deployment-and-operations/tyk-self-managed/deployment-lifecycle/deployment-to-production/key-value-storage/vault.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Alternatively, you can configure it using the equivalent [environment variables]
3939

4040
### How key-value data is stored in Vault
4141

42-
In traditional systems secrets are typically stored individually, each with their own unique key. Vault, however, allows for a more flexible approach where multiple *keys* can be grouped together and stored under a single *secret*. This grouping allows for better organisation and management of related secrets, making it easier to retrieve and manage them collectively.
42+
In traditional systems secrets are typically stored individually, each with their own unique key. Vault, however, allows for a more flexible approach where multiple *keys* can be grouped together and stored under a single *secret*. This grouping allows for better organization and management of related secrets, making it easier to retrieve and manage them collectively.
4343

4444
When retrieving data from Vault, you use the dot notation (`secret.key`) to access the *value* from a specific *key* within a *secret*.
4545

tyk-docs/content/graphql/creating-gql-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Your GQL API is now secured and ready to use.
7676

7777
It is possible to create GQL APIs using [Tyk Dashboard APIs]({{< ref "/tyk-apis/tyk-dashboard-api/api-definitions">}}). To make things easier you can use our [Postman collection](https://www.postman.com/tyk-technologies/workspace/tyk-public-workspace/overview).
7878

79-
You will need an API key for your organisation and one command to create a GQL API and make it live.
79+
You will need an API key for your organization and one command to create a GQL API and make it live.
8080
### Obtain your Tyk Dashboard API Access Credentials key & Dashboard URL
8181

8282
From the Tyk Dashboard, select "Users" from the "System Management" section.

tyk-docs/content/plugins/how-to-serve-plugins/plugin-bundles.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ A complete API Definition would look like:
154154
## Downloading and Updating Bundles
155155
Tyk will fetch `http://my-bundle-server.com/bundles/bundle-latest.zip` on start. A plugin bundle will be cached after its initial download, if a Tyk reload event occurs, the same contents will be used. If you want to replace it, you must update your API configuration to use a different name and then trigger a reload.
156156

157-
As a suggestion, you may organise this using a Git commit reference or version number, e.g. `bundle-e5e6044.zip`, `bundle-48714c8.zip`, `bundle-1.0.0.zip`, `bundle-1.0.1.zip`, etc.
157+
As a suggestion, you may organize this using a Git commit reference or version number, e.g. `bundle-e5e6044.zip`, `bundle-48714c8.zip`, `bundle-1.0.0.zip`, `bundle-1.0.1.zip`, etc.
158158

159159
Alternatively, you may delete the cached bundle from Tyk manually and then trigger a hot reload to tell Tyk to fetch a new one. By default, Tyk will store downloaded bundles in this path:
160160
`{ TYK_ROOT } / { CONFIG_MIDDLEWARE_PATH } / bundles`

0 commit comments

Comments
 (0)