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
Refine documentation for mapping Git users to Port accounts by improving clarity and structure. Updated bullet points for consistency, streamlined instructions for enhancing the Port User blueprint, and removed redundant sections to enhance readability.
Copy file name to clipboardExpand all lines: docs/guides/all/map-git-users-to-port-accounts.md
+8-47Lines changed: 8 additions & 47 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,9 +10,9 @@ import TabItem from '@theme/TabItem';
10
10
This guide demonstrates how to automatically map Git users to existing Port user accounts based on email addresses.
11
11
12
12
Once implemented, users will be able to:
13
-
- Maintain a complete inventory of all Git users in your organization within Port
14
-
- Automatically link Git users to their corresponding Port user accounts for seamless integration
15
-
- Provide visibility into which Git users have Port accounts and which don't
13
+
- Maintain a complete inventory of all Git users in your organization within Port.
14
+
- Automatically link Git users to their corresponding Port user accounts for seamless integration.
15
+
- Provide visibility into which Git users have Port accounts and which ones do not.
16
16
17
17
## Prerequisites
18
18
@@ -26,49 +26,18 @@ This guide assumes the following:
26
26
27
27
## Set up data model
28
28
29
-
To establish relationships between Git users and Port user accounts, we need to enhance the Port User blueprint to add relations to the Git user blueprints.
29
+
The relations between Git users and Port users are created automatically when we install the relevant Git integrations.
30
+
If you haven't installed them yet, please do so first.
30
31
31
-
<h3> Enhance the Port User blueprint</h3>
32
-
33
-
Now we need to enhance the Port User blueprint to add relations to the Git user blueprints and mirror properties to display Git information.
32
+
<h3>Add mirror properties to the Port User blueprint</h3>
34
33
35
34
1. Go to the [data model](https://app.getport.io/settings/data-model) page of your portal.
36
35
37
36
2. Find the `User` blueprint and click on it.
38
37
39
38
3. Click on the `Edit JSON` button in the top right corner.
40
39
41
-
4. Add the following relations to the `relations` object (add only the ones relevant to your Git integrations):
42
-
43
-
<details>
44
-
<summary><b>Port User blueprint relations (Click to expand)</b></summary>
45
-
46
-
```json showLineNumbers
47
-
"relations": {
48
-
"githubUser": {
49
-
"title": "GitHub User",
50
-
"target": "githubUser",
51
-
"required": false,
52
-
"many": false
53
-
},
54
-
"gitlabUser": {
55
-
"title": "GitLab User",
56
-
"target": "gitlabMember",
57
-
"required": false,
58
-
"many": false
59
-
},
60
-
"azureDevopsUser": {
61
-
"title": "Azure DevOps User",
62
-
"target": "azureDevopsMember",
63
-
"required": false,
64
-
"many": false
65
-
}
66
-
}
67
-
```
68
-
69
-
</details>
70
-
71
-
5. Add mirror properties to display Git user information:
40
+
4. Add the following mirror properties to the `mirrorProperties` object to display Git user information:
72
41
73
42
<details>
74
43
<summary><b>Port User blueprint mirror properties (Click to expand)</b></summary>
@@ -92,7 +61,7 @@ Now we need to enhance the Port User blueprint to add relations to the Git user
92
61
93
62
</details>
94
63
95
-
6. Click on `Save` to update the blueprint.
64
+
5. Click on `Save` to update the blueprint.
96
65
97
66
:::info Additional mirror properties
98
67
You can add more mirror properties to display other Git user attributes or customize which properties are most relevant for your organization. Only add the mirror properties for the Git platforms you're using.
@@ -257,8 +226,6 @@ To update the Azure DevOps integration mapping, follow the steps below:
257
226
258
227
To ensure new Port users are automatically mapped to their corresponding Git user accounts when a new Port user is created, we'll create an automation that triggers when a new Port user is created.
259
228
260
-
Follow the steps below to create the automation:
261
-
262
229
1. Go to the [Automations](https://app.getport.io/settings/automations) page of your portal.
263
230
264
231
2. Click on `+ Automation`.
@@ -344,7 +311,6 @@ Follow the steps below to create the automation:
344
311
345
312
5. Click `Save` to create the automation.
346
313
347
-
348
314
## Let's test it!
349
315
350
316
1. Go to your [Software catalog](https://app.getport.io/catalog) page
@@ -355,8 +321,3 @@ Follow the steps below to create the automation:
355
321
356
322
4. Check that the relationship is established automatically for new Git users.
357
323
358
-
359
-
## Conclusion
360
-
361
-
You've successfully set up automatic mapping between Git users and Port user accounts.
0 commit comments