Skip to content

Commit 1269d4a

Browse files
author
Dan Costello
committed
Dash to colon
1 parent 86d923e commit 1269d4a

File tree

10 files changed

+126
-125
lines changed

10 files changed

+126
-125
lines changed

content/docs/guides/(data-access)/definitions/access-policies.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ In addition, two special types of access policies are available:
2020
- **Column Default Access Policies**: These policies are associated with specific columns and are applied by default to all reads that extract data from those columns. They ensure consistent application of access rules for sensitive data, such as automatically applying a role check to the SSN column. They can be overridden for individual accessors. Learn more [here](/docs/protect-a-column-with-defaults).
2121
- **Global Baseline Access Policies**: These policies are applied by default to all reads, providing a consistent security baseline. For example, a global policy might always require a valid token or restrict access to trusted IP addresses. They cannot be overridden. Learn more [here](/docs/apply-global-protection-policies).
2222

23-
Access policies provide central, fine-grained control over sensitive data access. They can evaluate purpose, identity, authorization, location, , and more. They can range from simple "always allow resolution" policies to complex evaluations.
23+
Access policies provide central, fine-grained control over sensitive data access. They can evaluate purpose, identity, authorization, location, and more. They can range from simple "always allow resolution" policies to complex evaluations.
2424

2525
![Access policies give you central, fine-grained control over sensitive data access. Policies can evaluate purpose, identity, permissions, location, expiration timelines, rate limits and more.](/assets/images/flow-chart.webp)
2626

content/docs/guides/(data-access)/definitions/selectors.mdx

Lines changed: 102 additions & 101 deletions
Large diffs are not rendered by default.

content/docs/guides/(data-access)/definitions/transformers.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,12 @@ A transformer consists of:
5252

5353
- `Name`
5454
- `Description`
55-
- `id` - a unique transformer identifier, which can be used as a reference when creating accessors and tokens
55+
- `id`: a unique transformer identifier, which can be used as a reference when creating accessors and tokens
5656
- `Input Type`
5757
- `Output Type`
58-
- `Transform Type` - as described above
59-
- `Transform Function` - a transform function with the signature `func(data Object, parameters Object) (Token | error)`
60-
- `Transform Parameters` - a static JSON object (not containing un-encoded PII) that is available at runtime, allowing you to parameterize and reuse functions like "obfuscate all but the first X letters of these emails"
58+
- `Transform Type`: as described above
59+
- `Transform Function`: a transform function with the signature `func(data Object, parameters Object) (Token | error)`
60+
- `Transform Parameters`: a static JSON object (not containing un-encoded PII) that is available at runtime, allowing you to parameterize and reuse functions like "obfuscate all but the first X letters of these emails"
6161

6262
![The PreserveCommonValue parameter allows you to optionally preserve common email domains (like gmail.com). Rare domains, like userclouds.com, will be obscured.](/assets/images/parameters.webp)
6363

content/docs/guides/(data-access)/how-to-guides/create-a-transformer.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ To create a transformer in UserClouds, go to the Policies page, accessible from
4848

4949
- **An input data type** for the transformer (string, timestamp etc)
5050
- **An output data type** for the transformer (string, timestamp etc)
51-
- **A transform type** - for more info on these, see
51+
- **A transform type**: for more info on these, see
5252
- **A transform function**, which will receive raw data _as a string_ and return the transformed data
5353
- _(Optional)_ **A set of parameters** for that function, which allows you to rapidly create transformers with parallel logic
5454

