Skip to content

Commit 9842d16

Browse files
author
Dan Costello
committed
Update glossary syntax
1 parent a6c07f0 commit 9842d16

14 files changed

Lines changed: 41 additions & 41 deletions

content/docs/(data-access)/definitions/accessors-read-apis.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,23 @@ Accessors can be configured to access either live or soft-deleted data. Soft-del
2020

2121
## How Accessors Work
2222

23-
1. Data, <<glossary:consent>>s and <<glossary:purpose>>s are stored inside the safety layer boundary (either in UserClouds User Store or an owned-and-operated database like RDS)
24-
2. Data consumers request access by sending context, like purpose or identity, to a use-case specific <<glossary:accessor>> API
25-
3. Several access policies are evaluated for each user record, using the data passed in <<glossary:context>> and data in the user object:
23+
1. Data, <Glossary>consent</Glossary>s and <Glossary>purpose</Glossary>s are stored inside the safety layer boundary (either in UserClouds User Store or an owned-and-operated database like RDS)
24+
2. Data consumers request access by sending context, like purpose or identity, to a use-case specific <Glossary>accessor</Glossary> API
25+
3. Several access policies are evaluated for each user record, using the data passed in <Glossary>context</Glossary> and data in the user object:
2626
1. **Global baseline policy for accessors**: Applied to ensure baseline security. Learn more [here](https://docs.userclouds.com/docs/apply-global-protection-policies).
2727
2. **Column-default access policies**: Column default policies for all columns accessed by the accessor are applied, unless overridden. Learn more [here](https://docs.userclouds.com/docs/protect-a-column-with-defaults).
2828
3. **Accessor-specific access policy composition**: Applied in addition to the above policies.
2929
4. User data is further filtered according to whether the users have consented to the accessor's data processing purpose.
30-
5. For records where access is granted, the accessor's <<glossary:data transformer>>s transform each column of the outbound data, minimizing the data for the given use case. If no transformer is specified for a given column, the column's default transformer is used. Learn more [here](https://docs.userclouds.com/docs/protect-a-column-with-defaults).
30+
5. For records where access is granted, the accessor's <Glossary>data transformer</Glossary>s transform each column of the outbound data, minimizing the data for the given use case. If no transformer is specified for a given column, the column's default transformer is used. Learn more [here](https://docs.userclouds.com/docs/protect-a-column-with-defaults).
3131

3232
## Structure of an Accessor
3333

34-
At creation time, each accessor is associated with a user record <<glossary:selector>>, a set of <<glossary:column>>s, a set of <<glossary:data transformer>>s, a <<glossary:purpose>> and an <<glossary:access policy>>.
34+
At creation time, each accessor is associated with a user record <Glossary>selector</Glossary>, a set of <Glossary>column</Glossary>s, a set of <Glossary>data transformer</Glossary>s, a <Glossary>purpose</Glossary> and an <Glossary>access policy</Glossary>.
3535

36-
- The user record <<glossary:selector>> is a SQL-like clause that specifies which records the accessor should return data for, based on an array of values that are passed at execution time. The accessor's response will only include users that have consented to the accessor's purpose for all non-<<glossary:system column>>s used in the selector. Since UserClouds does not store consents for <<glossary:system column>>s, they can be referenced in the selector regardless of accessor purpose / user consents.
36+
- The user record <Glossary>selector</Glossary> is a SQL-like clause that specifies which records the accessor should return data for, based on an array of values that are passed at execution time. The accessor's response will only include users that have consented to the accessor's purpose for all non-<Glossary>system column</Glossary>s used in the selector. Since UserClouds does not store consents for <Glossary>system column</Glossary>s, they can be referenced in the selector regardless of accessor purpose / user consents.
3737
- The columns indicate which data fields the accessor will retrieve.
3838
- Each column is associated with a transformer, which tokenizes, minimizes or otherwise obscures the outbound data from that column.
39-
- The purpose is selected from your company's list of data processing purposes. This indicates what the accessor will be used for, e.g. marketing. The accessor will run a <<glossary:purpose check>>, filtering out user records and data for which the user has not consented to the specified purpose across all columns. The accessor's response will only include users that have consented to the accessor's purpose for all columns being retrieved, and all non-system columns used in the selector. Learn more [here](https://docs.userclouds.com/docs/purpose-and-consent).
39+
- The purpose is selected from your company's list of data processing purposes. This indicates what the accessor will be used for, e.g. marketing. The accessor will run a <Glossary>purpose check</Glossary>, filtering out user records and data for which the user has not consented to the specified purpose across all columns. The accessor's response will only include users that have consented to the accessor's purpose for all columns being retrieved, and all non-system columns used in the selector. Learn more [here](https://docs.userclouds.com/docs/purpose-and-consent).
4040
- The access policy determines the circumstances in which the data can be retrieved. Access policies run on each user record and filter out user records which fail the access policy.
4141

4242
## Learn More

content/docs/(data-access)/definitions/mutators-write-apis.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,28 @@ updatedAt: "Tue Sep 10 2024 16:09:35 GMT+0000 (Coordinated Universal Time)"
88
---
99
## Introduction
1010

11-
Mutators are configurable APIs that allow a client to write data to the User Store. Mutators (setters) can be thought of as the complement to <glossary:accessor>s (getters). Mutators serve two functions:
11+
Mutators are configurable APIs that allow a client to write data to the User Store. Mutators (setters) can be thought of as the complement to <Glossary>accessor</Glossary>s (getters). Mutators serve two functions:
1212

1313
- Storing sensitive user data in the store
14-
- Storing user <<glossary:consent>>s to data processing <<glossary:purpose>>s alongside that data
14+
- Storing user <Glossary>consent</Glossary>s to data processing <Glossary>purpose</Glossary>s alongside that data
1515

1616
## How Mutators Work
1717

1818
Writing data and consents through mutators involves several key steps:
1919

2020
1. The initiating application or client sends a request to write data. This request includes:
21-
1. An array of <<glossary:SelectorValues>>, to be evaluated by the mutator's <<glossary:selector>>
22-
2. Client context data to be evaluated by the mutator's <<glossary:access policy>>
21+
1. An array of <Glossary>SelectorValues</Glossary>, to be evaluated by the mutator's <Glossary>selector</Glossary>
22+
2. Client context data to be evaluated by the mutator's <Glossary>access policy</Glossary>
2323
3. User data
2424
4. User consents
25-
2. Utilizing the provided <<glossary:SelectorValues>>, the mutator's selector identifies the relevant user records to be updated. For a detailed explanation, visit our [selector documentation](https://docs.userclouds.com/docs/selectors).
26-
3. Two access policies are applied to each selected user record: the global baseline policy for mutators (learn more [here](https://docs.userclouds.com/docs/apply-global-protection-policies)) and the mutator's own <<glossary:access policy>> composition. This step may involve evaluating the provided client context or any user-specific data already present in the User Store to determine if the write operation is permitted for each selector user record.
25+
2. Utilizing the provided <Glossary>SelectorValues</Glossary>, the mutator's selector identifies the relevant user records to be updated. For a detailed explanation, visit our [selector documentation](https://docs.userclouds.com/docs/selectors).
26+
3. Two access policies are applied to each selected user record: the global baseline policy for mutators (learn more [here](https://docs.userclouds.com/docs/apply-global-protection-policies)) and the mutator's own <Glossary>access policy</Glossary> composition. This step may involve evaluating the provided client context or any user-specific data already present in the User Store to determine if the write operation is permitted for each selector user record.
2727
4. For those records that pass the access policy check, the mutator proceeds to validate and transform the incoming data to ensure it meets the required standards
2828
5. Finally, the processed data, along with the associated user consents, are securely stored in the User Store
2929

3030
## Structure of a Mutator
3131

32-
At creation time, each mutator is associated with a user record <<glossary:selector>>, a set of <<glossary:column>>s, a set of <<glossary:data transformer>>s and an <<glossary:access policy>>.
32+
At creation time, each mutator is associated with a user record <Glossary>selector</Glossary>, a set of <Glossary>column</Glossary>s, a set of <Glossary>data transformer</Glossary>s and an <Glossary>access policy</Glossary>.
3333

3434
- The record selector is a SQL-like clause that specifies which records the mutator should edit data for, based on an array of values that are passed at execution time.
3535
- The columns indicate which data field the mutator will edit.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ Transformers allow you to retain select structure and information from the raw d
1717

1818
Transformers are executed in two places:
1919

20-
- Each <<glossary:accessor>> (read path) is associated with a transformer per column, dictating how the data in that column is obscured or minimized when the accessor is called
21-
- When a <<glossary:token>> is created, a data transformer is specified to dictate how the token should be generated from the raw data (and therefore what information, if any, should be retained in the token)
20+
- Each <Glossary>accessor</Glossary> (read path) is associated with a transformer per column, dictating how the data in that column is obscured or minimized when the accessor is called
21+
- When a <Glossary>token</Glossary> is created, a data transformer is specified to dictate how the token should be generated from the raw data (and therefore what information, if any, should be retained in the token)
2222

2323
In addition, column default transformers provide a way to consistently apply transformations across all accessors that extract data from specific columns:
2424

content/docs/(data-access)/how-to-guides/create-an-access-policy.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Access policies and templates are managed under the Access Rules element in the
2222

2323
Policy templates are parametrizable functions that can be parametrized to create access policies. To create a policy template, go to the Policies page and click Create Policy Template.
2424

25-
**1 Create your <<glossary:access policy template>>**
25+
**1 Create your <Glossary>access policy template</Glossary>**
2626

2727
Specify a name, a description and a javascript function for your policy. The javascript function may optionally accept parameters, which you can test below.
2828

@@ -41,7 +41,7 @@ Use the "Test Your Draft" card at the bottom of the page to test your policy tem
4141

4242
To create a new access policy, click "Create Policy" from the Policies page, accessible from the sidebar of UserClouds Console. You can create the new policy by writing a new policy or template from scratch in this interface, by composing existing policies with AND / OR logic, or both.
4343

44-
**2 Set your <<glossary:access policy>> name and description**
44+
**2 Set your <Glossary>access policy</Glossary> name and description**
4545

4646
Next, add a name and a description for your policy.
4747

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ updatedAt: "Tue Feb 27 2024 01:42:13 GMT+0000 (Coordinated Universal Time)"
99
UserClouds stores two types of information for every user:
1010

1111
- **User data** such as their name, email or phone number
12-
- **User consents**: for each column, UserClouds also stores a set of user <<glossary:consent>>s, indicating which data processing purposes a user has consented to for that column of data
12+
- **User consents**: for each column, UserClouds also stores a set of user <Glossary>consent</Glossary>s, indicating which data processing purposes a user has consented to for that column of data
1313

14-
You can update both data and consents using <<glossary:mutator>>s. Mutators are advanced write APIs. They enforce access policies, receive inbound data, normalize it, and save it to the specified record(s) and column(s) in the User Store.
14+
You can update both data and consents using <Glossary>mutator</Glossary>s. Mutators are advanced write APIs. They enforce access policies, receive inbound data, normalize it, and save it to the specified record(s) and column(s) in the User Store.
1515

1616
UserClouds automatically code-generates an SDK so that calling mutators is as simple as calling any other function in your codebase.
1717

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ updatedAt: "Fri Jun 28 2024 22:49:35 GMT+0000 (Coordinated Universal Time)"
88
---
99
## Introduction
1010

11-
Mutators are configurable APIs that allow a client to update data in the User Store. Mutators (write APIs) can be thought of as the complement to <<glossary:accessor>>s (read APIs). Mutators are intended to capture and store a user's consented <<glossary:purpose>>s alongside their sensitive data. Purposes are passed in context at execution time.
11+
Mutators are configurable APIs that allow a client to update data in the User Store. Mutators (write APIs) can be thought of as the complement to <Glossary>accessor</Glossary>s (read APIs). Mutators are intended to capture and store a user's consented <Glossary>purpose</Glossary>s alongside their sensitive data. Purposes are passed in context at execution time.
1212

1313
Mutators do not create users: they only add or edit values associated with existing users. You can create a user via the [CreateUserWithMutator](https://docs.userclouds.com/reference/post_userstore-api-users) call.
1414

@@ -31,7 +31,7 @@ Mutator names are used in your codebase (to call the API) and in your audit log
3131

3232
### 2. Choose which records and columns the mutator will write data to
3333

34-
Next, pick the user records and <<glossary:column>>s the mutator will return data for. Specify the user records by writing a <<glossary:selector>>, a SQL-like clause, like `{id} = ANY(?) OR {Email} LIKE ?`. In selectors, each ? represents a parameter that is passed in an array, at execution time. This parameter can be a single value, or an array of possible values. For more info on selectors, see [Selectors](https://docs.userclouds.com/docs/selectors).
34+
Next, pick the user records and <Glossary>column</Glossary>s the mutator will return data for. Specify the user records by writing a <Glossary>selector</Glossary>, a SQL-like clause, like `{id} = ANY(?) OR {Email} LIKE ?`. In selectors, each ? represents a parameter that is passed in an array, at execution time. This parameter can be a single value, or an array of possible values. For more info on selectors, see [Selectors](https://docs.userclouds.com/docs/selectors).
3535

3636
When creating a user via the `CreateUserWithMutator` API, you should use the selector `{id} = ?`. For more info on creating users in User Store, see Create a User.
3737

@@ -42,7 +42,7 @@ Add columns by selecting from the dropdown and clicking "Add Column".
4242

4343
### 3. Define how the mutator should normalize inbound data
4444

45-
Next, you must define how the mutator will normalize each column's data on the way into the store. Choose one <<glossary:data normalizer>> per column, using the dropdowns in each row of the columns table (see picture above). Any transformer of type PassThrough or Transform may be used as a normalizer, but tokenizing transformers cannot be used as normalizers. If no normalization is desired or required, a PassThrough normalizer should be used.
45+
Next, you must define how the mutator will normalize each column's data on the way into the store. Choose one <Glossary>data normalizer</Glossary> per column, using the dropdowns in each row of the columns table (see picture above). Any transformer of type PassThrough or Transform may be used as a normalizer, but tokenizing transformers cannot be used as normalizers. If no normalization is desired or required, a PassThrough normalizer should be used.
4646

4747
Only normalizers with an output type that exactly matches the column's data type may be used. For example:
4848

@@ -54,10 +54,10 @@ For more information on transformers, see [Transformers](https://docs.userclouds
5454

5555
### 4. Define the circumstances in which the mutator can be used
5656

57-
Finally, select an <<glossary:access policy>> for the mutator. The access policy controls whether the whether a given write attempt (execute mutator call) is allowed. The simplest access policy always returns true (write permitted). It is possible to create much more fine-grained policies. In this interface, you can:
57+
Finally, select an <Glossary>access policy</Glossary> for the mutator. The access policy controls whether the whether a given write attempt (execute mutator call) is allowed. The simplest access policy always returns true (write permitted). It is possible to create much more fine-grained policies. In this interface, you can:
5858

5959
- Choose a single, pre-existing policy
60-
- Choose and parametrize a pre-existing <<glossary:access policy template>>
60+
- Choose and parametrize a pre-existing <Glossary>access policy template</Glossary>
6161
- Write and parametrize a new policy template
6262
- Compose a new policy by taking any of the above actions multiple times and combining those policies with AND or OR logic
6363

0 commit comments

Comments
 (0)