forked from JanssenProject/jans
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmkdocs.yml
More file actions
694 lines (677 loc) · 35.6 KB
/
mkdocs.yml
File metadata and controls
694 lines (677 loc) · 35.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
copyright: Copyright © 2026, The Janssen Project
docs_dir: ./docs
edit_uri: edit/main/docs/
extra:
enable_scarf_pixel: false
enable_reo_flag: false
generator: false
social:
- icon: fontawesome/brands/github
link: https://github.com/JanssenProject/jans
name: Janssen on GitHub
- icon: fontawesome/solid/link
link: https://jans.io/docs
name: Janssen Website
version:
default: stable
provider: mike
extra_css:
- css/tabs.css
- stylesheets/mermaid-extra.css
- stylesheets/home.css
- stylesheets/navigation.css
extra_javascript:
- javascripts/skeleton-loader.js
- javascripts/full-screen-sections.js
markdown_extensions:
- admonition
- attr_list
- toc:
permalink: '#'
- codehilite
- pymdownx.superfences:
custom_fences:
- class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
name: mermaid
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_generator: !!python/name:material.extensions.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
- pymdownx.details
- pymdownx.snippets:
base_path:
- docs
- .
check_paths: true
nav:
- Janssen Server:
# ====================
# 1. GET STARTED
# ====================
- Get Started:
- Overview: getting-started/index.md
- Welcome: index.md
- Platform Goals: janssen-server/planning/platform-goal.md
- Use Cases: janssen-server/planning/use-cases.md
- Quick Start Guides:
- Overview: quick-start-guides/index.md
- Docker Quick Start: janssen-server/install/docker-install/quick-start.md
- Casa Quick Start: casa/administration/quick-start.md
- Terminology:
- Learning Reference: janssen-server/reference/learning-reference.md
# ====================
# 2. ARCHITECTURE & CONCEPTS (Reference)
# ====================
- Architecture & Concepts:
- Overview: janssen-server/architecture/README.md
- Components Overview: janssen-server/planning/components.md # duplicate: also under Deploy & Operate > Planning
- Auth Server Internals:
- Endpoints:
- janssen-server/auth-server/endpoints/README.md
- OpenID Configuration: janssen-server/auth-server/endpoints/configuration.md
- Client Registration: janssen-server/auth-server/endpoints/client-registration.md
- Authorization: janssen-server/auth-server/endpoints/authorization.md
- Authorization Challenge: janssen-server/auth-server/endpoints/authorization-challenge.md
- Access Evaluation: janssen-server/auth-server/endpoints/access-evaluation.md
- Token: janssen-server/auth-server/endpoints/token.md
- SSA: janssen-server/auth-server/endpoints/ssa.md
- Userinfo: janssen-server/auth-server/endpoints/userinfo.md
- Token Revocation: janssen-server/auth-server/endpoints/token-revocation.md
- Global Token Revocation: janssen-server/auth-server/endpoints/global-token-revocation.md
- End Session: janssen-server/auth-server/endpoints/end-session.md
- Clientinfo: janssen-server/auth-server/endpoints/clientinfo.md
- JWKS URI: janssen-server/auth-server/endpoints/jwks-uri.md
- Archived JWKS URI: janssen-server/auth-server/endpoints/archived-jwks-uri.md
- Introspection: janssen-server/auth-server/endpoints/introspection.md
- Device Authorization: janssen-server/auth-server/endpoints/device-authorization.md
- PAR: janssen-server/auth-server/endpoints/par.md
- Backchannel Authentication: janssen-server/auth-server/endpoints/backchannel-authentication.md
- Crypto:
- janssen-server/auth-server/crypto/README.md
- Keys: janssen-server/auth-server/crypto/keys.md
- Key Storage: janssen-server/auth-server/crypto/key-storage.md
- Key Rotation: janssen-server/auth-server/crypto/key-generation.md
- Internationalization:
- janssen-server/auth-server/international/README.md
- Web Pages: janssen-server/auth-server/international/web-pages.md
- Client Configuration: janssen-server/auth-server/international/client-config.md
- Scope Descriptions: janssen-server/auth-server/international/scope-descriptions.md
- Developer Guide:
- janssen-server/developer/README.md
- External Libraries: janssen-server/developer/external-libraries.md
- CORS: janssen-server/developer/cors.md
- X-Frame-Options: janssen-server/developer/xframe.md
- Managed Beans: janssen-server/developer/managed-beans.md
- Customization:
- janssen-server/developer/customization/README.md
- Customize Web Pages: janssen-server/developer/customization/customize-web-pages.md
- Custom Client Logs: janssen-server/developer/customization/custom-client-logs.md
- Implementation Design:
- contribute/implementation-design/README.md
- Agama:
- contribute/implementation-design/agama-design/README.md
- ADR: contribute/implementation-design/agama-design/adr/README.md
- jans-auth-server:
- contribute/implementation-design/jans-auth-server-design/README.md
- ADR: contribute/implementation-design/jans-auth-server-design/adr/README.md
- jans-cli:
- contribute/implementation-design/jans-cli-design/README.md
- ADR: contribute/implementation-design/jans-cli-design/adr/README.md
- jans-config-api:
- contribute/implementation-design/jans-config-api-design/README.md
- OpenAPI Spec: contribute/implementation-design/jans-config-api-design/config-api-swagger-spec-generation.md
- ADR: contribute/implementation-design/jans-config-api-design/adr/README.md
- jans-core:
- contribute/implementation-design/jans-core-design/README.md
- ADR: contribute/implementation-design/jans-core-design/adr/README.md
- jans-fido2:
- contribute/implementation-design/jans-fido2-design/README.md
- ADR: contribute/implementation-design/jans-fido2-design/adr/README.md
- jans-orm:
- contribute/implementation-design/jans-orm-design/README.md
- ADR: contribute/implementation-design/jans-orm-design/adr/README.md
- jans-scim:
- contribute/implementation-design/jans-scim-design/README.md
- ADR: contribute/implementation-design/jans-scim-design/adr/README.md
- jans-casa:
- contribute/implementation-design/jans-casa-design/README.md
- ADR: contribute/implementation-design/jans-casa-design/adr/README.md
- jans-cedarling:
- contribute/implementation-design/jans-cedarling-design/README.md
- ADR: contribute/implementation-design/jans-cedarling-design/adr/README.md
- Technical Overview: contribute/implementation-design/jans-cedarling-design/cedarling-technical-overview.md
- Reference:
- janssen-server/reference/README.md
- Javadocs / OpenAPI:
- janssen-server/reference/openapi.md
- jans-auth-server: https://janssenproject.github.io/developer-docs/jans-auth-server/server/index.html
- jans-casa: https://janssenproject.github.io/developer-docs/jans-casa/config/index.html
- jans-config-api: https://janssenproject.github.io/developer-docs/jans-config-api/server/index.html
- jans-core: https://janssenproject.github.io/developer-docs/jans-core/server/io/jans/server/filters/package-summary.html
- jans-fido2: https://janssenproject.github.io/developer-docs/jans-fido2/server/index.html
- jans-link: https://janssenproject.github.io/developer-docs/jans-link/server/index.html
- jans-lock: https://janssenproject.github.io/developer-docs/jans-lock/server/index.html
- jans-orm: https://janssenproject.github.io/developer-docs/jans-orm/cdi/io/jans/orm/service/package-summary.html
- jans-scim: https://janssenproject.github.io/developer-docs/jans-scim/server/index.html
- JSON Configuration:
- janssen-server/reference/json/README.md
- Properties:
- janssen-server/reference/json/properties/README.md
- Auth Server: janssen-server/reference/json/properties/janssenauthserver-properties.md
- FIDO: janssen-server/reference/json/properties/fido2-properties.md
- SCIM: janssen-server/reference/json/properties/scim-properties.md
- Config API: janssen-server/reference/json/properties/config-api-properties.md
- Feature Flags:
- janssen-server/reference/json/feature-flags/README.md
- Auth Server: janssen-server/reference/json/feature-flags/janssenauthserver-feature-flags.md
- Kubernetes Reference:
- janssen-server/reference/kubernetes/README.md
- Configuration Keys: janssen-server/reference/kubernetes/config-secret-keys.md
- Logout Status JWT: janssen-server/auth-server/tokens/logout-status-jwt.md
# ====================
# 3. INTEGRATE & AUTHENTICATE
# ====================
- Integrate & Authenticate:
- Overview: janssen-server/auth-server/README.md
- OAuth 2.0:
- janssen-server/auth-server/oauth-features/README.md
- Grants & Flows:
- Authorization Code Grant: janssen-server/auth-server/oauth-features/auth-code-grant.md
- Client Credential Grant: janssen-server/auth-server/oauth-features/client-credential-grant.md
- Device Grant: janssen-server/auth-server/oauth-features/device-grant.md
- Implicit Grant: janssen-server/auth-server/oauth-features/implicit-grant.md
- JWT Grant: janssen-server/auth-server/oauth-features/jwt-grant.md
- Password Grant: janssen-server/auth-server/oauth-features/password-grant.md
- Security Extensions:
- PKCE: janssen-server/auth-server/oauth-features/pkce.md
- DPoP: janssen-server/auth-server/oauth-features/dpop.md
- MTLS: janssen-server/auth-server/oauth-features/mtls.md
- PAR: janssen-server/auth-server/oauth-features/par.md
- Client ID Metadata Document: janssen-server/auth-server/oauth-features/cimd.md
- Tokens:
- janssen-server/auth-server/tokens/README.md
- Access Tokens: janssen-server/auth-server/tokens/oauth-access-tokens.md
- Refresh Tokens: janssen-server/auth-server/tokens/oauth-refresh-tokens.md
- Transaction Tokens: janssen-server/auth-server/tokens/oauth-tx-tokens.md
- Rich Authorization Requests: janssen-server/auth-server/authz-details/README.md
- OpenID Connect:
- janssen-server/auth-server/openid-features/README.md
- id_token: janssen-server/auth-server/openid-features/id-token.md
- OpenID id_token: janssen-server/auth-server/tokens/openid-id-token.md
- Userinfo Token: janssen-server/auth-server/tokens/openid-userinfo-token.md
- Subject Identifiers: janssen-server/auth-server/openid-features/subject-identifiers.md
- ACRs: janssen-server/auth-server/openid-features/acrs.md
- Request Objects: janssen-server/auth-server/openid-features/request-objects.md
- Prompt Parameter: janssen-server/auth-server/openid-features/prompt-parameter.md
- CIBA: janssen-server/auth-server/openid-features/ciba.md
- JARM: janssen-server/auth-server/openid-features/jarm.md
- Native SSO: janssen-server/auth-server/openid-features/native-sso.md
- User Claims: janssen-server/auth-server/openid-features/user-claims/README.md
- Consent:
- janssen-server/auth-server/openid-features/consent/README.md
- Customize: janssen-server/auth-server/openid-features/consent/customize.md
- List/Delete Consent: janssen-server/auth-server/openid-features/consent/list-delete.md
- Logout:
- janssen-server/auth-server/openid-features/logout/README.md
- Front Channel: janssen-server/auth-server/openid-features/logout/front-channel.md
- Back Channel: janssen-server/auth-server/openid-features/logout/back-channel.md
- Customizing Logout: janssen-server/auth-server/openid-features/logout/customizing-logout.md
- Forcing Logout on Browser Exit: janssen-server/auth-server/openid-features/logout/forcing-logout.md
- FIDO2 / Passkeys:
- janssen-server/fido/README.md
- Configuration: janssen-server/fido/config.md
- Vendor Metadata: janssen-server/fido/vendor-metadata.md
- Passwordless Login: janssen-server/fido/passwordlessLoginExperience.md
- Conditional UI and Fallback: janssen-server/fido/conditional-ui-and-fallback.md
- Types of Credentials: janssen-server/fido/types-of-creds.md
- SAML:
- Shibboleth IDP:
- janssen-server/shibboleth-idp/README.md
- Installation: janssen-server/shibboleth-idp/installation.md
- Configuration: janssen-server/shibboleth-idp/configuration.md
- Helm Deployment: janssen-server/shibboleth-idp/helm-deployment.md
- Config API: janssen-server/shibboleth-idp/config-api.md
- Terraform: janssen-server/shibboleth-idp/terraform.md
- Testing: janssen-server/shibboleth-idp/testing.md
- SAML Recipes:
- janssen-server/recipes/saml/README.md
- Federation: janssen-server/recipes/saml/federation.md
- IDP-Initiated SSO: janssen-server/recipes/saml/idp-init-authn.md
- SP Configuration: janssen-server/recipes/saml/sso-sp.md
- UMA:
- janssen-server/auth-server/uma-features/README.md
- RPT Endpoint: janssen-server/auth-server/uma-features/rpt-endpoint.md
- Claims Gathering: janssen-server/auth-server/uma-features/claims-gathering-endpoint.md
- UMA RPT Token: janssen-server/auth-server/tokens/uma-rpt-token.md
- Recipes & How-To:
- janssen-server/recipes/README.md
- Social Login: janssen-server/recipes/social-login.md
- Inbound OIDC: janssen-server/recipes/inbound-oidc.md
- Registration: janssen-server/recipes/registration.md
- Password Expirations: janssen-server/recipes/password-expirations.md
- Locking Accounts: janssen-server/recipes/locking-accounts.md
- Stepped-up Authentication: janssen-server/recipes/stepped-up-authn.md
- User Journeys: janssen-server/recipes/ACRouter.md
- Device Flow: janssen-server/recipes/device-flow-config.md
- Password Validation: janssen-server/recipes/user-password-validation.md
- Benchmark: janssen-server/recipes/benchmark.md
# ====================
# 6. CONFIGURE IDENTITY
# ====================
- Configure Identity:
- Overview: janssen-server/config-guide/README.md
- Configuration Tools:
- TUI (Text-Based UI):
- janssen-server/config-guide/config-tools/jans-tui/README.md
- Navigation Guide: janssen-server/config-guide/config-tools/jans-tui/navigation-guide.md
- Using Logs: janssen-server/config-guide/config-tools/jans-tui/using-command-line-log.md
- CLI (Command Line):
- janssen-server/config-guide/config-tools/jans-cli/README.md
- REST API (Config API):
- janssen-server/config-guide/config-tools/config-api/README.md
- Settings: janssen-server/config-guide/config-tools/config-api/config.md
- Security: janssen-server/config-guide/config-tools/config-api/security.md
- Logs: janssen-server/config-guide/config-tools/config-api/logs.md
- Monitoring: janssen-server/config-guide/config-tools/config-api/monitoring.md
- Plugins: janssen-server/config-guide/config-tools/config-api/plugins.md
- CURL Guide: janssen-server/config-guide/config-tools/curl-guide.md
- Clients & Applications:
- Client Management: janssen-server/auth-server/client-management/README.md
- Client Schema: janssen-server/auth-server/client-management/client-schema.md
- Client Authentication: janssen-server/auth-server/client-management/client-authn.md
- Client Configuration: janssen-server/auth-server/client-management/client-configuration.md
- OpenID Connect Client: janssen-server/config-guide/auth-server-config/openid-connect-client-configuration.md
- Software Statements: janssen-server/auth-server/client-management/software-statements.md
- Sector Identifiers: janssen-server/auth-server/client-management/sector-identifiers.md
- Client Scripts: janssen-server/auth-server/client-management/client-scripts.md
- Scopes & Claims:
- Scopes: janssen-server/auth-server/scopes/README.md
- OAuth Scope Management: janssen-server/config-guide/auth-server-config/oauth-scopes-config.md
- Attributes: janssen-server/config-guide/auth-server-config/attribute-configuration.md
- User Management:
- janssen-server/usermgmt/README.md
- Using SCIM: janssen-server/usermgmt/usermgmt-scim.md
- Using CLI/TUI: janssen-server/usermgmt/usermgmt-cli-tui.md
- Using jans-link: janssen-server/usermgmt/usermgmt-jans-link.md
- SCIM:
- janssen-server/scim/README.md
- Configuration: janssen-server/scim/config.md
- OAuth Protection: janssen-server/scim/oauth-protection.md
- User Resources: janssen-server/config-guide/scim-config/user-config.md
- Group Management: janssen-server/config-guide/scim-config/scim-group-config.md
- Bulk Adding Users: janssen-server/scim/bulk-users.md
- Custom Attributes: janssen-server/scim/custom-attributes.md
- Security: janssen-server/scim/security.md
- Custom Scripts:
- Overview: janssen-server/config-guide/custom-scripts-config.md
- Interception Scripts:
- janssen-server/developer/scripts/README.md
- Application Session: script-catalog/application_session/application-session.md
- Authorization Challenge: script-catalog/authorization_challenge/authorization-challenge.md
- Authorization Detail: script-catalog/authz_detail/authz-detail.md
- CIBA End User Notification: script-catalog/ciba/ciba.md
- Client Registration: script-catalog/client_registration/client-registration.md
- Client Authentication: script-catalog/client_authn/client-authn.md
- Config API: script-catalog/config_api/config-api.md
- IDP: script-catalog/idp/idp-extension.md
- Consent Gathering: script-catalog/consent_gathering/consent-gathering.md
- Dynamic Scope: script-catalog/dynamic_scope/dynamic-scope.md
- End Session: script-catalog/end_session/end-session.md
- ID Generator: script-catalog/id_generator/id-generator.md
- Introspection: script-catalog/introspection/README.md
- OpenID Configuration: script-catalog/discovery/discovery/README.md
- Persistence: script-catalog/persistence_extension/persistence.md
- Person Authentication: script-catalog/person_authentication/person-authentication.md
- Post Authentication: script-catalog/post_authn/post-authentication.md
- ROPC: script-catalog/resource_owner_password_credentials/ropc.md
- Revoke Token: script-catalog/revoke_token/revoke-token.md
- SCIM: script-catalog/scim/scim.md
- Token Exchange: script-catalog/token_exchange/token-exchange.md
- Access Evaluation: script-catalog/access_evaluation/access-evaluation.md
- Access Evaluation Discovery: script-catalog/access_evaluation/access-evaluation-discovery.md
- Logout Status JWT: script-catalog/logout_status_jwt/logout-status-jwt.md
- PAR: script-catalog/par/par.md
- Transaction Token: script-catalog/tx_token/txtoken.md
- Cookie: script-catalog/cookie/cookie.md
- Discovery: script-catalog/discovery/discovery.md
- Select Account: script-catalog/select_account/select-account.md
- Spontaneous Scope: script-catalog/spontaneous_scope/spontaneous-scope.md
- Fido2 Extension: script-catalog/fido2_extension/fido2-extension.md
- Create User: script-catalog/create_user/create-user.md
- Health Check: script-catalog/health_check/health-check.md
- UMA Claims (JWT): script-catalog/uma_rpt_claims/uma-claims-jwt.md
- UMA Claims Gathering: script-catalog/uma_claims_gathering/uma-claims-web.md
- UMA RPT Policies: script-catalog/uma_rpt_policy/uma-rpt.md
- Update Token: script-catalog/update_token/update-token.md
- Link Interception: script-catalog/link_interception/link-interception.md
- SSA Modify Response: script-catalog/ssa/ssa-modify-response.md
- Auth Server Settings:
- Server Configuration: janssen-server/auth-server/config.md
- Authentication Methods: janssen-server/config-guide/auth-server-config/authentication-method-config.md
- Properties: janssen-server/config-guide/auth-server-config/jans-authorization-server-config.md
- Logging: janssen-server/config-guide/auth-server-config/logging-configuration.md
- SSA Configuration: janssen-server/config-guide/auth-server-config/ssa-config.md
- Agama Projects: janssen-server/config-guide/auth-server-config/agama-project-configuration.md
- Cache Configuration: janssen-server/config-guide/auth-server-config/cache-configuration.md
- Rate Limiting: janssen-server/config-guide/auth-server-config/rate-limit.md
- UMA Resources: janssen-server/config-guide/auth-server-config/oauth-umaresources-config.md
- JSON Web Keys: janssen-server/config-guide/auth-server-config/json-web-key-config.md
- Casa (Self-Service Portal):
- casa/index.md
- Administration:
- Admin Console: casa/administration/admin-console.md
- About 2FA: casa/administration/2fa-basics.md
- Custom Branding: casa/administration/custom-branding.md
- URL Path Customization: casa/administration/change-context-path.md
- Localization: casa/administration/localization.md
- FAQ: casa/administration/faq.md # also in FAQ & Troubleshooting for discoverability
- Plugins:
- 2FA Settings: casa/plugins/2fa-settings.md
- Accounts Linking:
- casa/plugins/accts-linking/account-linking-index.md
- Agama Project: casa/plugins/accts-linking/accts-linking-agama.md
- BioID: casa/plugins/bioid.md
- Consent Management: casa/plugins/consent-management.md
- Custom Branding: casa/plugins/custom-branding.md
- Email OTP: casa/plugins/email-otp.md
- Certificate Authentication:
- casa/plugins/cert-authn.md
- Smart Card Tutorial: casa/plugins/cert-authn-tutorial.md
- Developer Guide:
- Overview: casa/developer/overview.md
- Adding Auth Methods: casa/developer/add-authn-methods.md
- User Guide: casa/user-guide.md
- Sessions:
- Session Management: janssen-server/auth-server/session-management/README.md
- IDP vs RP Sessions: janssen-server/auth-server/session-management/idp-v-rp.md
- Multiple Sessions: janssen-server/auth-server/session-management/multiple-sessions-one-browser.md
- Session Configuration: janssen-server/config-guide/auth-server-config/session-management.md
- Session Guide: janssen-server/config-guide/session.md
- Additional Settings:
- SMTP Configuration: janssen-server/config-guide/smtp-configuration.md
- Hash Passwords: janssen-server/config-guide/hash-password.md
- Link Configuration: janssen-server/config-guide/link-configuration.md
- Custom Assets: janssen-server/config-guide/custom-assets-configuration.md
- FIDO2 Configuration: janssen-server/config-guide/fido2-config/janssen-fido2-configuration.md
# ====================
# 7. TEST & DEBUG
# ====================
- Test & Debug:
- Overview: janssen-server/test-debug/README.md
- Logging:
- janssen-server/auth-server/logging/README.md
- Standard Logs: janssen-server/auth-server/logging/standard-logs.md
- Log Levels: janssen-server/auth-server/logging/log-levels.md
- Audit Logs: janssen-server/auth-server/logging/audit-logs.md
- Custom Logs: janssen-server/auth-server/logging/custom-logs.md
- log4j2 Configuration: janssen-server/auth-server/logging/log4j2.md
- FIDO Logs: janssen-server/fido/logs.md
- SCIM Logs: janssen-server/scim/logs.md
- VM Logs: janssen-server/vm-ops/logs.md
- Kubernetes Logs: janssen-server/kubernetes-ops/logs.md
- Debugging:
- Script Debugging: janssen-server/developer/scripts/interception-scripts-debug.md
- Remote Debugging: contribute/development/remote-debugging.md
- Health Checks:
- Kubernetes Health Check: janssen-server/kubernetes-ops/health-check.md
- VM Service Status: janssen-server/vm-ops/checking-service-status.md
- Monitoring:
- Reporting & Metrics: janssen-server/auth-server/reporting-metrics/README.md
- SCIM Monitoring: janssen-server/scim/monitoring.md
- Testing:
- Testing Guide: contribute/testing.md
- Integration Tests: contribute/development/run-integration-tests.md
- FAQ & Troubleshooting:
- Install FAQ: janssen-server/install/install-faq.md
- Developer FAQ: contribute/developer-faq.md
- Casa FAQ: casa/administration/faq.md # duplicate: also under Casa > Administration
# ====================
# 8. DEPLOY & OPERATE
# ====================
- Deploy & Operate:
- Overview: janssen-server/README.md
- Planning:
- Overview: janssen-server/planning/overview.md
- Components: janssen-server/planning/components.md # also in Architecture & Concepts for discoverability
- Kubernetes: janssen-server/planning/kubernetes.md
- VM Cluster: janssen-server/planning/vm-cluster.md
- VM Single Instance: janssen-server/planning/vm-single-instance.md
- Persistence: janssen-server/planning/persistence.md
- Caching: janssen-server/planning/caching.md
- Security Best Practices: janssen-server/planning/security-best-practices.md
- Load Balancers: janssen-server/planning/load-balancers.md
- Certificates/Keys: janssen-server/planning/certificates-keys.md
- DNS: janssen-server/planning/dns.md
- Multi-tenancy: janssen-server/planning/multi-tenancy.md
- Benchmarking: janssen-server/planning/benchmarking.md
- Application Portal: janssen-server/planning/application-portal.md
- Discovery: janssen-server/planning/discovery.md
- Customization/Localization: janssen-server/planning/customization.md
- Timeout Management: janssen-server/planning/timeout-management.md
- Identity Management: janssen-server/planning/identity-management.md
- Self-Service Password/2FA: janssen-server/planning/self-service-password-2fa.md
- Identity Access Governance: janssen-server/planning/identity-access-governance.md
- Role Based Access: janssen-server/planning/role-based-access-management.md
- Central Auth Service: janssen-server/planning/central-auth-service.md
- Stepped-up Auth: janssen-server/planning/stepped-up-auth.md
- Delegated User Admin: janssen-server/planning/delegated-user-admin.md
- Passwordless Auth: janssen-server/planning/passwordless-auth.md
- Machine-to-Machine: janssen-server/planning/machine-to-machine.md
- Installation:
- janssen-server/install/README.md
- VM Installation:
- janssen-server/install/vm-install/README.md
- VM Requirements: janssen-server/install/vm-install/vm-requirements.md
- Ubuntu: janssen-server/install/vm-install/ubuntu.md
- RHEL: janssen-server/install/vm-install/rhel.md
- Suse: janssen-server/install/vm-install/suse.md
- Dynamic Download: janssen-server/install/vm-install/dynamic-download.md
- Helm Deployments:
- janssen-server/install/helm-install/README.md
- Platform Setup:
- Amazon EKS: janssen-server/install/helm-install/prerequisites/amazon-eks.md
- Google GKE: janssen-server/install/helm-install/prerequisites/google-gke.md
- Microsoft AKS: janssen-server/install/helm-install/prerequisites/microsoft-aks.md
- Local (Minikube/MicroK8s): janssen-server/install/helm-install/prerequisites/local.md
- Rancher Marketplace: janssen-server/install/helm-install/prerequisites/rancher.md
- Ingress Setup: janssen-server/install/helm-install/ingress-setup.md
- Database Setup: janssen-server/install/helm-install/database-setup.md
- Install Janssen: janssen-server/install/helm-install/install-janssen.md
- Post-Installation: janssen-server/install/helm-install/post-install.md
- Docker:
- Quick Start: janssen-server/install/docker-install/quick-start.md
- Docker Compose: janssen-server/install/docker-install/compose.md
- Setup Instructions: janssen-server/install/setup.md
- Kubernetes Operations:
- janssen-server/kubernetes-ops/README.md
- Upgrade: janssen-server/kubernetes-ops/upgrade.md
- Scaling: janssen-server/kubernetes-ops/scaling.md
- Backup and Restore: janssen-server/kubernetes-ops/backup-restore.md
- Certificate Management: janssen-server/kubernetes-ops/cert-management.md
- Customization: janssen-server/kubernetes-ops/customization.md
- Start Order: janssen-server/kubernetes-ops/start-order.md
- External Secrets/Configmaps: janssen-server/kubernetes-ops/external-secrets-configmaps.md
- TUI for K8s: janssen-server/kubernetes-ops/tui-k8s.md
- Custom Attributes: janssen-server/kubernetes-ops/custom-attributes.md
- Memory Dump: janssen-server/kubernetes-ops/memory-dump.md
- VM Operations:
- janssen-server/vm-ops/README.md
- Upgrade: janssen-server/vm-ops/upgrade.md
- Backup: janssen-server/vm-ops/backup.md
- Restarting Services: janssen-server/vm-ops/restarting-services.md
- Key Rotation: janssen-server/vm-ops/managing-key-rotation.md
- Certificates: janssen-server/vm-ops/certificates.md
- Jans Command: janssen-server/vm-ops/jans-command.md
- Data Cleaning: janssen-server/vm-ops/data-cleaning.md
- Database:
- janssen-server/reference/database/README.md
- RDBMS Erwin Table: janssen-server/reference/database/rdbms-erwin.md
- MySQL:
- Schema: janssen-server/reference/database/mysql-schema.md
- Configuration: janssen-server/reference/database/mysql-config.md
- Operations: janssen-server/reference/database/mysql-ops.md
- PostgreSQL:
- Schema: janssen-server/reference/database/pgsql-schema.md
- Indexes: janssen-server/reference/database/pgsql-schema-indexes.md
- Configuration: janssen-server/reference/database/pgsql-config.md
- Operations: janssen-server/reference/database/pgsql-ops.md
- Terraform & IaC:
- janssen-server/terraform/README.md
- Link (User Sync):
- janssen-server/link/README.md
- Jans LDAP Link: janssen-server/link/jans-link.md
- Lock:
- janssen-server/lock/README.md
- Lock Server: janssen-server/lock/lock-server.md
# ====================
# 9. PRODUCT, RELEASES & SUPPORT
# ====================
- Product & Releases:
- Changelog: CHANGELOG.md
- Version Support Policy: EOL.md
- Contributing:
- Contribution Guidelines: CONTRIBUTING.md
- Code of Conduct: CODE_OF_CONDUCT.md
- Governance:
- Charter: governance/charter.md
- Copyright Notices: governance/copyright-notices.md
- Triage: governance/triage.md
- Development Setup:
- contribute/development/development.md
- Local Run Under Eclipse: contribute/development/local-run-under-eclipse.md
- Useful Tools: contribute/development/useful-tools.md
- CI/CD:
- Release Process: contribute/ci-cd/release-process.md
# ====================
# 4. AGAMA
# ====================
- Agama:
- Introduction: agama/introduction.md
- Language Reference: agama/language-reference.md
- API reference: https://janssenproject.github.io/developer-docs/agama/transpiler/index.html
- Execution Rules: agama/execution-rules.md
- Gama Format: agama/gama-format.md
- Agama Engine: janssen-server/developer/agama/jans-agama-engine.md
- Engine Configuration: janssen-server/developer/agama/engine-bridge-config.md
- Project Deployment: janssen-server/developer/agama/projects-deployment.md
- Navigation & UI: janssen-server/developer/agama/flows-navigation-ui.md
- Native Applications: janssen-server/developer/agama/native-applications.md
- Best Practices: janssen-server/developer/agama/agama-best-practices.md
- Advanced Usages: janssen-server/developer/agama/advanced-usages.md
- FAQ: janssen-server/developer/agama/faq.md
# ====================
# 5. CEDARLING
# ====================
- Cedarling:
- Overview: cedarling/README.md
- Cedar Introduction: cedar-intro.md
- Quick Start: cedarling/quick-start/cedarling-quick-start.md
- Tutorials:
- Getting Started: cedarling/tutorials/cedarling-getting-started.md
- Javascript: cedarling/tutorials/javascript.md
- Python: cedarling/tutorials/python.md
- Rust: cedarling/tutorials/rust.md
- Golang: cedarling/tutorials/go.md
- Java: cedarling/tutorials/java.md
- Kotlin: cedarling/tutorials/kotlin.md
- Swift: cedarling/tutorials/swift.md
- Reference:
- Authorization: cedarling/reference/cedarling-authz.md
- Multi-Issuer: cedarling/reference/cedarling-multi-issuer.md
- Interfaces: cedarling/reference/cedarling-interfaces.md
- Policy Store: cedarling/reference/cedarling-policy-store.md
- Properties: cedarling/reference/cedarling-properties.md
- Boolean Operations: cedarling/reference/cedarling-principal-boolean-operations.md
- JWT Validation: cedarling/reference/cedarling-jwt-validation.md
- Entities: cedarling/reference/cedarling-entities.md
- Logs: cedarling/reference/cedarling-logs.md
- Lock Server: cedarling/reference/cedarling-lock-server.md
- Developer:
- Rust: cedarling/developer/cedarling-rust.md
- Kotlin/Java: cedarling/developer/cedarling-kotlin.md
- Mobile Apps:
- UniFFI Interface: cedarling/developer/mobile-apps/cedarling-uniffi.md
- Android: cedarling/developer/mobile-apps/cedarling-android.md
- iOS: cedarling/developer/mobile-apps/cedarling-ios.md
- Sidecar:
- Overview: cedarling/developer/sidecar/cedarling-sidecar-overview.md
- Tutorial: cedarling/developer/sidecar/cedarling-sidecar-tutorial.md
- Interface Reference:
- Rust: https://janssenproject.github.io/developer-docs/cedarling/cedarling/index.html
- Python: https://janssenproject.github.io/developer-docs/cedarling-python/cedarling_python.html
- Integrations:
- KrakenD: cedarling/integrations/cedarling-krakend.md
plugins:
- include-markdown
- tags
- search
- git-revision-date-localized:
enable_creation_date: true
type: timeago
repo_name: GitHub
repo_url: https://github.com/JanssenProject/jans/
site_author: Janssen, Inc.
site_description: Janssen Project Deployment and Operation References
site_name: Janssen Documentation
site_url: https://docs.jans.io
theme:
custom_dir: docs/overrides
favicon: assets/janssen_project_favicon_transparent_50px_50px.ico
features:
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
- navigation.indexes
- navigation.prune
- navigation.path
- navigation.top
- navigation.instant
- navigation.instant.progress
- search.suggest
- search.highlight
- search.share
- content.tabs.link
- content.code.copy
- content.code.select
- content.code.annotate
- toc.follow
font:
code: Roboto Mono
text: Roboto
highlightjs: true
hljs_languages:
- yaml
- java
- bash
- python
language: en
logo: assets/janssen_project.svg
name: material
palette:
- accent: green
media: (prefers-color-scheme)
primary: green
toggle:
icon: material/brightness-auto
name: Switch to light mode
- accent: green
media: '(prefers-color-scheme: light)'
primary: green
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
- accent: green
media: '(prefers-color-scheme: dark)'
primary: green
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to system preference
shortcuts:
help: 191
next: 78
previous: 80
search: 83