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
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a security check for org_id against authorized IDs before user creation
To enhance security, consider adding a note about verifying the org_id against a list of authorized IDs within the system before creating a Basic Authentication user. This ensures that users are created within the correct and authorized organization context.
-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.+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. Always verify the `org_id` against your system's list of authorized organization IDs before creating a user.
Suggestion importance[1-10]: 9
Why: This suggestion enhances security by ensuring that the org_id is verified against a list of authorized IDs, preventing unauthorized user creation.
9
Enhance the security warning for IP Whitelisting to emphasize best practices
For security documentation, it's crucial to emphasize the limitations and risks of IP Whitelisting more prominently to ensure users are aware of security best practices.
-IP Whitelisting is susceptible to IP Spoofing, and it is recommended to be combined with an API Key in secure environments.+Please note, IP Whitelisting has vulnerabilities such as susceptibility to IP Spoofing. It is strongly recommended to use it in conjunction with an API Key or other authentication methods to ensure a higher level of security in your environments.
Suggestion importance[1-10]: 9
Why: The suggestion significantly improves the security documentation by emphasizing the risks associated with IP Whitelisting and recommending additional security measures, which is important for maintaining secure environments.
9
Clarity
Clarify that a user can only belong to one organization at a time
To avoid potential confusion, consider specifying that a user can only belong to one organization at a time, as the current wording might imply a user can belong to multiple organizations.
-**Users** - External developers / portal users. A user can belong to multiple teams but can only belong to one organization.+**Users** - External developers / portal users. A user can belong to multiple teams but is restricted to a single organization at any given time.
Suggestion importance[1-10]: 9
Why: This suggestion addresses potential confusion and provides a clearer understanding of user organization membership, which is crucial for accurate documentation.
9
Enhancement
Provide a direct link to the specific documentation section on retrieving an organization ID
It's recommended to provide a direct link to the specific section in the Dashboard Admin API documentation that details how to retrieve the organization ID, rather than just linking to the main page. This would improve user experience by making the information more accessible.
-* `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)+* `OrgId`: The organization id which the profile is connected to - make sure this is the correct id for your organization. For details on how to retrieve this, see the specific section in the [Dashboard Admin API documentation]({{< ref "dashboard-admin-api/organisations#retrieving-an-organization-id" >}})
Suggestion importance[1-10]: 8
Why: This suggestion improves user experience by providing a direct link to the specific section in the documentation, making it easier for users to find the information they need.
8
Provide the specific command for generating a certificate SHA256 fingerprint
To improve clarity, it would be helpful to complete the sentence about generating the certificate SHA256 fingerprint and provide the specific command needed. This addition will aid users in managing certificates more effectively.
-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+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 generating the SHA256 fingerprint using the following command:+```bash+openssl x509 -noout -fingerprint -sha256 -inform pem -in [your-certificate-file.crt]+```
Suggestion importance[1-10]: 8
Why: Including the specific command for generating a certificate SHA256 fingerprint improves clarity and aids users in managing certificates more effectively.
8
Clarify what "Enhanced(silver) support" includes
To avoid ambiguity, consider specifying what "Enhanced(silver) support" includes or linking to a page with detailed information about what support levels entail.
-This plan includes all of the features of the Tyk Stack. **Enhanced(silver) support** will be provided.+This plan includes all of the features of the Tyk Stack. **Enhanced(silver) support** will be provided, which includes 24/7 support with a maximum response time of 2 hours for critical issues. [More about support levels](#support-levels).
Suggestion importance[1-10]: 8
Why: The suggestion provides important details about support levels, which can significantly help users understand what they are getting. This is crucial for setting expectations.
8
Improve clarity and reduce redundancy in the definition of "Organisations"
Consider rephrasing the definition of "Organisations" to avoid redundancy and enhance clarity. The phrase "An organization can be used which can include multiple teams" is somewhat redundant and could be simplified.
-**Organisations** - An organization can represent larger business units of a company. It works as a container for various teams and users. An organization can be used which can include multiple teams.+**Organisations** - Represents larger business units within a company, serving as a container for various teams and users.
Suggestion importance[1-10]: 8
Why: The suggestion effectively removes redundancy and enhances clarity, making the definition more concise and easier to understand.
8
Add an example to clarify how org_id interacts with tokens
Consider adding a brief explanation or example of how the org_id setting in the API Definition object interacts with tokens owned by organizations. This will enhance the clarity and usability of the documentation.
-The organization this user belongs to. This can be used in conjunction with the org_id setting in the API Definition object to have tokens "owned" by organizations.+The organization this user belongs to. This can be used in conjunction with the `org_id` setting in the API Definition object to have tokens "owned" by organizations, for example, restricting API access to members of the same organization.
Suggestion importance[1-10]: 7
Why: The suggestion improves clarity by providing an example, which can help users understand the interaction better. However, it is not crucial for functionality.
7
Explain the implications of the fixed home region setting
Adding a note about the implications of not being able to change the home region after creating an organization could provide users with better guidance on setting up their account.
-Your Organisation is your "container" for all your Environments, Control Planes and Cloud Data Planes. When you setup your Organisation when [creating your account]({{< ref "tyk-cloud/getting-started-tyk-cloud/create-account" >}}), you assign it to a Home Region where all your data is stored. You cannot change this home region after creating your organization.+Your Organisation is your "container" for all your Environments, Control Planes and Cloud Data Planes. When you setup your Organisation when [creating your account]({{< ref "tyk-cloud/getting-started-tyk-cloud/create-account" >}}), you assign it to a Home Region where all your data is stored. You cannot change this home region after creating your organization, which is crucial for data compliance and latency considerations.
Suggestion importance[1-10]: 7
Why: The suggestion adds valuable context about the implications of the fixed home region, which can help users make informed decisions. However, it is not critical for immediate functionality.
7
Clarify the limitations on region selection based on subscription plans
It's recommended to clarify the limitations on the number of regions available for the Cloud Data Plane based on the subscription plan. This can help users make informed decisions during setup.
-* **Step 3 - Configure your first Cloud Data Data Plane:** Select the region you want to locate your [Cloud Data Plane]({{< ref "tyk-cloud/troubleshooting-&-support/glossary.md#cloud-data-plane" >}}) in from the drop-down list. Your Cloud Data Plane is not confined to the same region as your Organization and Control Plane but the amount of regions you have to choose from can be limited depending on your subscription plan. Give your Cloud Data Plane a name.+* **Step 3 - Configure your first Cloud Data Plane:** Select the region you want to locate your [Cloud Data Plane]({{< ref "tyk-cloud/troubleshooting-&-support/glossary.md#cloud-data-plane" >}}) in from the drop-down list. Note that the number of available regions for your Cloud Data Plane may vary based on your subscription plan. Give your Cloud Data Plane a name.
Suggestion importance[1-10]: 7
Why: The suggestion improves clarity by explicitly stating the limitations on region selection based on subscription plans, which can help users make more informed decisions. However, the existing text already implies this, so the improvement is minor.
7
Specify exclusive permissions of the account creator Organization Admin
It would be beneficial to specify the permissions or actions that the account creator Organization Admin can perform, which are not available to other roles, to distinguish this role clearly.
-* Be the account creator Organization Admin (this user also has the Billing Admin role assigned to them)+* Be the account creator Organization Admin (this user also has the Billing Admin role assigned to them, with exclusive permissions such as managing billing settings and user roles)
Suggestion importance[1-10]: 6
Why: The suggestion adds useful information about the specific permissions of the account creator Organization Admin, enhancing the documentation's clarity. However, it addresses a minor detail.
6
Clarification
Specify the permanence of the organization's regional connection
To enhance clarity, it's beneficial to specify that the organization's connection to a single region is a permanent setting that cannot be changed after initial setup.
-* An organization is the main entity for all your data (Environments, APIs, Users, etc)-* An Organization is connected to a single region and once connected, cannot be changed.+* An organization is the main entity for all your data (Environments, APIs, Users, etc). Once an organization is connected to a region during setup, this setting is permanent and cannot be changed.
Suggestion importance[1-10]: 8
Why: This suggestion enhances clarity by explicitly stating that the organization's regional connection is permanent, which is crucial information for users during the setup process.
8
Clarify the role required for creating or deleting teams
To avoid ambiguity, explicitly mention that the 'Organization Admin' role is required to perform certain administrative actions such as creating or deleting teams.
-* Create or delete a team (Organization Admin only)+* Create or delete a team. Note: Only users with the 'Organization Admin' role have the permissions to perform this action.
Suggestion importance[1-10]: 7
Why: The suggestion reduces ambiguity by clearly stating that only users with the 'Organization Admin' role can create or delete teams, which helps in understanding role-based permissions better.
7
Readability
Simplify the explanation of the default setup during the Tyk Portal installation
The explanation of the default setup during the Tyk Portal installation could be more concise and direct, enhancing the overall readability and understanding.
-When installing the Tyk Portal, by default the API Consumers section will already have a default organization with a default team added. This means, if your specific use case doesn't require multiple organizations and teams, you can get started straight away and invite a new external user to the developer portal, adding them to the default organization and default team.+Upon installing the Tyk Portal, the API Consumers section includes a default organization and team. This setup allows immediate onboarding of new external users to the default organization and team, unless your use case requires additional organizations and teams.
Suggestion importance[1-10]: 8
Why: The suggestion makes the explanation more concise and direct, improving readability and comprehension without losing essential information.
8
Enhance the readability of the "Teams" description
The sentence structure in the description of "Teams" could be improved for better readability. Specifically, the phrase "a team always needs to be part of an organization" could be more integrated into the sentence.
-**Teams** - Teams are used to bundle multiple users, a team always needs to be part of an organization.+**Teams** - Comprising multiple users, each team must be part of an organization.
Suggestion importance[1-10]: 7
Why: The improved sentence structure increases readability and flow, making the description clearer without changing the meaning.
7
Best practice
Include an example of how to configure the sha256 hashing algorithm
It would be beneficial to include a brief example or code snippet demonstrating how to set the sha256 algorithm in the configuration. This practical example can help users implement the suggested security enhancement more effectively.
-We have also introduced a new `sha256` cryptographic key hashing algorithm, for cases when you are willing to sacrifice some performance for additional security.+We have also introduced a new `sha256` cryptographic key hashing algorithm, for cases when you are willing to sacrifice some performance for additional security. To use this algorithm, set the `hash_algorithm` configuration to `sha256` in your Tyk setup:+```json+{+ "hash_algorithm": "sha256"+}+```
Suggestion importance[1-10]: 7
Why: Providing a practical example helps users implement the sha256 hashing algorithm more effectively, improving the documentation's usefulness.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
buger
deleted the
merge/release-5.4/2596815a4e8c344b0dfd6ec5fbcd8c16dafcdcce
branch
User description
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]
PR Type
documentation
Description
Changes walkthrough 📝
45 files
dashboard-login-ldap-tib.md
Standardize spelling of "organization" in LDAP profile documentationtyk-docs/content/advanced-configuration/integrate/3rd-party-identity-providers/dashboard-login-ldap-tib.md
sso.md
Standardize spelling of "organization" in SSO documentationtyk-docs/content/advanced-configuration/integrate/sso.md
governance.md
Standardize spelling of "organizations" in API security governancedocumentationtyk-docs/content/apim-best-practice/api-security-best-practice/governance.md
event-types.md
Standardize spelling of "organization" in event types documentationtyk-docs/content/basic-config-and-security/report-monitor-trigger-events/event-types.md
monitors.md
Standardize spelling of "organization" in monitors documentationtyk-docs/content/basic-config-and-security/report-monitor-trigger-events/monitors.md
basic-auth.md
Standardize spelling of "organization" in basic authenticationdocumentationtyk-docs/content/basic-config-and-security/security/authentication-authorization/basic-auth.md
dashboard.md
Standardize spelling of "organized" in dashboard securitydocumentationtyk-docs/content/basic-config-and-security/security/dashboard.md
organisations.md
Standardize spelling of "organizations" in dashboard organizationsdocumentationtyk-docs/content/basic-config-and-security/security/dashboard/organisations.md
key-hashing.md
Standardize spelling of "organization" in key hashing documentationtyk-docs/content/basic-config-and-security/security/key-hashing.md
concepts.md
Standardize spelling of "organization" in mutual TLS conceptsdocumentationtyk-docs/content/basic-config-and-security/security/mutual-tls/concepts.md
owasp-top-ten.md
Standardize spelling of "organization" in OWASP top ten documentationtyk-docs/content/basic-config-and-security/security/owasp-top-ten.md
vault.md
Standardize spelling of "organization" in Vault key-value storagedocumentationtyk-docs/content/deployment-and-operations/tyk-self-managed/deployment-lifecycle/deployment-to-production/key-value-storage/vault.md
creating-gql-api.md
Standardize spelling of "organization" in GraphQL API creationdocumentationtyk-docs/content/graphql/creating-gql-api.md
plugin-bundles.md
Standardize spelling of "organize" in plugin bundles documentationtyk-docs/content/plugins/how-to-serve-plugins/plugin-bundles.md
middleware-scripting-guide.md
Standardize spelling of "organization" in JavaScript middlewarescripting guidetyk-docs/content/plugins/supported-languages/javascript-middleware/middleware-scripting-guide.md
custom-auth-python.md
Standardize spelling of "organization" in gRPC custom auth Pythondocumentationtyk-docs/content/plugins/supported-languages/rich-plugins/grpc/custom-auth-python.md
rich-plugins-data-structures.md
Standardize spelling of "organization" in rich plugins data structuresdocumentationtyk-docs/content/plugins/supported-languages/rich-plugins/rich-plugins-data-structures.md
account-billing.md
Standardize spelling of "organization" in account and billingdocumentationtyk-docs/content/tyk-cloud/account-billing.md
managing-billing-admins.md
Standardize spelling of "Organization Admin" in managing billingadmins documentationtyk-docs/content/tyk-cloud/account-billing/managing-billing-admins.md
plans.md
Standardize spelling of "organizations" in plans documentationtyk-docs/content/tyk-cloud/account-billing/plans.md
retirement.md
Standardize spelling of "organization" in retirement documentationtyk-docs/content/tyk-cloud/account-billing/retirement.md
upgrade-free-trial.md
Standardize spelling of "organization" in upgrade free trialdocumentationtyk-docs/content/tyk-cloud/account-billing/upgrade-free-trial.md
environments-&-deployments.md
Standardize spelling of "organizations" in environments anddeployments documentationtyk-docs/content/tyk-cloud/environments-&-deployments.md
managing-control-planes.md
Standardize spelling of "Organization Admin" in managing controlplanes documentationtyk-docs/content/tyk-cloud/environments-&-deployments/managing-control-planes.md
managing-environments.md
Standardize spelling of "organization" in managing environmentsdocumentationtyk-docs/content/tyk-cloud/environments-&-deployments/managing-environments.md
managing-gateways.md
Standardize spelling of "organization" in managing gatewaysdocumentationtyk-docs/content/tyk-cloud/environments-&-deployments/managing-gateways.md
managing-organisations.md
Standardize spelling of "organizations" in managing organizationsdocumentationtyk-docs/content/tyk-cloud/environments-&-deployments/managing-organisations.md
hybrid-gateways-helm.md
Standardize spelling of "Organization ID" in hybrid gateways Helmdocumentationtyk-docs/content/tyk-cloud/environments-deployments/hybrid-gateways-helm.md
hybrid-gateways.md
Standardize spelling of "Organization ID" in hybrid gatewaysdocumentationtyk-docs/content/tyk-cloud/environments-deployments/hybrid-gateways.md
create-account.md
Standardize spelling of "organization" in create account documentationtyk-docs/content/tyk-cloud/getting-started-tyk-cloud/create-account.md
setup-environment.md
Standardize spelling of "organization" in setup environmentdocumentationtyk-docs/content/tyk-cloud/getting-started-tyk-cloud/setup-environment.md
setup-org.md
Standardize spelling of "organization" in setup organizationdocumentationtyk-docs/content/tyk-cloud/getting-started-tyk-cloud/setup-org.md
setup-team.md
Standardize spelling of "organization" in setup team documentationtyk-docs/content/tyk-cloud/getting-started-tyk-cloud/setup-team.md
to-conclude.md
Standardize spelling of "Organization" in to conclude documentationtyk-docs/content/tyk-cloud/getting-started-tyk-cloud/to-conclude.md
getting-started.md
Standardize spelling of "organization" in getting starteddocumentationtyk-docs/content/tyk-cloud/getting-started.md
securing-your-apis.md
Standardize spelling of "organization" in securing your APIsdocumentationtyk-docs/content/tyk-cloud/securing-your-apis.md
managing-teams.md
Standardize spelling of "organization" in managing teams documentationtyk-docs/content/tyk-cloud/teams-&-users/managing-teams.md
managing-users.md
Standardize spelling of "organization" in managing users documentationtyk-docs/content/tyk-cloud/teams-&-users/managing-users.md
user-roles.md
Standardize spelling of "organization" in user roles documentationtyk-docs/content/tyk-cloud/teams-&-users/user-roles.md
glossary.md
Standardize spelling of "organization" in glossary documentationtyk-docs/content/tyk-cloud/troubleshooting-&-support/glossary.md
what-is-tyk-cloud.md
Standardize spelling of "organizations" in what is Tyk Clouddocumentationtyk-docs/content/tyk-cloud/what-is-tyk-cloud.md
invite-codes.md
Standardize spelling of "organization" in invite codes documentationtyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/invite-codes.md
manage-api-consumers.md
Standardize spelling of "organizations" in manage API consumersdocumentationtyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/manage-api-consumers.md
manage-api-users.md
Standardize spelling of "organization" in manage API usersdocumentationtyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/manage-api-users.md
managing-access.md
Standardize spelling of "organizations" in managing accessdocumentationtyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/managing-access.md