Skip to content

Commit

Permalink
upload OpenIDM docs after deploy c12e703677b4e8ff3b0f4fd4bb88a934a695…
Browse files Browse the repository at this point in the history
…5aa6
  • Loading branch information
Open Identity Platform Community committed Jan 30, 2025
1 parent 9c82c14 commit 67605b9
Show file tree
Hide file tree
Showing 43 changed files with 785 additions and 386 deletions.
4 changes: 2 additions & 2 deletions openidm/modules/connectors-guide/pages/chap-ad.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
Expand All @@ -37,7 +37,7 @@ Before you configure the Active Directory Connector, make sure that the .NET Con
.Setting Up the Active Directory Connector
====
. Download the Active Directory Connector from link:https://forgerock.org/downloads/[ForgeRock's download page, window=\_blank].
. Download the Active Directory Connector from the link:https://github.com/OpenIdentityPlatform/OpenICF/releases/[GitHub, window=\_blank].
. Extract the contents of the AD Connector zip file into the directory in which you installed the Connector Server (by default `c:\Program Files (x86)\Identity Connectors\Connector Server>`).
+
Expand Down
4 changes: 2 additions & 2 deletions openidm/modules/connectors-guide/pages/chap-google.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
Expand All @@ -24,7 +24,7 @@
[#chap-google]
== Google Apps Connector
The link:https://forgerock.org/downloads/[Enterprise build, window=\_blank] of OpenIDM includes a Google Apps connector, along with a sample connector configuration. The Google Apps Connector enables you to interact with Google's web applications.
link:https://github.com/OpenIdentityPlatform/OpenICF[OpenICF, window=\_blank] includes a Google Apps connector, along with a sample connector configuration. The Google Apps Connector enables you to interact with Google's web applications.
[#google-connector-config]
=== Configuring the Google Apps Connector
Expand Down
4 changes: 2 additions & 2 deletions openidm/modules/connectors-guide/pages/chap-salesforce.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
Expand All @@ -24,7 +24,7 @@
[#chap-salesforce]
== Salesforce Connector
The link:https://forgerock.org/downloads/[Enterprise build, window=\_blank] of OpenIDM includes a Salesforce connector, along with a sample connector configuration. The Salesforce connector enables provisioning, reconciliation, and synchronization between Salesforce and the OpenIDM repository.
link:https://github.com/OpenIdentityPlatform/OpenICF[OpenICF, window=\_blank] includes a Salesforce connector, along with a sample connector configuration. The Salesforce connector enables provisioning, reconciliation, and synchronization between Salesforce and the OpenIDM repository.
To use this connector, you need a Salesforce account, and a Connected App that has OAuth enabled, which will allow you to retrieve the required consumer key and consumer secret.
Expand Down
12 changes: 6 additions & 6 deletions openidm/modules/connectors-guide/pages/chap-sap.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
Expand All @@ -37,9 +37,9 @@ The sample scripts illustrate the following scenarios:
=== Before You Start
* The SAP connector is provided only with the OpenIDM Enterprise build, and is available on the link:https://backstage.forgerock.com[ForgeRock Backstage, window=\_blank] site.
* The SAP connector is available on the link:https://github.com/OpenIdentityPlatform/OpenICF/releases[GitHub, window=\_blank] site.
* The SAP connector requires the SAP Java Connector (JCo) libraries, version 3.0.12 or later. ForgeRock distributes the SAP connector without these JCo libraries. Before you can use the SAP connector, you must obtain the JCo libraries that correspond to your architecture.
* The SAP connector requires the SAP Java Connector (JCo) libraries, version 3.0.12 or later. Open Identity Platform Community distributes the SAP connector without these JCo libraries. Before you can use the SAP connector, you must obtain the JCo libraries that correspond to your architecture.
Expand All @@ -49,7 +49,7 @@ The sample scripts illustrate the following scenarios:
====
. Download the SAP connector from the link:https://backstage.forgerock.com[ForgeRock Backstage, window=\_blank] site.
. Download the SAP connector from the link:https://github.com/OpenIdentityPlatform/OpenICF/releases/[GitHub, window=\_blank].
. Copy the SAP connector JAR file (`sap-connector-1.4.0.0.jar`) to the `openidm/connectors` directory:
+
Expand Down Expand Up @@ -139,7 +139,7 @@ For optimum performance, set this value to an integer between `5` and `10`.
--
. To test this connector, you can use the sample Groovy scripts available from the link:https://maven.forgerock.org/repo/webapp/#/artifacts/browse/tree/General/releases/org/forgerock/openicf/connectors/sap-connector/1.4.0.0/sap-connector-1.4.0.0-sources.jar/samples/[ForgeRock Artifact Repository Browser, window=\_blank]. You can find the source for these scripts in this location, in the `samples/` directory, as well as the `samples/hr/` subdirectory.
. To test this connector, you can use the sample Groovy scripts available on the link:https://github.com/OpenIdentityPlatform/OpenICF/releases/[GitHub, window=\_blank]. You can find the source for these scripts in this location, in the `samples/` directory, as well as the `samples/hr/` subdirectory.
+
[none]
* `TestSAP.groovy`
Expand Down Expand Up @@ -497,7 +497,7 @@ For optimum performance, set this value to an integer between `5` and `10`.
--
. To test this connector, you can use the sample Groovy scripts available from the link:https://maven.forgerock.org/repo/webapp/#/artifacts/browse/tree/General/releases/org/forgerock/openicf/connectors/sap-connector/1.4.0.0/sap-connector-1.4.0.0-sources.jar/samples/[ForgeRock Artifact Repository Browser, window=\_blank]. You can find the source for these scripts in this location, in the `samples/` directory, as well as the `samples/r3/` subdirectory.
. To test this connector, you can use the sample Groovy scripts available on the link:hhttps://github.com/OpenIdentityPlatform/OpenICF/releases/[GitHub, window=\_blank]. You can find the source for these scripts in this location, in the `samples/` directory, as well as the `samples/r3/` subdirectory.
+
[none]
* `TestSAP.groovy`
Expand Down
4 changes: 2 additions & 2 deletions openidm/modules/getting-started/pages/chap-where-to-go.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
Expand Down Expand Up @@ -129,7 +129,7 @@ OpenIDM is a lightweight and highly customizable identity management product.
The OpenIDM documentation includes additional use cases. Most of them are known as __Samples__, and are described in xref:samples-guide:chap-overview.adoc#chap-overview["Overview of the OpenIDM Samples"] in the __Samples Guide__.
These samples include step-by-step instructions on how you can connect to different data stores, customize product behavior using JavaScript and Groovy, and administer OpenIDM with ForgeRock's commons RESTful API commands.
These samples include step-by-step instructions on how you can connect to different data stores, customize product behavior using JavaScript and Groovy, and administer OpenIDM with Open Identity Platform's commons RESTful API commands.
[#gsg-integration]
Expand Down
27 changes: 10 additions & 17 deletions openidm/modules/install-guide/pages/chap-install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
Expand All @@ -28,7 +28,7 @@ This chapter covers the tasks required to install and start OpenIDM.
[NOTE]
====
ForgeRock documentation includes a separate xref:samples-guide:index.adoc[Samples Guide]. When you have read the first two chapters of this document, you can use the xref:samples-guide:index.adoc[Samples Guide] to test OpenIDM in a number of different configurations.
Open Identity Platform documentation includes a separate xref:samples-guide:index.adoc[Samples Guide]. When you have read the first two chapters of this document, you can use the xref:samples-guide:index.adoc[Samples Guide] to test OpenIDM in a number of different configurations.
====
[#before-you-start]
Expand Down Expand Up @@ -118,7 +118,7 @@ Follow these steps to run OpenIDM interactively:
. Start the Felix container, load all OpenIDM services, and start a command shell to allow you to manage the container:
+
--
* Start OpenIDM (UNIX):
+
Expand All @@ -136,7 +136,6 @@ Using boot properties at /path/to/openidm/conf/boot/boot.properties
* Start OpenIDM (Windows):
+
[source, console]
----
C:\> cd \path\to\openidm
Expand All @@ -151,9 +150,7 @@ Using boot properties at \path\to\openidm\conf\boot\boot.properties
->
----
+
At the OSGi console `->` prompt, you can enter commands such as `help` for usage, or `ps` to view the bundles installed. To see a list of all the OpenIDM core services and their states, enter the following command:
+
[source, console]
----
Expand Down Expand Up @@ -220,11 +217,11 @@ At the OSGi console `->` prompt, you can enter commands such as `help` for usage
[ 29] [active ] org.forgerock.openidm.maintenance
->
----
+
A default startup does not include certain configurable services, which will indicate an `unsatisfied` state until they are included in the configuration. As you work through the sample configurations described later in this guide, you will notice that these services are active.
+
Startup errors and messages are logged to the console by default. You can also view these messages in the log files at `/path/to/openidm/logs`.
Startup errors and messages are logged to the console by default. You can also view these messages in the log files at `/path/to/openidm/logs`.
--
. Alternatively, you can manage the container and services from the Apache Felix Web Console.
+
Use these hints to connect to the Apache Felix Web Console:
Expand Down Expand Up @@ -304,12 +301,11 @@ C:\openidm\bin>
[source, console]
----
C:\openidm\bin>install-service.bat openidm
ForgeRock Launcher Java Service successfully installed as "openidm" service
Open Identity Platform Launcher Java Service successfully installed as "openidm" service
----
. Use the Windows Service manager to manage the OpenIDM service.
+
[#d9505e641]
image::ROOT:windows-service.png[]
Expand All @@ -326,15 +322,12 @@ To change the user account:
.. Select This Account and browse for an Active Directory administrative account.
.. Enter the password for the administrative account.
+
[#d9505e676]
image::ROOT:service-acct.png[]
.. Click Apply to save the changes.
. Use the Windows Service Manager to start, stop, or restart the service.
. To uninstall the OpenIDM service stop the service, then run the following command:
Expand Down Expand Up @@ -525,7 +518,7 @@ $ curl \
"https://localhost:8443/openidm/managed/user/joe" \
| jq .
----
The ForgeRock REST API includes an optional `_prettyPrint` request parameter. The default value is `false`. To use the ForgeRock REST API to format output, add a parameter such as `?_prettyPrint=true` or `&_prettyPrint=true`, depending on whether it is added to the end of an existing request parameter. In this case, the following command would return formatted output:
The Open Identity Platform REST API includes an optional `_prettyPrint` request parameter. The default value is `false`. To use the Open Identity Platform REST API to format output, add a parameter such as `?_prettyPrint=true` or `&_prettyPrint=true`, depending on whether it is added to the end of an existing request parameter. In this case, the following command would return formatted output:
[source, console]
----
Expand Down
25 changes: 8 additions & 17 deletions openidm/modules/install-guide/pages/chap-update.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
Expand All @@ -24,23 +24,14 @@
[#chap-update]
== Updating OpenIDM
The update process is largely dependent on your deployment and on the extent to which you have customized OpenIDM. Engage link:https://www.forgerock.com/support/support-services[ForgeRock Support Services, window=\_top] for help in updating an existing deployment.
The update process is largely dependent on your deployment and on the extent to which you have customized OpenIDM. Engage link:https://github.com/OpenIdentityPlatform/.github/wiki/Approved-Vendor-List[Open Identity Platform Approved Vendors, window=\_top] for help in updating an existing deployment.
If you are updating from OpenIDM 4.0, you can take advantage of new OpenIDM update options from the command line and the Admin UI. For a generic view of the update process, see xref:#update-process["An Overview of the OpenIDM Update Process"].
If you are migrating a deployment from earlier versions of OpenIDM, follow the manual update process.
* To migrate a deployment from OpenIDM 3.1.0 to OpenIDM 4.0, see link:../../../openidm/4/install-guide/#migrate-idm-314[Migrating From OpenIDM 3.1 to OpenIDM 4.0, window=\_blank] in the __OpenIDM 4 Installation Guide__.
* To migrate a deployment from OpenIDM 3.0.0 to 3.1.0, see link:../../../openidm/3.1/install-guide/#chap-upgrade[Migrating to OpenIDM 3.1.0, window=\_blank] in the __OpenIDM 3.1.0 Installation Guide__.
* To migrate a deployment from OpenIDM 2.1.0 to 3.0.0, see link:../../../openidm/3/install-guide/#chap-upgrade[Migrating to OpenIDM 3.0.0, window=\_blank] in the __OpenIDM 3.0.0 Installation Guide__.
[#update-process]
=== An Overview of the OpenIDM Update Process
This section provides background information on the OpenIDM update process. If you want to jump to the steps required to update OpenIDM from version 4.0 to 4.5, read xref:#migrate-idm-40-45["Updating From OpenIDM 4.0 to OpenIDM 4.5"].
This section provides background information on the OpenIDM update process.
OpenIDM must be running when you launch an update (using the UI or the CLI). This section details the capabilities of the OpenIDM update process, in the following sub-sections:
Expand Down Expand Up @@ -211,7 +202,7 @@ The URL of the OpenIDM REST service. The default URL is `\http://localhost:8080/
The port number associated with the OpenIDM REST service. If specified, this option overrides any port number specified with the `--url` option. The default port is 8080. This option is used by all three subcommands.
`--acceptLicense`::
Automatically accept the license shown in `/path/to/openidm/legal-notices/Forgerock_License.txt`. If you omit this option, the update process prompts you to accept or decline the license.
Automatically accept the license shown in `/path/to/openidm/legal-notices/CDDLv1_0.txt`. If you omit this option, the update process prompts you to accept or decline the license.
`--skipRepoUpdatePreview`::
Bypasses a preview of repository updates. Suitable if you have already downloaded and approved changes to your repository.
Expand Down Expand Up @@ -403,7 +394,7 @@ Because of the transition between the OpenIDM 4.0 and OpenIDM 4.5 update service
* Download the update binaries.
+
To update from OpenIDM 4.0 to OpenIDM 4.5, navigate to ForgeRock's link:https://backstage.forgerock.com/[BackStage, window=\_blank] site and download the following binaries:
To update from OpenIDM 4.0 to OpenIDM 4.5, navigate to Open Identity Platform's link:https://github.com/OpenIdentityPlatform/OpenIDM/releases[BackStage, window=\_blank] repository and download the following binaries:
+
** Update Patch 1 (`openidm-4.0.0-1.zip`)
Expand All @@ -413,7 +404,6 @@ To update from OpenIDM 4.0 to OpenIDM 4.5, navigate to ForgeRock's link:https://
** OpenIDM 4.5 (`openidm-4.5.0.zip`)
+
Access to the update binaries is restricted to ForgeRock customers.
* Before starting the update process, extract and apply the repository update scripts from the OpenIDM 4.5 binary. You may want to share them with your Database Administrator (DBA). For more information, see xref:#update-4045-repo["Updating OpenIDM 4.0, Repository Scripts"].
Expand Down Expand Up @@ -476,7 +466,7 @@ $ mysql -u root -p < /path/to/openidm/db/mysql/scripts/updates/v2_shorten_link_c
====
The OpenIDM repository update scripts address the differences between the OpenIDM 4.0 and OpenIDM 4.5 supported repositories. They may not address any custom schema, columns, or tables that you have implemented in production.
As OrientDB is not supported in production, ForgeRock does not support updates of deployments with that repository, and OpenIDM 4.5 does not include OrientDB update scripts.
As OrientDB is not supported in production, Open Identity Platform Community does not support updates of deployments with that repository, and OpenIDM 4.5 does not include OrientDB update scripts.
====
Expand Down Expand Up @@ -835,7 +825,8 @@ If you want to set up a script for this process, note the delay between the `Res
. Log into the Admin UI at `\http://localhost:8080/admin`.
.
. {nbsp}
+
[WARNING]
======
Updating the repository is your responsibility. You should have already done so in xref:#update-4045-repo["Updating OpenIDM 4.0, Repository Scripts"]. Assuming that is true, confirm this when the Admin UI prompts you to download and acknowledge that you've run these scripts.
Expand Down
14 changes: 7 additions & 7 deletions openidm/modules/integrators-guide/pages/appendix-audit.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
Expand Down Expand Up @@ -131,7 +131,7 @@ The following code is an excerpt from the `audit.json` file, with Elasticsearch
----
You should also set up configuration for the Elasticsearch event handler. The entries shown are defaults, and can be configured. In fact, if you have set up Elasticsearch Shield, with or without SSL/TLS, as described in xref:#elastic-install["Installing and Configuring Elasticsearch"], you should change some of these defaults.
[source, javascript]
[source, json]
----
"eventHandlers" : [
{
Expand Down Expand Up @@ -169,7 +169,7 @@ If you set `useSSL` to true, add the following properties to the `connection` co
[source, javascript]
----
"username" : "myUsername",
"password" : "myPassword",
"password" : "myPassword",
----
For more information on the other options shown in `audit.json`, see xref:#audit-event-prop["Common Audit Event Handler Property Configuration"].
Expand Down Expand Up @@ -633,7 +633,7 @@ Two properties shown only in the `audit.json` file for your project are:
* The class name used to build the handler, which may shown as one of the `availableAuditEventHandlers`, as shown in this excerpt from the `audit.json` file:
+
[source, javascript]
[source, json]
----
"availableAuditEventHandlers" : [
"org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler",
Expand All @@ -646,7 +646,7 @@ Two properties shown only in the `audit.json` file for your project are:
* The audit event handler `config` property, which comes after a second instance of the class name of that audit event handler. For an example, see the following excerpt of an `audit.json` file:
+
[source, javascript]
[source, json]
----
"eventHandlers" : [
{
Expand Down Expand Up @@ -771,7 +771,7 @@ a|Buffering: avoids flushing after each event
|===
Except for the common properties shown in xref:#audit-event-prop["Common Audit Event Handler Property Configuration"], the Repository and Router audit event handlers share one unique property: `resourcePath`:
[source, javascript]
[source, json]
----
{
"class" : "org.forgerock.openidm.audit.impl.RouterAuditEventHandler",
Expand All @@ -796,7 +796,7 @@ a|Path to the repository resource
[NOTE]
====
Take care when reading JMS properties in the `audit.json` file. They include the standard ForgeRock audit event topics, along with JMS-unique topics:
Take care when reading JMS properties in the `audit.json` file. They include the standard Open Identity Platform audit event topics, along with JMS-unique topics:
====
[#audit-config-prop-jms]
Expand Down
Loading

0 comments on commit 67605b9

Please sign in to comment.