content/docs/guides/(data-access)/how-to-guides/edit-existing-user-data/execute-a-mutator.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ When calling the ExecuteMutator API directly you pass:
2323
- An array of <Glossary>SelectorValues</Glossary>, which are used to parameterize the mutator's <Glossary>selector</Glossary> to define which users should be edited
2424
- Optional client <Glossary>context</Glossary> data, which may be referred to by the mutator access policy
2525
- `RowData`, a mapping from mutator column name to a `ValueAndPurposes` record, which captures any requested data or consent changes for that column. `ValueAndPurposes` contains the following attributes, each of which will be explained more fully in the context of FullUpdates and PartialUpdates below:
26-
- `Value` - used for FullUpdates
27-
- `ValueAdditions` - used for PartialUpdates
28-
- `ValueDeletions` - used for PartialUpdates
29-
- `PurposeAdditions` - used for FullUpdates and PartialUpdates
30-
- `PurposeDeletions` - used for FullUpdates and PartialUpdates
26+
- `Value`: used for FullUpdates
27+
- `ValueAdditions`: used for PartialUpdates
28+
- `ValueDeletions`: used for PartialUpdates
29+
- `PurposeAdditions`: used for FullUpdates and PartialUpdates
30+
- `PurposeDeletions`: used for FullUpdates and PartialUpdates
3131

3232
## What happens when you execute a mutator
3333

content/docs/guides/(data-tokenization)/definitions/token-access-policies.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ hidden: false
66
createdAt: "Thu Aug 03 2023 22:20:54 GMT+0000 (Coordinated Universal Time)"
77
updatedAt: "Fri Jun 28 2024 22:26:13 GMT+0000 (Coordinated Universal Time)"
88
---
9+
910
Token Access Policies control the circumstances in which a <Glossary>token</Glossary> can be <Glossary>resolve</Glossary>d. Practically, access policies are functions that receive <Glossary>context</Glossary> data and return true or false according to whether access is allowed or denied. The context can be sent from either the server or the client.
1011

1112
Access policies allow you to govern token resolution centrally, even giving you the ability to modify contracts on data use after the data is shared.
1213

1314
![Access policies give you central, fine-grained control and visibility over sensitive data access. Policies can evaluate purpose, identity, authorization, location, expiration timelines and more.](/assets/images/flow-chart.webp)
1415

15-
16-
Access policies can be as simple as "always allow resolution" to complex evaluations including locations, credentials and purpose. A well-formed access policy can receive <Glossary>context</Glossary> about who is requesting the raw data, when, where and for what purpose. It will evaluate this context against the user’s consents, local laws and the company’s security settings, to determine whether access is permitted.
16+
Access policies can be as simple as "always allow resolution" to complex evaluations including locations, credentials and purpose. A well-formed access policy can receive <Glossary>context</Glossary> about who is requesting the raw data, when, where and for what purpose. It will evaluate this context against the user’s consents, local laws and the company’s security settings, to determine whether access is permitted.
1717

1818
## Examples
1919

@@ -30,9 +30,9 @@ Let’s look at four possible access policies applied to a phone number token, t
3030

3131
An access policy consists of a tuple of (ID, function, parameters)
3232

33-
- `id` - as described above
34-
- `function` - a function with the signature `func(token Token, parameters Object, context Object)`, where context is passed in from the `ResolveToken()` call.
35-
- `parameters` - a static JSON object (not containing PII) that is available at runtime, allowing you to parameterize and reuse functions like "allow access only from IP range X-Y"
33+
- `id`: as described above
34+
- `function`: a function with the signature `func(token Token, parameters Object, context Object)`, where context is passed in from the `ResolveToken()` call.
35+
- `parameters`: a static JSON object (not containing PII) that is available at runtime, allowing you to parameterize and reuse functions like "allow access only from IP range X-Y"
3636

3737
## Managing access policies
3838

content/docs/guides/(data-tokenization)/definitions/token-transformers.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ Let’s look at four possible transformers, to see how transformers work.
3232

3333
A transformer consists of a tuple of (ID, function, parameters)
3434

