Skip to content

Commit

Permalink
[DX-1437] organise --> organize (PR 3) (#5085)
Browse files Browse the repository at this point in the history
* organise 3

---------

Co-authored-by: Yaara <[email protected]>
  • Loading branch information
Roeegg2 and letzya authored Jul 16, 2024
1 parent cf48485 commit 7f5c851
Show file tree
Hide file tree
Showing 40 changed files with 70 additions and 70 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Audit records the following fields for `json` format:
| Field | Description |
| ---- | ---- |
| req_id | Unique request ID |
| org_id | Organisation ID |
| org_id | Organization ID |
| date | Date in *RFC1123* format |
| timestamp | UNIX timestamp |
| ip | IP address the request originated from |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ Please note that this list only refers to v1.9.0 of the portal. The list of endp
| Users | /users/{user_id} |
| Users | /users/{user_id}/custom-attributes |
| Users | /users/{user_id}/custom-attributes/{custom-attribute_id} |
| Organisations | /organisations |
| Organisations | /organisations/{organisation_id} |
| Organizations | /organisations |
| Organizations | /organisations/{organisation_id} |
| Teams | /organisations/{organisation_id}/teams |
| Teams | /organisations/{organisation_id}/teams |
| Products | /products |
Expand Down Expand Up @@ -137,9 +137,9 @@ Please note that this list only refers to v1.9.0 of the portal. The list of endp
| Users | /admin/admin_users/{user_id}/send_invite |
| Users | /admin/users/{user_id}/deactivate |
| Users | /admin/admin_users/{user_id}/deactivate |
| Organisations | /admin/organisations |
| Organisations | /admin/organisations/new |
| Organisations | /admin/organisations/org:{organisation_id} |
| Organizations | /admin/organisations |
| Organizations | /admin/organisations/new |
| Organizations | /admin/organisations/org:{organisation_id} |
| Teams | /admin/teams |
| Teams | /admin/teams/new |
| Teams | /admin/teams/{team_id} |
Expand Down Expand Up @@ -214,11 +214,11 @@ Please note that this list only refers to v1.9.0 of the portal. The list of endp
| Apps | /portal/private/apps/{app_id}/cert/{cert_id} |
| Credentials | /portal/private/credentials |
| Profile | /portal/private/profile |
| Organisation Flow | /portal/private/organisation |
| Organisation Flow | /portal/private/users |
| Organisation Flow | /portal/private/users/{user_id} |
| Organisation Flow | /portal/private/users/{user_id}/edit |
| Organisation Flow | /portal/private/users/invite |
| Organization Flow | /portal/private/organisation |
| Organization Flow | /portal/private/users |
| Organization Flow | /portal/private/users/{user_id} |
| Organization Flow | /portal/private/users/{user_id}/edit |
| Organization Flow | /portal/private/users/invite |
| Analytics | /portal/private/analytics |
| Analytics | /portal/private/analytics/api/chart/overview |
| Analytics | /portal/private/analytics/api/chart/traffic |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
date: 2017-03-27T17:02:56+01:00
title: Organisation quota has been exceeded“ error in the Dashboard API
title: Organization quota has been exceeded“ error in the Dashboard API
menu:
main:
parent: "Tyk Cloud Classic"
Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/troubleshooting/tyk-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ weight: 5

[“504 GATEWAY_TIMEOUT“ error]({{< ref "troubleshooting/tyk-cloud-classic/504-gateway-timeout-error" >}})

[Organisation quota has been exceeded“ error in the Dashboard API]({{< ref "troubleshooting/tyk-cloud-classic/organisation-quota-exceeded-error-dashboard-api" >}})
[Organization quota has been exceeded“ error in the Dashboard API]({{< ref "troubleshooting/tyk-cloud-classic/organisation-quota-exceeded-error-dashboard-api" >}})

["301 Moved Permanently"]({{< ref "troubleshooting/tyk-cloud-classic/301-moved-permanently" >}})
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ The UI for setting the domain name has a very strict validation, so it may just

### Solution

The best way to set the domain is to use the Tyk Dashboard Admin API, to obtain the organisation object via a GET request and then update the object using a PUT request with the relevant CNAME added to the body of the request.<sup>[[1]({{<ref "dashboard-admin-api/organisations">}})]</sup> Restarting the process will then set the domain.
The best way to set the domain is to use the Tyk Dashboard Admin API, to obtain the organization object via a GET request and then update the object using a PUT request with the relevant CNAME added to the body of the request.<sup>[[1]({{<ref "dashboard-admin-api/organisations">}})]</sup> Restarting the process will then set the domain.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ weight: 5

### Cause

There are a number of reasons, most commonly, an API may have been configured incorrectly in some way (for instance, it may have been set up without an organisation). The error itself is a specific to Go language which Tyk was written in and could also suggest that alterations made to the code by the user could also be the culprit.
There are a number of reasons, most commonly, an API may have been configured incorrectly in some way (for instance, it may have been set up without an organization). The error itself is a specific to Go language which Tyk was written in and could also suggest that alterations made to the code by the user could also be the culprit.

### Solution

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ weight: 5

### Description

When running the `bootstrap.sh` script to set up the default Organisation and User when installing the Self-Managed version on Red Hat/Centos, the script fails when setting up the default user, returning a "Unable to parse JSON" Error.
When running the `bootstrap.sh` script to set up the default Organization and User when installing the Self-Managed version on Red Hat/Centos, the script fails when setting up the default user, returning a "Unable to parse JSON" Error.

```
Adding new user
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You can see data in the log browser but the rest of the reports display nothing.

### Solution

If your Pump is configured to use `mongo_selective_pump` (e.g. store data in a collection per organisation), ensure that the [Dashboard configuration setting]({{< ref "tyk-dashboard/configuration" >}}) `use_sharded_analytics` is set to `true`.
If your Pump is configured to use `mongo_selective_pump` (e.g. store data in a collection per organization), ensure that the [Dashboard configuration setting]({{< ref "tyk-dashboard/configuration" >}}) `use_sharded_analytics` is set to `true`.

The same applies in the reverse direction. If you are using `mongo-pump-aggregate` in your [pump configuration]({{< ref "tyk-pump/configuration" >}}), set `use_sharded_analytics` to false.

Expand Down
4 changes: 2 additions & 2 deletions tyk-docs/content/tyk-apis/tyk-dashboard-admin-api/export.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ In a production environment, you will need to change the default `admin_Secret`
{{< /warning >}}


#### Export Organisations
#### Export Organizations

The organisation object is the most fundamental object in a Tyk setup, all other ownership properties hang off the relationship between an organisation and its APIs, Policies and API Tokens.
The organization object is the most fundamental object in a Tyk setup, all other ownership properties hang off the relationship between an organization and its APIs, Policies and API Tokens.

| **Property** | **Description** |
| ------------ | ------------------------------- |
Expand Down
6 changes: 3 additions & 3 deletions tyk-docs/content/tyk-apis/tyk-dashboard-admin-api/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ menu:
weight: 4
---

The import API enables you to add Organisations, APIs and Policies back into a Tyk installation while retaining their base IDs so that they work together.
The import API enables you to add *Organizations*, *APIs* and *Policies* back into a Tyk installation while retaining their base IDs so that they work together.

{{< note success >}}
**Note**
Expand All @@ -22,9 +22,9 @@ To enable this feature, the minimum required versions for the Gateway and Dashbo
In a production environment, you will need to change the default `admin_secret` value that is called by the `admin-auth` header in your `tyk_analytics.conf` file. This is located in `/opt/tyk-dashboard`.
{{< /warning >}}

#### Import Organisation
#### Import Organization

The [Organisation object]({{<ref "basic-config-and-security/security/dashboard/organisations#concept-dashboard-organisations" >}}) is the most fundamental object in a Tyk setup, all other ownership properties hang off the relationship between an Organisation and its APIs, Policies and API Tokens.
The [Organization object]({{<ref "basic-config-and-security/security/dashboard/organisations#concept-dashboard-organisations" >}}) is the most fundamental object in a Tyk setup, all other ownership properties hang off the relationship between an Organization and its APIs, Policies and API Tokens.

| **Property** | **Description** |
| ------------ | ---------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/tyk-apis/tyk-dashboard-admin-api/sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The Dashboard exposes the `/admin/sso` Admin API which allows you to generate a
You should provide JSON payload with the following data:

* `ForSection` - scope with possible values of `"dashboard"` or `"portal"`
* `OrgID` - with your organisation id.
* `OrgID` - with your organization id.
* `GroupID` - the group id
* `EmailAddress` - user email

Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/tyk-apis/tyk-dashboard-admin-api/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ admin-auth: 12345
{{< note success >}}
**Note**

You can also create a user without an `org_id`. This will create a "Super User", who has global access to all APIs, Policies, etc, for all organisations created within Tyk.
You can also create a user without an `org_id`. This will create a "Super User", who has global access to all APIs, Policies, etc, for all organizations created within Tyk.
{{< /note >}}


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ menu:
weight: 5
---

Basic Auth users are essentially a form of API token, just with a customized, pre-set organisation-specific ID instead of a generated one. To interact with basic auth users, you can use the API Token API calls (list, get delete etc.)
Basic Auth users are essentially a form of API token, just with a customized, pre-set organization-specific ID instead of a generated one. To interact with basic auth users, you can use the API Token API calls (list, get delete etc.)

### Create a user

Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/tyk-apis/tyk-dashboard-api/sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The Dashboard exposes the `/api/sso` Dashboard API which allows you to generate
You should provide JSON payload with the following data:

* `ForSection` - scope with possible values of `"dashboard"` or `"portal"` only.
* `OrgID` - organisation id
* `OrgID` - organization id
* `EmailAddress` - user email
* `GroupID` - user group id ( it is the mongo id and you can can find it in the url when opening a user group via Tyk- Dashboard UI or if you call Tyk-Dashboard REST API `/api/usergroups` )

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ A session object takes the following form:

* `access_rights`: This section is defined in the Access Control section of this documentation, use this section define what APIs and versions this token has access to.

* `org_id`: The organisation 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 organisations. See the Organisations Quotas section of the [Tyk Gateway API]({{< ref "tyk-gateway-api" >}}).
* `org_id`: The organisation 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 organisations. See the Organizations Quotas section of the [Tyk Gateway API]({{< ref "tyk-gateway-api" >}}).

* `oauth_client_id`: This is set by Tyk if the token is generated by an OAuth client during an OAuth authorization flow.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ aliases:

## Introduction

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 Organization is your "container" for all your Environments, Control Planes and Cloud Data Planes. When you setup your Organization 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.

## Organization Overview Screen

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Now that you have created the new Tyk Cloud account with your basic details, it

## Steps to set up your organization

* **Step 1 - Name your Organisation:** Give your organization a name. This is up to you, but most users use their company name.
* **Step 1 - Name your Organization:** Give your organization a name. This is up to you, but most users use their company name.

* **Step 2 - Select a Home Region:** Select a region from the drop-down list where your [Control Plane]({{< ref "tyk-cloud/troubleshooting-&-support/glossary.md#control-plane" >}}) will be deployed and your data stored. The number of regions available will depend on your license. Further regions can be added as an upgrade option.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ Out of the box, the following roles are setup:

* **Team member:** They can manage deployment activity for the team they are added to.
* **Team admin:** They can manage deployment activity and users for the team they are added to.
* **Organisation admin:** They can manage deployment activity and users for a single organization.
* **Organization admin:** They can manage deployment activity and users for a single organization.

Next you'll create an [Environment]({{< ref "tyk-cloud/getting-started-tyk-cloud/setup-environment" >}}).
2 changes: 1 addition & 1 deletion tyk-docs/content/tyk-cloud/teams-&-users/managing-teams.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ aliases:

The following [user roles]({{< ref "tyk-cloud/teams-&-users/user-roles.md" >}}) can perform existing Team Admin tasks:

* Organisation Admin - Can manage all teams in the organization they are a member of.
* Organization Admin - Can manage all teams in the organization they are a member of.
* Team Admin - Can only manage the team they are a member of.

For an existing team, you can:
Expand Down
4 changes: 2 additions & 2 deletions tyk-docs/content/tyk-cloud/teams-&-users/managing-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ aliases:

The following [user roles]({{< ref "tyk-cloud/teams-&-users/user-roles.md" >}}) can perform existing User Admin tasks:

* [Organisation Admin]({{< ref "tyk-cloud/teams-&-users/user-roles.md#user-roles-within-tyk-cloud" >}}) - Can manage all users in the organization they are a member of.
* [Organization Admin]({{< ref "tyk-cloud/teams-&-users/user-roles.md#user-roles-within-tyk-cloud" >}}) - Can manage all users in the organization they are a member of.
* [Team Admin]({{< ref "tyk-cloud/teams-&-users/user-roles.md#user-roles-within-tyk-cloud" >}}) - Can only manage the users of the team they are a member of.

{{< note success >}}
**Note**

Organisation Admins, Team Admins and Team Members are responsible for managing the Tyk Cloud organization hierarchy and deploying/managing stacks, as well as having access to the Tyk Dashboard to manage APIs. Users of Tyk Cloud are usually DevOps, Architects and sometimes Engineers or Managers.
Organization Admins, Team Admins and Team Members are responsible for managing the Tyk Cloud organization hierarchy and deploying/managing stacks, as well as having access to the Tyk Dashboard to manage APIs. Users of Tyk Cloud are usually DevOps, Architects and sometimes Engineers or Managers.

You can also [add users to the Tyk Dashboard]({{< ref "basic-config-and-security/security/dashboard/create-users" >}}) itself instead of inviting them as Tyk Cloud users. These users would likely be your API Developers and Engineers who manage the APIs.
{{< /note >}}
Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/tyk-cloud/teams-&-users/user-roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ We have the following user roles defined in Tyk Cloud for your team members
* Team Admin
* Team Member

Billing Admins are responsible for the billing management of the Tyk Cloud account. Organisation Admins, Team Admins and Team Members are responsible for managing the Tyk Cloud organization hierarchy and deploying/managing stacks, as well as having access to the Tyk Dashboard to manage APIs. Users of Tyk Cloud are usually DevOps, Architects and sometimes Engineers or Managers.
Billing Admins are responsible for the billing management of the Tyk Cloud account. Organization Admins, Team Admins and Team Members are responsible for managing the Tyk Cloud organization hierarchy and deploying/managing stacks, as well as having access to the Tyk Dashboard to manage APIs. Users of Tyk Cloud are usually DevOps, Architects and sometimes Engineers or Managers.

You can [add users to the Tyk Dashboard]({{< ref "basic-config-and-security/security/dashboard/create-users" >}}) itself instead of inviting them as Tyk Cloud users. These users would likely be your API Developers and Engineers who manage the APIs.

Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/tyk-dashboard-api/org/opa.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ For more information on how to configure OPA see [Open Policy Agent]({{< ref "ty

This endpoint returns by defaul the initial set of OPA rules defined in your Tyk Dashboard, which are located in [schema/dashboard.rego]({{< ref "tyk-dashboard/opa-rules" >}}) (accessible in Self-Managed installations).

Once you update the rules via the API, the OPA rules will be stored at the organisation level.
Once you update the rules via the API, the OPA rules will be stored at the organization level.

| **Property** | **Description** |
| ------------ | --------------------- |
Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/tyk-dashboard-api/org/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Only Admin Dashboard users will be authorized to use this API.
### List Additional Permissions
This API returns by default the initial set of additional permissions defined in your Tyk Dashboard configuration, under [security.additional_permissions]({{< ref "tyk-dashboard/configuration#securityadditional_permissions" >}}).

Once you update the permissions via the API, they will be stored at organisation level.
Once you update the permissions via the API, they will be stored at organization level.

| **Property** | **Description** |
| ------------ | --------------------- |
Expand Down
Loading

0 comments on commit 7f5c851

Please sign in to comment.