Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 @@ -47,19 +47,19 @@ a|xref:#prepare-network-multi[Preparing the Network]
a|Prepare the configuration for two OpenIG service providers.
a|xref:#prepare-cot-multi[Configuring the Circle of Trust]

xref:#prepare-saml-conf1-multi[Configuring the Service Provider for Application One]
xref:#prepare-saml-conf1-multi[Configuring the Service Provider for Application One]

xref:#prepare-saml-conf2-multi[Configuring the Service Provider for Application Two]
xref:#prepare-saml-conf2-multi[Configuring the Service Provider for Application Two]

a|Import the service provider configurations into OpenAM.
a|xref:#multisp-create-saml-entities[Importing Service Provider Configurations Into OpenAM]

a|Add OpenIG routes.
a|xref:#multisp-conf[Preparing the Base Configuration File]

xref:#multisp-conf-sp1[Preparing Routes for Application One]
xref:#multisp-conf-sp1[Preparing Routes for Application One]

xref:#multisp-conf-sp2[Preparing Routes for Application Two]
xref:#multisp-conf-sp2[Preparing Routes for Application Two]
|===


Expand Down
11 changes: 6 additions & 5 deletions openig-doc/src/main/asciidoc/gateway-guide/chap-federation.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 @@ -93,16 +93,17 @@ a|xref:#prepare-network[Preparing the Network]
a|Configure OpenAM As an IDP.
a|xref:#set-up-openam[ Setting Up OpenAM for This Tutorial ]

xref:#hosted-id[ Setting Up a Hosted Identity Provider ]
xref:#hosted-id[ Setting Up a Hosted Identity Provider ]

xref:#fedlet[ Setting up a Fedlet ]
xref:#fedlet[ Setting up a Fedlet ]

a|Configuring OpenIG as a SP.
a|xref:#copy-conf-files[ Retrieve the Fedlet Configuration Files ]

xref:#route-credential-injection[ Adding a Route for Credential Injection ]
xref:#route-credential-injection[ Adding a Route for Credential Injection ]

xref:#route-saml-fed[ Adding a Route for SAML Federation ]

xref:#route-saml-fed[ Adding a Route for SAML Federation ]
|===

