Skip to content

Commit bc30712

Browse files
author
Open Identity Platform Community
committed
upload OpenIG docs after deploy b3521df113ea460d7189941489f2f67f27c3fe74
1 parent f9464b6 commit bc30712

File tree

9 files changed

+71
-442
lines changed

9 files changed

+71
-442
lines changed

‎openig/modules/ROOT/partials/sec-duration-description.adoc

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
////
2+
The contents of this file are subject to the terms of the Common Development and
3+
Distribution License (the License). You may not use this file except in compliance with the
4+
License.
5+
6+
You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7+
specific language governing permission and limitations under the License.
8+
9+
When distributing Covered Software, include this CDDL Header Notice in each file and include
10+
the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11+
Header, with the fields enclosed by brackets [] replaced by your own identifying
12+
information: "Portions copyright [year] [name of copyright owner]".
13+
14+
Copyright 2025 3A Systems LLC.
15+
////
16+
+
17+
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`.
18+
+
19+
Durations are not case sensitive.
20+
+
21+
Negative durations are not supported.
22+
+
23+
The following units can be used in durations:
24+
25+
* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration
26+
27+
* `zero`, `disabled`: zero-length duration
28+
29+
* `days`, `day`, `d`: days
30+
31+
* `hours`, `hour`, `h`: hours
32+
33+
* `minutes`, `minute`, `min`, `m`: minutes
34+
35+
* `seconds`, `second`, `sec`, `s`: seconds
36+
37+
* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds
38+
39+
* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds
40+
41+
* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds

‎openig/modules/gateway-guide/pages/appendix-multiple-sps.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
information: "Portions copyright [year] [name of copyright owner]".
1313

1414
Copyright 2017 ForgeRock AS.
15-
Portions Copyright 2024 3A Systems LLC.
15+
Portions Copyright 2024-2025 3A Systems LLC.
1616
////
1717
1818
:figure-caption!:
@@ -48,19 +48,19 @@ a|xref:#prepare-network-multi[Preparing the Network]
4848
a|Prepare the configuration for two OpenIG service providers.
4949
a|xref:#prepare-cot-multi[Configuring the Circle of Trust]
5050
51-
xref:#prepare-saml-conf1-multi[Configuring the Service Provider for Application One]
51+
xref:#prepare-saml-conf1-multi[Configuring the Service Provider for Application One]
5252
53-
xref:#prepare-saml-conf2-multi[Configuring the Service Provider for Application Two]
53+
xref:#prepare-saml-conf2-multi[Configuring the Service Provider for Application Two]
5454
5555
a|Import the service provider configurations into OpenAM.
5656
a|xref:#multisp-create-saml-entities[Importing Service Provider Configurations Into OpenAM]
5757
5858
a|Add OpenIG routes.
5959
a|xref:#multisp-conf[Preparing the Base Configuration File]
6060
61-
xref:#multisp-conf-sp1[Preparing Routes for Application One]
61+
xref:#multisp-conf-sp1[Preparing Routes for Application One]
6262
63-
xref:#multisp-conf-sp2[Preparing Routes for Application Two]
63+
xref:#multisp-conf-sp2[Preparing Routes for Application Two]
6464
|===
6565
6666

‎openig/modules/gateway-guide/pages/chap-federation.adoc

+6-5
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
information: "Portions copyright [year] [name of copyright owner]".
1313

1414
Copyright 2017 ForgeRock AS.
15-
Portions Copyright 2024 3A Systems LLC.
15+
Portions Copyright 2024-2025 3A Systems LLC.
1616
////
1717
1818
:figure-caption!:
@@ -94,16 +94,17 @@ a|xref:#prepare-network[Preparing the Network]
9494
a|Configure OpenAM As an IDP.
9595
a|xref:#set-up-openam[ Setting Up OpenAM for This Tutorial ]
9696
97-
xref:#hosted-id[ Setting Up a Hosted Identity Provider ]
97+
xref:#hosted-id[ Setting Up a Hosted Identity Provider ]
9898
99-
xref:#fedlet[ Setting up a Fedlet ]
99+
xref:#fedlet[ Setting up a Fedlet ]
100100
101101
a|Configuring OpenIG as a SP.
102102
a|xref:#copy-conf-files[ Retrieve the Fedlet Configuration Files ]
103103
104-
xref:#route-credential-injection[ Adding a Route for Credential Injection ]
104+
xref:#route-credential-injection[ Adding a Route for Credential Injection ]
105+
106+
xref:#route-saml-fed[ Adding a Route for SAML Federation ]
105107
106-
xref:#route-saml-fed[ Adding a Route for SAML Federation ]
107108
|===
108109
109110
[#d2528e3373]

‎openig/modules/reference/pages/audit-conf.adoc

+6-154
Original file line numberDiff line numberDiff line change
@@ -340,32 +340,7 @@ This password is used for the keystore and for private keys. For details, see xr
340340
`"signatureInterval"`: __duration, required__::
341341
The time interval after which to insert a signature in the CSV file. This duration must not be zero, and must not be unlimited.
342342
+
343-
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`.
344-
345-
Durations are not case sensitive.
346-
347-
Negative durations are not supported.
348-
349-
The following units can be used in durations:
350-
351-
* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration
352-
353-
* `zero`, `disabled`: zero-length duration
354-
355-
* `days`, `day`, `d`: days
356-
357-
* `hours`, `hour`, `h`: hours
358-
359-
* `minutes`, `minute`, `min`, `m`: minutes
360-
361-
* `seconds`, `second`, `sec`, `s`: seconds
362-
363-
* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds
364-
365-
* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds
366-
367-
* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds
368-
343+
include::ROOT:partial$sec-duration-description.adoc[]
369344
370345
====
371346
@@ -432,35 +407,10 @@ Default: `-yyyy.MM.dd-HH.mm.ss`, where __yyyy__ characters are replaced with the
432407
433408
`"rotationInterval"`: __duration, optional__::
434409
The time interval after which to rotate log files. This duration must not be zero.
435-
436410
+
437411
This has the effect of enabling time-based file rotation.
438412
+
439-
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`.
440-
441-
Durations are not case sensitive.
442-
443-
Negative durations are not supported.
444-
445-
The following units can be used in durations:
446-
447-
* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration
448-
449-
* `zero`, `disabled`: zero-length duration
450-
451-
* `days`, `day`, `d`: days
452-
453-
* `hours`, `hour`, `h`: hours
454-
455-
* `minutes`, `minute`, `min`, `m`: minutes
456-
457-
* `seconds`, `second`, `sec`, `s`: seconds
458-
459-
* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds
460-
461-
* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds
462-
463-
* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds
413+
include::ROOT:partial$sec-duration-description.adoc[]
464414
465415
466416
`"rotationTimes"`: __array of durations, optional__::
@@ -477,67 +427,17 @@ The following example schedules rotation six and twelve hours after midnight:
477427
+
478428
This has the effect of enabling time-based file rotation.
479429
+
480-
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`.
481-
482-
Durations are not case sensitive.
483-
484-
Negative durations are not supported.
485-
486-
The following units can be used in durations:
487-
488-
* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration
489-
490-
* `zero`, `disabled`: zero-length duration
491-
492-
* `days`, `day`, `d`: days
493-
494-
* `hours`, `hour`, `h`: hours
495-
496-
* `minutes`, `minute`, `min`, `m`: minutes
497-
498-
* `seconds`, `second`, `sec`, `s`: seconds
499-
500-
* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds
501-
502-
* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds
503-
504-
* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds
430+
include::ROOT:partial$sec-duration-description.adoc[]
505431
506432
507433
====
508434
509435
`"rotationRetentionCheckInterval"`: __duration, optional__::
510436
The time interval after which to check file rotation and retention policies for updates.
511-
512437
+
513438
Default: 5 seconds
514439
+
515-
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`.
516-
517-
Durations are not case sensitive.
518-
519-
Negative durations are not supported.
520-
521-
The following units can be used in durations:
522-
523-
* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration
524-
525-
* `zero`, `disabled`: zero-length duration
526-
527-
* `days`, `day`, `d`: days
528-
529-
* `hours`, `hour`, `h`: hours
530-
531-
* `minutes`, `minute`, `min`, `m`: minutes
532-
533-
* `seconds`, `second`, `sec`, `s`: seconds
534-
535-
* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds
536-
537-
* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds
538-
539-
* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds
540-
440+
include::ROOT:partial$sec-duration-description.adoc[]
541441
542442
--
543443
@@ -739,31 +639,7 @@ The interval at which to send buffered event messages to the database.
739639
+
740640
This interval must be greater than 0 if buffering is enabled.
741641
+
742-
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`.
743-
744-
Durations are not case sensitive.
745-
746-
Negative durations are not supported.
747-
748-
The following units can be used in durations:
749-
750-
* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration
751-
752-
* `zero`, `disabled`: zero-length duration
753-
754-
* `days`, `day`, `d`: days
755-
756-
* `hours`, `hour`, `h`: hours
757-
758-
* `minutes`, `minute`, `min`, `m`: minutes
759-
760-
* `seconds`, `second`, `sec`, `s`: seconds
761-
762-
* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds
763-
764-
* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds
765-
766-
* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds
642+
include::ROOT:partial$sec-duration-description.adoc[]
767643
768644
769645
`"autoFlush"`: __boolean, optional__::
@@ -1331,31 +1207,7 @@ The interval at which to send buffered event messages to Elasticsearch. If buffe
13311207
+
13321208
Default: 1 second
13331209
+
1334-
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`.
1335-
1336-
Durations are not case sensitive.
1337-
1338-
Negative durations are not supported.
1339-
1340-
The following units can be used in durations:
1341-
1342-
* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration
1343-
1344-
* `zero`, `disabled`: zero-length duration
1345-
1346-
* `days`, `day`, `d`: days
1347-
1348-
* `hours`, `hour`, `h`: hours
1349-
1350-
* `minutes`, `minute`, `min`, `m`: minutes
1351-
1352-
* `seconds`, `second`, `sec`, `s`: seconds
1353-
1354-
* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds
1355-
1356-
* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds
1357-
1358-
* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds
1210+
include::ROOT:partial$sec-duration-description.adoc[]
13591211
13601212
13611213
`"maxBatchedEvents"`: __number, optional__::

0 commit comments

Comments
 (0)