Skip to content

Commit 8cdeb0e

Browse files
authored
Merge pull request #54 from netwrix/Ada/Clone-SaaS-6.2
Ada/clone saas 6.2
2 parents f84700f + 2cb8b5d commit 8cdeb0e

File tree

670 files changed

+15639
-1858
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

670 files changed

+15639
-1858
lines changed

docs/identitymanager/6.2/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: "Netwrix Identity Manager 6.2"
3+
description: "Netwrix Identity Manager 6.2"
4+
sidebar_position: 10
5+
---
6+
17
# A software solution to match your IGA needs
28

39
To learn about Netwrix Identity Manager (formerly Usercube) and build the solution you need, explore
@@ -12,7 +18,7 @@ Identity Manager's guides include:
1218
- A [User Guide](/docs/identitymanager/6.2/user-guide/index.md) to configure Identity Manager from scratch via the UI.
1319
- An [Integration Guide](/docs/identitymanager/6.2/integration-guide/index.md) to complete Identity Manager's configuration in
1420
XML according to your needs.
15-
- An [Installation Guide](/docs/identitymanager/6.2/installation-guide/index.md) to install Identity Managerin a production
21+
- An [Installation Guide](/docs/identitymanager/6.2/installation-guide/index.md) to install Identity Manager in a production
1622
environment.
1723
- A [Migration Guide](/docs/identitymanager/6.2/migration-guide/index.md) to upgrade to a new version of Identity Manager.
1824
- [ What's New](/docs/identitymanager/6.2/whatsnew/index.md) to get details about specific changes in Identity Manager's

docs/identitymanager/6.2/installation-guide/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: "Installation Guide"
3+
description: "Installation Guide"
4+
sidebar_position: 40
5+
---
6+
17
# Installation Guide
28

39
This guide is designed to help you install Identity Manager in a production environment.

docs/identitymanager/6.2/installation-guide/overview/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: "Overview"
3+
description: "Overview"
4+
sidebar_position: 10
5+
---
6+
17
# Overview
28

39
This section will give you an overview of Identity Manager's components, their requirements and

docs/identitymanager/6.2/installation-guide/production-ready/agent/index.md

Lines changed: 87 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: "Install the Agents"
3+
description: "Install the Agents"
4+
sidebar_position: 40
5+
---
6+
17
# Install the Agents
28

39
Most on-premises installations use an agent integrated with Identity Manager's server. If this is
@@ -6,7 +12,7 @@ need separate agents, or if you are installing Identity Manager's agents within
612
SaaS offering, this is the way to go.
713

814
**NOTE:** Please make sure that Identity Manager's agent requirements are met before going further.
9-
See the [ Agent ](/docs/identitymanager/6.2/installation-guide/requirements/agent-requirements/index.md) topic for additional information.
15+
See the[ Agent ](/docs/identitymanager/6.2/installation-guide/requirements/agent-requirements/index.md) topic for additional information.
1016

1117
## Agent Working Directory
1218

@@ -22,7 +28,7 @@ topic for additional information.
2228

2329
## Create an IIS Website
2430

25-
It is recommended to run the Identity Manager agent as an IIS website.
31+
It is recommended to run the Identity Manager agent as an IIS website.
2632

2733
_Remember,_ to install Identity Manager's agent as a Windows service, see the
2834
[ Agent ](/docs/identitymanager/6.2/installation-guide/requirements/agent-requirements/index.md) topic for additional information.
@@ -40,13 +46,13 @@ The information needed to go through the creation process are the following:
4046

4147
- Identity Manager's agent uses an in-process hosting model
4248
- Identity Manager's agent uses .NET
43-
- Identity Manager agent's web.config dwells in the runtime directory
49+
- Identity Manager agent's web.config dwells in the runtime directory
4450

4551
It might require a few modifications to target the agent instead of the server:
4652

4753
**Step 1 –** Open web.config with a text editor.
4854

49-
**Step 2 –** Change the arguments and stdoutLogFile attributes of the `aspNet` element as
55+
**Step 2 –** Change the arguments and stdoutLogFile attributes of the `<aspNet>` element as
5056
indicated below:
5157

5258
Code attributes enclosed with `<>` need to be replaced with a custom value before entering the
@@ -58,10 +64,10 @@ script in the command line.
5864

5965
- When creating the website, enter the following data:
6066

61-
**Step 1 –** Site name: Identity Manager Agent `Organization` is the recommended naming
67+
**Step 1 –** Site name: Identity Manager Agent`<Organization>` is the recommended naming
6268
convention
6369

64-
**Step 2 –** Physical path: /`agent working directory`/Runtime
70+
**Step 2 –** Physical path: /`<agent working directory>`/Runtime
6571

6672
**Step 3 –** Type: http
6773

@@ -72,11 +78,11 @@ script in the command line.
7278

7379
After creation, the following settings are recommended:
7480

75-
- **Application Pool** > **Identity Manager `Organization`** > **Advanced Settings** > **General** >
76-
**Start Mode** set to AlwaysRunning;
77-
- **Application Pool** > `Identity Manager Organization` > **Advanced Settings** > **Process
81+
- **Application Pool** > **Identity Manager `<Organization>`** > **Advanced Settings** >
82+
**General** > **Start Mode** set to AlwaysRunning;
83+
- **Application Pool** > `Identity Manager <Organization>` > **Advanced Settings** > **Process
7884
Model** > **Idle Time-out** (minutes) set to 0 and Load User Profile set to True;
79-
- **Application Pool** > **Identity Manager `Organization`** > **Recycling** > Regular time
85+
- **Application Pool** > **Identity Manager `<Organization>`** > **Recycling** > Regular time
8086
intervals set to 0.
8187

8288
Recycling the application pool creates a discontinuation in the connection between server and
@@ -87,8 +93,8 @@ After creation, the following settings are recommended:
8793
The following is
8894
[mandatory](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/?view=aspnetcore-8.0#mandatory):
8995

90-
- **Application Pool** > **Identity Manager `Organization`** > **Advanced Settings** > **General** >
91-
**.NET CLR Version** > **No Managed Code**
96+
- **Application Pool** > **Identity Manager `<Organization>`** > **Advanced Settings** >
97+
**General** > **.NET CLR Version** > **No Managed Code**
9298

9399
![IIS Settings](/img/product_docs/identitymanager/saas/installation-guide/production-ready/server/iis_settings.webp)
94100

@@ -109,17 +115,17 @@ for additional information.
109115
You can either:
110116

111117
- Use the built-in application pool identity and grant this identity the right permissions. See the
112-
[ Install the Agents](/docs/identitymanager/6.2/installation-guide/production-ready/agent/index.md) topic for additional information.
118+
Install the Agents topic for additional information.
113119
- Use a custom Windows service account with the right permissions and use it as an IIS identity for
114120
Identity Manager's agent IIS Website
115121

116122
### Check default behavior
117123

118124
Usually, creating an IIS application pool, such as the one within which Identity Manager's server
119-
website runs, triggers the creation of a service account `IIS APPPOOL/apppool_name` (where
120-
`apppool_name` is the application pool name) known as an application pool identity. It is associated
121-
with the IIS website. This account is granted basic group membership that should enable it to access
122-
what it needs.
125+
website runs, triggers the creation of a service account `IIS APPPOOL/<apppool_name>` (where
126+
`<apppool_name>` is the application pool name) known as an application pool identity. It is
127+
associated with the IIS website. This account is granted basic group membership that should enable
128+
it to access what it needs.
123129

124130
For more information about IIS identities, visit the
125131
[Microsoft Documentation](https://support.microsoft.com/en-us/help/4466942/understanding-identities-in-iis).
@@ -129,10 +135,10 @@ necessary permissions for Identity Manager's server to operate.
129135

130136
Before going further, you should check the following points:
131137

132-
**Step 1 –** Find the group membership of `IIS APPPOOL\apppool_name`.
138+
**Step 1 –** Find the group membership of `IIS APPPOOL\<apppool_name>`.
133139

134140
**Step 2 –** Check the permissions on the working directory. Right-click the working directory and
135-
select Security. The group section should contain one of the `IIS APPPOOL/apppool_name` groups,
141+
select Security. The group section should contain one of the `IIS APPPOOL/<apppool_name>` groups,
136142
namely Users. And,
137143

138144
**Step 3 –** If the built-in application pool identity has been created but does not have the right
@@ -168,7 +174,7 @@ Follow the steps below to set an IIS identity and note that these are the same f
168174

169175
**Step 2 –** Open the **Application Pools** node underneath the machine node.
170176

171-
**Step 3 –** Select the Identity ManagerAgent/`Organization` application pool.
177+
**Step 3 –** Select the Identity ManagerAgent/`<Organization>` application pool.
172178

173179
**Step 4 –** Right-click and select **Advanced Settings**.
174180

@@ -266,14 +272,14 @@ script in the command line.
266272
```
267273
appsettings.agent.json
268274
"<OpenId">: {
269-
"AgentIdentifier": "<MyAgent>"
270-
}
275+
  "AgentIdentifier": "<MyAgent>"
276+
  }
271277
```
272278

273279
With the following configuration:
274280

275281
```
276-
<Agent Identifier="<MyAgent>" DisplayName_L1="<My Agent>"
282+
<Agent Identifier="<MyAgent>" DisplayName_L1="<My Agent>" 
277283
URI="<https://contoso.com>" />
278284
```
279285

@@ -298,27 +304,27 @@ script in the command line.
298304
```
299305
appsettings.agent.json
300306
{
301-
...
302-
"Connections": {
303-
"ADExport": {
304-
"Servers": [
305-
{
306-
"Server": "<paris.contoso.com>",
307-
"BaseDN": "<DC=paris,DC=com>"
308-
}
309-
],
310-
"AuthType": "<Basic>",
311-
"Login": "<Login>",
312-
"Password": "<Password>",
313-
"Filter": "<(objectclass=*)>",
314-
"EnableSSL": "<true>"
315-
}
316-
"<SAPExportFulfillment>": {
317-
"Server": "<serverUrl>",
318-
"Login": "<login>",
319-
"Password": "<password>"
320-
}
321-
}
307+
  ...
308+
  "Connections": {
309+
    "ADExport": {
310+
        "Servers": [
311+
          {
312+
           "Server": "<paris.contoso.com>",
313+
           "BaseDN": "<DC=paris,DC=com>"
314+
          }
315+
        ],
316+
        "AuthType": "<Basic>",
317+
        "Login": "<Login>",
318+
        "Password": "<Password>",
319+
        "Filter": "<(objectclass=*)>",
320+
        "EnableSSL": "<true>"
321+
    }
322+
    "<SAPExportFulfillment>": {
323+
        "Server": "<serverUrl>",
324+
        "Login": "<login>",
325+
        "Password": "<password>"
326+
    }
327+
  }
322328
}
323329
```
324330

@@ -352,8 +358,9 @@ and
352358
[pvk2pfx tool](https://docs.microsoft.com/en-us/windows-hardware/drivers/devtest/pvk2pfx?redirectedfrom=MSDN).
353359

354360
Here's an example showing how to generate a [PKCS #12](https://en.wikipedia.org/wiki/PKCS_12)
355-
archive (`UsercubeContoso.pfx`) bundling a public key certificate (`Identity Manager contoso.cert`)
356-
and a private key (`usercubecontoso.key`) with OpenSSL, with a 50-year expiration date:
361+
archive (`<UsercubeContoso.pfx>`) bundling a public key certificate
362+
(`<Identity Manager contoso.cert>`) and a private key (`<usercubecontoso.key>`) with OpenSSL, with a
363+
50-year expiration date:
357364

358365
**Step 1 –** Enter the following command:
359366

@@ -371,24 +378,24 @@ Public key certificates can also be bought from trusted certificate providers an
371378
private key into a [PKCS #12](https://en.wikipedia.org/wiki/PKCS_12) archive using step 2 in the
372379
frame above.
373380

374-
The certificate has to be linked to Identity Manager via EncryptionCertificate in the
381+
The certificate has to be linked to Identity Manager via EncryptionCertificate in the
375382
appsettings.agent.json file.
376383

377-
See
378-
the[Application Settings](/docs/identitymanager/6.2/integration-guide/network-configuration/agent-configuration/appsettings/index.md)
384+
See the
385+
[Application Settings](/docs/identitymanager/6.2/integration-guide/network-configuration/agent-configuration/appsettings/index.md)
379386
topic for additional information about configuration parameters.
380387

381388
### Certificate as a plain file
382389

383-
The following parameters are used to link the file to Identity Manager in EncryptionCertificate.
390+
The following parameters are used to link the file to Identity Manager in EncryptionCertificate.
384391

385392
[PKCS #12](https://en.wikipedia.org/wiki/PKCS_12) archive can be
386393
[password protected](https://www.openssl.org/docs/man1.1.0/man1/openssl.html#password-protected),
387394
hence the X509KeyFilePassword attribute.
388395

389396
Storing a `.pfx` file password in plain text in a production environment is strongly discouraged. It
390-
should always be encrypted using the Usercube-Protect-CertificatePassword tool. See
391-
the[ Usercube-Protect-CertificatePassword ](/docs/identitymanager/6.2/integration-guide/executables/references/protect-certificatepassword/index.md)
397+
should always be encrypted using the Usercube-Protect-CertificatePassword tool. See the
398+
[ Usercube-Protect-CertificatePassword ](/docs/identitymanager/6.2/integration-guide/executables/references/protect-certificatepassword/index.md)
392399
topic for additional information.
393400

394401
Code attributes enclosed with `<>` need to be replaced with a custom value before entering the
@@ -397,12 +404,12 @@ script in the command line.
397404
```
398405
appsettings.agent.json
399406
{
400-
...
401-
"<EncryptionCertificate>": {
402-
"<File>": "<./identitymanagerContoso.pfx>",
403-
"<X509KeyFilePassword>": "<adefe$/izih>"
404-
}
405-
...
407+
  ...
408+
  "<EncryptionCertificate>": {
409+
      "<File>": "<./identitymanagerContoso.pfx>",
410+
      "<X509KeyFilePassword>": "<adefe$/izih>"
411+
  }
412+
  ...
406413
}
407414
```
408415

@@ -417,13 +424,13 @@ script in the command line.
417424
```
418425
appsettings.agent.json
419426
{
420-
...
421-
"<EncryptionCertificate>": {
422-
"<DistinguishedName>":"<UsercubeContoso>",
423-
"<StoreLocation>": "<LocalMachine>",
424-
"<StoreName>": "<AuthRoot>"
425-
}
426-
...
427+
  ...
428+
  "<EncryptionCertificate>": {
429+
      "<DistinguishedName>":"<UsercubeContoso>",
430+
      "<StoreLocation>": "<LocalMachine>",
431+
      "<StoreName>": "<AuthRoot>"
432+
  }
433+
  ...
427434
}
428435
```
429436

@@ -435,8 +442,8 @@ The connection to Identity Manager's server can be configured through:
435442
Manager's server URL
436443

437444
- OpenIdClients and DefaultOpenIdClient must be used to set the agent's credentials to connect to
438-
the server; See
439-
the[appsettings.agent](/docs/identitymanager/6.2/integration-guide/network-configuration/agent-configuration/appsettings-agent/index.md)
445+
the server; See the
446+
[appsettings.agent](/docs/identitymanager/6.2/integration-guide/network-configuration/agent-configuration/appsettings-agent/index.md)
440447
and[ OpenIdClient ](/docs/identitymanager/6.2/integration-guide/toolkit/xml-configuration/access-control/openidclient/index.md)
441448
topics for additional information.
442449

@@ -446,22 +453,22 @@ the[ OpenIdClient ](/docs/identitymanager/6.2/integration-guide/toolkit/xml-conf
446453
topic for additional information.
447454

448455
The following example shows an appsettings.agent.json file that sets an agent to connect to Identity
449-
Manager's server (`https://identitymanagerserver.contoso.com`) with the OpenId client identifier `Job` and
450-
the password `secret`, stored in the OpenIdClients list which also contains the "admin/secret"
456+
Manager's server (`https://identitymanagerserver.contoso.com`) with the OpenId client identifier `<Job>`
457+
and the password `<secret>`, stored in the OpenIdClients list which also contains the "admin/secret"
451458
login/password pair.
452459

453460
Code attributes enclosed with `<>` need to be replaced with a custom value before entering the
454461
script in the command line.
455462

456463
```
457464
{
458-
....
459-
"ApplicationUri": "<https://identitymanagerserver.contoso.com>",
460-
"OpenIdClients": {
461-
"Job": "<secret>",
462-
"Admin": "<secret>"
463-
},
464-
"DefaultOpenIdClient": "<Job>"
465+
    ....
466+
    "ApplicationUri": "<https://identitymanagerserver.contoso.com>",
467+
    "OpenIdClients": {
468+
        "Job": "<secret>",
469+
        "Admin": "<secret>"
470+
     },
471+
    "DefaultOpenIdClient": "<Job>"
465472
}
466473
```
467474

@@ -512,9 +519,9 @@ Code attributes enclosed with `<>` need to be replaced with a custom value befor
512519
script in the command line.
513520

514521
```
515-
\<applicationInitialization doAppInitAfterRestart="\<true\>"\>
516-
\<add initializationPage="\</\>"\>
517-
\</applicationInitialization\>
522+
<applicationInitialization doAppInitAfterRestart="<true>">  
523+
<add initializationPage="</>">
524+
</applicationInitialization>
518525
519526
```
520527

@@ -527,4 +534,4 @@ from being launched.
527534
## What's Next?
528535

529536
The last step in the installation process is setting up an Email server. See the
530-
[Send Notifications](/docs/identitymanager/6.2/installation-guide/production-ready/email-server/index.md)topic for additional information.
537+
[ Send Notifications ](/docs/identitymanager/6.2/installation-guide/production-ready/email-server/index.md) topic for additional information.

docs/identitymanager/6.2/installation-guide/production-ready/database/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: "Install the Database"
3+
description: "Install the Database"
4+
sidebar_position: 20
5+
---
6+
17
# Install the Database
28

39
The Identity Manager Database can be installed on the Server workstation or on a separate machine.

docs/identitymanager/6.2/installation-guide/production-ready/email-server/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: "Send Notifications"
3+
description: "Send Notifications"
4+
sidebar_position: 50
5+
---
6+
17
# Send Notifications
28

39
An SMTP server is used by the Identity Manager Server to send notification emails to its users, and

0 commit comments

Comments
 (0)