[#d2528e3373]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
////
The contents of this file are subject to the terms of the Common Development and
Distribution License (the License). You may not use this file except in compliance with the
License.

You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
specific language governing permission and limitations under the License.

When distributing Covered Software, include this CDDL Header Notice in each file and include
the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
Header, with the fields enclosed by brackets [] replaced by your own identifying
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2025 3A Systems LLC.
////
+
A link:{apidocs-url}/index.html?org/forgerock/openig/util/Duration.html[duration, window=\_blank] is a lapse of time expressed in English, such as `23 hours 59 minutes and 59 seconds`.
+
Durations are not case sensitive.
+
Negative durations are not supported.
+
The following units can be used in durations:

* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration

* `zero`, `disabled`: zero-length duration

* `days`, `day`, `d`: days

* `hours`, `hour`, `h`: hours

* `minutes`, `minute`, `min`, `m`: minutes

* `seconds`, `second`, `sec`, `s`: seconds

* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds

* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds

* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds
160 changes: 6 additions & 154 deletions openig-doc/src/main/asciidoc/reference/audit-conf.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -339,32 +339,7 @@ This password is used for the keystore and for private keys. For details, see xr
`"signatureInterval"`: __duration, required__::
The time interval after which to insert a signature in the CSV file. This duration must not be zero, and must not be unlimited.
+
A link:{apidocs-url}/index.html?org/forgerock/openig/util/Duration.html[duration, window=\_blank] is a lapse of time expressed in English, such as `23 hours 59 minutes and 59 seconds`.

Durations are not case sensitive.

Negative durations are not supported.

The following units can be used in durations:

* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration

* `zero`, `disabled`: zero-length duration

* `days`, `day`, `d`: days

* `hours`, `hour`, `h`: hours

* `minutes`, `minute`, `min`, `m`: minutes

* `seconds`, `second`, `sec`, `s`: seconds

* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds

* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds

* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds

include::../partials/sec-duration-description.adoc[]

====

Expand Down Expand Up @@ -431,35 +406,10 @@ Default: `-yyyy.MM.dd-HH.mm.ss`, where __yyyy__ characters are replaced with the

`"rotationInterval"`: __duration, optional__::
The time interval after which to rotate log files. This duration must not be zero.

+
This has the effect of enabling time-based file rotation.
+
A link:{apidocs-url}/index.html?org/forgerock/openig/util/Duration.html[duration, window=\_blank] is a lapse of time expressed in English, such as `23 hours 59 minutes and 59 seconds`.

Durations are not case sensitive.

Negative durations are not supported.

The following units can be used in durations:

* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration

* `zero`, `disabled`: zero-length duration

* `days`, `day`, `d`: days

* `hours`, `hour`, `h`: hours

* `minutes`, `minute`, `min`, `m`: minutes

* `seconds`, `second`, `sec`, `s`: seconds

* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds

* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds

* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds
include::../partials/sec-duration-description.adoc[]


`"rotationTimes"`: __array of durations, optional__::
Expand All @@ -476,67 +426,17 @@ The following example schedules rotation six and twelve hours after midnight:
+
This has the effect of enabling time-based file rotation.
+
A link:{apidocs-url}/index.html?org/forgerock/openig/util/Duration.html[duration, window=\_blank] is a lapse of time expressed in English, such as `23 hours 59 minutes and 59 seconds`.

Durations are not case sensitive.

Negative durations are not supported.

The following units can be used in durations:

* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration

* `zero`, `disabled`: zero-length duration

* `days`, `day`, `d`: days

* `hours`, `hour`, `h`: hours

* `minutes`, `minute`, `min`, `m`: minutes

* `seconds`, `second`, `sec`, `s`: seconds

* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds

* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds

* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds
include::../partials/sec-duration-description.adoc[]


====

`"rotationRetentionCheckInterval"`: __duration, optional__::
The time interval after which to check file rotation and retention policies for updates.

+
Default: 5 seconds
+
A link:{apidocs-url}/index.html?org/forgerock/openig/util/Duration.html[duration, window=\_blank] is a lapse of time expressed in English, such as `23 hours 59 minutes and 59 seconds`.

Durations are not case sensitive.

Negative durations are not supported.

The following units can be used in durations:

* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration

* `zero`, `disabled`: zero-length duration

* `days`, `day`, `d`: days

* `hours`, `hour`, `h`: hours

* `minutes`, `minute`, `min`, `m`: minutes

* `seconds`, `second`, `sec`, `s`: seconds

* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds

* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds

* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds

include::../partials/sec-duration-description.adoc[]

--

Expand Down Expand Up @@ -738,31 +638,7 @@ The interval at which to send buffered event messages to the database.
+
This interval must be greater than 0 if buffering is enabled.
+
A link:{apidocs-url}/index.html?org/forgerock/openig/util/Duration.html[duration, window=\_blank] is a lapse of time expressed in English, such as `23 hours 59 minutes and 59 seconds`.

Durations are not case sensitive.

Negative durations are not supported.

The following units can be used in durations:

* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration

* `zero`, `disabled`: zero-length duration

* `days`, `day`, `d`: days

* `hours`, `hour`, `h`: hours

* `minutes`, `minute`, `min`, `m`: minutes

* `seconds`, `second`, `sec`, `s`: seconds

* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds

* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds

* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds
include::../partials/sec-duration-description.adoc[]


`"autoFlush"`: __boolean, optional__::
Expand Down Expand Up @@ -1330,31 +1206,7 @@ The interval at which to send buffered event messages to Elasticsearch. If buffe
+
Default: 1 second
+
A link:{apidocs-url}/index.html?org/forgerock/openig/util/Duration.html[duration, window=\_blank] is a lapse of time expressed in English, such as `23 hours 59 minutes and 59 seconds`.

Durations are not case sensitive.

Negative durations are not supported.

The following units can be used in durations:

* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration

* `zero`, `disabled`: zero-length duration

* `days`, `day`, `d`: days

* `hours`, `hour`, `h`: hours

* `minutes`, `minute`, `min`, `m`: minutes

* `seconds`, `second`, `sec`, `s`: seconds

* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds

* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds

* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds
include::../partials/sec-duration-description.adoc[]


`"maxBatchedEvents"`: __number, optional__::
Expand Down
Loading