35-
- `id` - a unique transformer identifier, which can be used as a reference when creating tokens
36-
- `function` - a transform function with the signature `func(data Object, parameters Object) (Token | error)`
37-
- `parameters` - a static JSON object (not containing un-encoded PII) that is available at runtime, allowing you to parameterize and reuse functions like "obfuscate all but the first X letters of these emails"
35+
- `id`: a unique transformer identifier, which can be used as a reference when creating tokens
36+
- `function`: a transform function with the signature `func(data Object, parameters Object) (Token | error)`
37+
- `parameters`: a static JSON object (not containing un-encoded PII) that is available at runtime, allowing you to parameterize and reuse functions like "obfuscate all but the first X letters of these emails"
3838

3939
## Managing transformers
4040

content/docs/guides/(deployment)/managing-configuration.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ updatedAt: "Tue Jul 30 2024 19:06:01 GMT+0000 (Coordinated Universal Time)"
1616
There are two easy ways to run `ucconfig`:
1717

1818
- **Download a Pre-packaged Binary:**
19-
- Download from the Releases page. Note: On macOS, you will likely need to grant an exception to allow the binary to run.
19+
- Download from the Releases page. _Note: On macOS, you will likely need to grant an exception to allow the binary to run._
2020
- **Run with Docker:**
2121
- `docker run userclouds/ucconfig [ucconfig args described below...]`
2222
- Note: `docker run` may require additional flags to share environment variables or files with the container. See example commands in the Usage section.
@@ -155,10 +155,10 @@ resources:
155155
156156
```
157157

158-
- If a resource has the same UUID in all of your tenants (e.g., you used `ucconfig` to create all resources in all your tenants), then specifying **`__DEFAULT` is sufficient, and you do not need to specify the ID for every tenant. `ucconfig` will use the **`__DEFAULT` key to match live tenant resources to manifest entries.
158+
- If a resource has the same UUID in all of your tenants (e.g., you used `ucconfig` to create all resources in all your tenants), then specifying `__DEFAULT` is sufficient, and you do not need to specify the ID for every tenant. `ucconfig` will use the `__DEFAULT` key to match live tenant resources to manifest entries.
159159
- However, if a resource exists with different UUIDs in different tenants (e.g., you already manually created an email column in your staging and production tenants, so they ended up with different IDs), you should list each ID here to ensure that `ucconfig` will match the correct live resources.
160160

161-
When creating a new resource, `ucconfig` will create it with the`__DEFAULT` UUID.
161+
When creating a new resource, `ucconfig` will create it with the `__DEFAULT` UUID.
162162

163163
### Functions
164164

content/docs/guides/(deployment)/set-up-guides/eks-set-up-guide.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This guide assumes that you are generally familiar with helm usage and have your
2727
2. **Create AWS IAM role for the UserClouds software to use.**
2828
The IAM role should use EKS IRSA
2929
The following AWS permissions are required by the Userclouds software:
30-
1. Access to AWS secrets manager - for the DB password mentioned in the previous section. The Userclouds software will also write some secrets to the AWS Secrets manager (mostly DB credentials for databases created on the RDS instance)
30+
1. Access to AWS secrets manager: for the DB password mentioned in the previous section. The Userclouds software will also write some secrets to the AWS Secrets manager (mostly DB credentials for databases created on the RDS instance)
3131
3. **Add the UserClouds helm chart repo**
3232
helm repo add userclouds [https://userclouds.github.io/helm-charts](https://userclouds.github.io/helm-charts)
3333
4. **Ensure your Kubernetes cluster has a secret to authenticate to container registry**

content/docs/guides/(deployment)/set-up-guides/vpc-peering-set-up-guide.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ Peering VPCs is currently a manual process involving several steps:
1818
3. Create a peering request by following the AWS instructions here.
1919
4. UserClouds’ infrastructure team will accept the request
2020
5. Configure the appropriate route tables to ensure data is routed correctly across the peering connection
21-
6. \_(optional) \_Configure internal DNS to point across the VPC peering connection. If you aren’t already running internal DNS, UserClouds can repoint our public DNS to make this work.
21+
6. _(optional)_ Configure internal DNS to point across the VPC peering connection. If you aren’t already running internal DNS, UserClouds can repoint our public DNS to make this work.

0 commit comments

Comments
 (0)