Updated reference and username generator transform docs

This commit is contained in:
christina-gagnon-sp
2024-04-26 15:33:56 -05:00
parent d16c4120b0
commit d6ab28b22e
2 changed files with 26 additions and 26 deletions

View File

@@ -16,7 +16,7 @@ Use the reference transform to reuse a transform that has already been written w
## Transform Structure
In addition to the standard `type` and `name` attributes, the structure of a reference transform requires the `id` of the transform you want to reference:
In addition to the standard `type` and `name` attributes, the structure of a reference transform requires the name of the transform you want to reference specified in the `attributes.id` key:
```json
{
@@ -34,7 +34,7 @@ In addition to the standard `type` and `name` attributes, the structure of a ref
- **type** - This must always be set to `reference`.
- **name** - This is a required attribute for all transforms. It represents the name of the transform as it will appear in the UI's dropdown menus.
- **id** - This ID specifies the name of the pre-existing transform you want to use within your current transform.
- **attributes.id** - This specifies the name of the pre-existing transform you want to use within your current transform.
- **Optional Attributes**
- **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process.

View File

@@ -31,13 +31,6 @@ Provide the username generator transform itself in the create profile attribute
```json
{
"attributes": {
"cloudMaxSize": "100",
"cloudMaxUniqueChecks": "5",
"cloudRequired": "true"
},
"isRequired": false,
"multi": false,
"name": "distinguishedName",
"transform": {
"type": "usernameGenerator",
@@ -88,7 +81,14 @@ Provide the username generator transform itself in the create profile attribute
}
}
},
"type": ""
"attributes": {
"cloudMaxSize": "100",
"cloudMaxUniqueChecks": "5",
"cloudRequired": "true"
},
"isRequired": false,
"type": "string",
"isMultiValued": false
}
```
@@ -115,13 +115,6 @@ If the generator does not find a unique value within the first 25 tries, it retu
```json
{
"attributes": {
"cloudMaxSize": "100",
"cloudMaxUniqueChecks": "25",
"cloudRequired": "true"
},
"isRequired": false,
"multi": false,
"name": "userId",
"transform": {
"type": "usernameGenerator",
@@ -149,7 +142,14 @@ If the generator does not find a unique value within the first 25 tries, it retu
}
}
},
"type": ""
"attributes": {
"cloudMaxSize": "100",
"cloudMaxUniqueChecks": "25",
"cloudRequired": "true"
},
"isRequired": false,
"type": "string",
"isMultiValued": false
}
```
@@ -165,13 +165,6 @@ If the generator does not find a unique value within the first 10 tries, it retu
```json
{
"attributes": {
"cloudMaxSize": "100",
"cloudMaxUniqueChecks": "10",
"cloudRequired": "true"
},
"isRequired": false,
"multi": false,
"name": "accountId",
"transform": {
"type": "usernameGenerator",
@@ -192,6 +185,13 @@ If the generator does not find a unique value within the first 10 tries, it retu
}
}
},
"type": ""
"attributes": {
"cloudMaxSize": "100",
"cloudMaxUniqueChecks": "10",
"cloudRequired": "true"
},
"isRequired": false,
"type": "string",
"isMultiValued": false
}
```