forked from wso2/docs-is
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
687 lines (677 loc) · 44.3 KB
/
mkdocs.yml
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
# Copyright (c) 2023-2025, WSO2 LLC. (https://www.wso2.com).
#
# WSO2 LLC. licenses this file to you under the Apache License,
# Version 2.0 (the "License"); you may not use this file except
# in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
INHERIT: ../base.yml
# Project information
site_name: &site_name Asgardeo
site_description: Asgardeo Learning Center
site_url: https://wso2.com/asgardeo/docs
# Configuration
theme:
custom_dir: ../theme/material
logo: assets/images/asgardeo-docs-logo-dark.svg
logo_light: assets/images/asgardeo-docs-logo.svg
favicon: assets/images/asgardeo-favicon.svg
extra:
base_path: /asgardeo/docs
product: asgardeo
product_name: *site_name
explicit_tab_list:
- Home
- Get Started
- Guides
- Tutorials
- Integrations
- APIs
- References
- Concepts
home_page_cards:
- section:
- title: Get Started
icon: octicons/rocket-16
icon_color: icon-color-1
list_items:
- title: Create your Asgardeo account
url: Get started|Create your Asgardeo account
- title: Try login with Asgardeo
url: Get started|Try login with sample
- title: Community and Support
icon: octicons/light-bulb-16
icon_color: icon-color-2
list_items:
- title: Community Help
url: https://discord.com/invite/wso2
- title: Enterprise Support
url: https://wso2.com/asgardeo/pricing/
- section:
- title: Guides
icon: octicons/book-16
icon_color: icon-color-4
list_items:
- title: Applications
url: Guides|Applications|Applications
- title: Authentication
url: Guides|Authentication|Authentication
- title: API authorization
url: Guides|Authorization|Authorization
- title: Branding
url: Guides|Customizations|Customize branding|Customize branding
- title: User management
url: Guides|User management|User management
- title: User self-service
url: Guides|User self-service|User self-service
- title: Organizations
url: Guides|Organizations|Organizations
- section:
- title: Developer Resources
icon: octicons/tools-16
icon_color: icon-color-3
list_items:
- title: APIs
url: APIs|APIs - Overview
- title: Tutorials
url: Tutorials|Tutorials - Overview
- title: SDKs and Integrations
url: SDKs|Integrate Asgardeo into your application
watch:
- ../theme/material
- ../base.yml
hooks:
- hooks.py
plugins:
- search:
indexing: "full"
separator: "[^\\w._]+"
lang: ['en']
prebuild_index: true
ngram_length: 30
- markdownextradata: {}
- include-markdown
- redirects:
redirect_maps:
'references/grant-types-in-asgardeo.md': 'references/grant-types.md'
'guides/users/manage-collaborators.md': 'guides/users/manage-administrators.md'
'guides/users/manage-customers.md': 'guides/users/manage-users.md'
'guides/user-self-service/register-security-key.md': 'guides/user-self-service/register-passkey.md'
'guides/authentication/enterprise-login/index.md': 'guides/authentication/standard-based-login/index.md'
'guides/authentication/enterprise-login/add-oidc-idp-login.md': 'guides/authentication/standard-based-login/add-oidc-idp-login.md'
'guides/authentication/enterprise-login/add-saml-idp-login.md': 'guides/authentication/standard-based-login/add-saml-idp-login.md'
'guides/asgardeo-events.md': 'guides/monitoring/asgardeo-events.md'
'guides/user-self-service/customer-self-service-portal.md': 'guides/user-self-service/configure-self-service-portal.md'
'guides/authentication/conditional-auth/ai-loginflow.md': 'guides/authentication/ai-loginflow.md'
'guides/user-accounts/configure-self-service-portal.md': 'guides/user-self-service/configure-self-service-portal.md'
'guides/organization-management/onboard-sub-org-admins.md': 'guides/organization-management/onboard-org-admins.md'
'guides/authentication/configure-a-trusted-token-issuer.md': 'guides/authentication/configure-token-exchange.md'
'guides/applications/manage-application-roles.md': 'guides/users/manage-roles.md'
'guides/authentication/app-native-authentication/configure-advanced-app-native-settings.md': 'guides/authentication/app-native-authentication/index.md'
'apis/authentication.md': 'apis/index.md'
'apis/organization-apis/org-user-mgt.md': 'apis/organization-apis/scim2/scim2-org-user-mgt.md'
'apis/organization-apis/org-group-mgt.md': 'apis/organization-apis/scim2/scim2-org-group-mgt.md'
'apis/organization-apis/scim-bulk.md': 'apis/organization-apis/scim2/scim2-org-bulk.md'
'apis/build-scim2-user-creation-payload.md': 'apis/scim2/build-scim2-user-creation-payload.md'
'guides/api-authorization.md' : 'guides/authorization/api-authorization/api-authorization.md'
'guides/user-accounts/index.md': 'guides/account-configurations/index.md'
'references/application-logs.md' : 'guides/asgardeo-logs.md'
'apis/oauth-dcr.md' : 'apis/dynamic-client-registration-rest-api.md'
'/guides/authorization/impersonation/user-impersonation/' : '/guides/authorization/user-impersonation/'
'guides/branding/localization-in-asgardeo.md': 'guides/branding/localization.md'
'guides/user-accounts/password-recovery.md': 'guides/account-configurations/account-recovery/password-recovery.md'
'guides/user-accounts/account-security/login-attempts-security.md': 'guides/account-configurations/account-security/login-attempts.md'
'guides/user-accounts/account-security/password-validation.md': 'guides/account-configurations/login-security/password-validation.md'
'guides/user-accounts/configure-self-registration.md': 'guides/account-configurations/user-onboarding/self-registration.md'
'guides/organization-management/invite-parent-organization-users.md': 'guides/organization-management/onboard-users.md'
'apis/organization-apis/org-application-management.md': 'apis/organization-apis/shared-application-management.md'
exclude_docs: |
/get-started/hello-world.md
not_in_nav: |
/page-not-found.md
/get-started/explore-asgardeo.md
/get-started/start-integrating-apps.md
/get-started/try-samples/index.md
/get-started/try-your-own-app/index.md
/get-started/try-your-own-app/angular.md
/get-started/hello-world.md
# Navigation
nav:
- Home:
- Home: index.md
- Get started:
- Get Started - Overview: get-started/index.md
- Create your Asgardeo account: get-started/create-asgardeo-account.md
- Try login with sample: get-started/try-it-application.md
- Start integrating Asgardeo into apps:
- Start integrating Asgardeo into apps: get-started/start-integrating-apps/index.md
- Try for a sample app:
- Try for a sample app: get-started/try-samples/index.md
- Single Page apps:
- React: get-started/try-samples/qsg-spa-react.md
- Javascript: get-started/try-samples/qsg-spa-javascript.md
- Web apps:
- OIDC Java EE: get-started/try-samples/qsg-oidc-webapp-java-ee.md
- SAML Java EE: get-started/try-samples/qsg-saml-webapp-java-ee.md
- Try for your own app:
- Try for your own app: get-started/try-your-own-app/index.md
- Single Page apps:
- React: get-started/try-your-own-app/react.md
- Javascript: get-started/try-your-own-app/javascript.md
- Web apps:
- OIDC Java EE: get-started/try-your-own-app/java-ee-oidc.md
- SAML Java EE: get-started/try-your-own-app/java-ee-saml.md
- Connect/Build your app:
- React Quickstart: quick-starts/react.md
- Angular Quickstart: quick-starts/angular.md
- Javascript Quickstart: quick-starts/javascript.md
- Next.js Quickstart: quick-starts/nextjs.md
- Spring Boot Quickstart: quick-starts/springboot.md
# TODO: Enable the following sections after the preoper content is added
# - Design login flow:
# - Style login flow: guides/branding/branding-ai.md
# - Customize login flow: guides/authentication/login-flow-ai.md
- Guides:
- Guides - Overview: guides/index.md
- Applications:
- Applications: guides/applications/index.md
- Register an SPA: guides/applications/register-single-page-app.md
- Register web app with OIDC: guides/applications/register-oidc-web-app.md
- Register web app with SAML: guides/applications/register-saml-web-app.md
- Register a standard-based app: guides/applications/register-standard-based-app.md
- Register a mobile app: guides/applications/register-mobile-app.md
- Register a machine-to-machine app: guides/applications/register-machine-to-machine-app.md
- Register a FAPI-compliant app: guides/applications/register-a-fapi-compliant-app.md
- Authentication:
- Authentication: guides/authentication/index.md
- Add login to apps:
- guides/authentication/add-login-to-apps.md
- Add login to an SPA: guides/authentication/add-login-to-single-page-app.md
- Add login to a web app: guides/authentication/add-login-to-web-app.md
- Add login to a mobile app: guides/authentication/add-login-to-mobile-app.md
- Add login to SaaS apps:
- Add SSO login to SaaS apps: guides/authentication/sso-integrations/index.md
- Google Workspace: guides/authentication/sso-integrations/add-google-workspace-template.md
- Salesforce: guides/authentication/sso-integrations/add-salesforce-template.md
- Microsoft 365: guides/authentication/sso-integrations/add-microsoft-365-template.md
- Zoom: guides/authentication/sso-integrations/add-zoom-template.md
- Slack: guides/authentication/sso-integrations/add-slack-template.md
- Add passwordless login:
- Add passwordless login: guides/authentication/passwordless-login/index.md
- Add login with Magic link: guides/authentication/passwordless-login/add-passwordless-login-with-magic-link.md
- Add login with Passkey: guides/authentication/passwordless-login/add-passwordless-login-with-passkey.md
- Add login with HYPR: guides/authentication/passwordless-login/add-passwordless-login-with-hypr.md
- Add login with Email OTP: guides/authentication/passwordless-login/add-passwordless-login-with-email-otp.md
- Add login with SMS OTP: guides/authentication/passwordless-login/add-passwordless-login-with-sms-otp.md
- Add login with Push Notification: guides/authentication/passwordless-login/add-passwordless-login-with-push-notification.md
- Enable user attributes:
- Enable user attributes: guides/authentication/user-attributes/index.md
- Enable attributes for OIDC apps: guides/authentication/user-attributes/enable-attributes-for-oidc-app.md
- Enable attributes for SAML apps: guides/authentication/user-attributes/enable-attributes-for-saml-app.md
- Manage consent for user attributes: guides/authentication/manage-consent-for-attributes.md
- Add federated login:
- Add federated login: guides/authentication/federated-login/index.md
- Add social login:
- Add social login: guides/authentication/social-login/index.md
- Add Facebook login: guides/authentication/social-login/add-facebook-login.md
- Add Github login: guides/authentication/social-login/add-github-login.md
- Add Google login: guides/authentication/social-login/add-google-login.md
- Add Microsoft login: guides/authentication/social-login/add-microsoft-login.md
- Add Apple login: guides/authentication/social-login/add-apple-login.md
- Add LinkedIn login: guides/authentication/social-login/add-linkedin-login.md
- Add decentralized login:
- Add decentralized login: guides/authentication/decentralized-login/index.md
- Sign-in with Ethereum: guides/authentication/decentralized-login/sign-in-with-ethereum.md
- Add standard-based login:
- Add standard-based login: guides/authentication/standard-based-login/index.md
- Add login with OIDC IdP: guides/authentication/standard-based-login/add-oidc-idp-login.md
- Add login with SAML IdP: guides/authentication/standard-based-login/add-saml-idp-login.md
- Add identifier first login: guides/authentication/add-identifier-first-login.md
- Add multi-factor authentication:
- Add multi-factor authentication: guides/authentication/mfa/index.md
- Add TOTP: guides/authentication/mfa/add-totp-login.md
- Add Email OTP: guides/authentication/mfa/add-emailotp-login.md
- Add SMS OTP: guides/authentication/mfa/add-smsotp-login.md
- Add Push Notification: guides/authentication/mfa/add-push-auth-login.md
- Add Passkey: guides/authentication/mfa/add-passkey-login.md
- Add iProov: guides/authentication/mfa/add-iproov-login.md
- Add Duo: guides/authentication/mfa/add-duo-login.md
- Add user-preferred MFA: guides/authentication/mfa/user-preferred-mfa-login.md
- Add conditional authentication:
- Add conditional authentication: guides/authentication/conditional-auth/index.md
- Set up conditional authentication: guides/authentication/conditional-auth/configure-conditional-auth.md
- Add access control:
- Add access control: guides/authentication/conditional-auth/access-control.md
- User Age-based access: guides/authentication/conditional-auth/user-age-based-template.md
- Group-based access: guides/authentication/conditional-auth/group-based-template-access-control.md
- Concurrent session-based access: guides/authentication/conditional-auth/concurrent-session-based-template.md
- Add adaptive MFA:
- Add adaptive MFA: guides/authentication/conditional-auth/adaptive-mfa.md
- MFA based on user group: guides/authentication/conditional-auth/group-based-template.md
- MFA based on sign-in option: guides/authentication/conditional-auth/sign-in-option-based-template.md
- MFA based on user device: guides/authentication/conditional-auth/new-device-based-template.md
- MFA based on IP address: guides/authentication/conditional-auth/ip-based-template.md
- MFA based on advanced conditions (using WSO2 Choreo): guides/authentication/conditional-auth/add-authentications-based-on-api-calls.md
- Add passkey progressive enrollment: guides/authentication/conditional-auth/passkey-progressive-enrollment-based-template.md
- Add push notification device progressive enrollment: guides/authentication/conditional-auth/push-device-progressive-enrollment-based-template.md
- Add on-demand silent password migration: guides/authentication/conditional-auth/on-demand-silent-password-migration-template.md
- Write a custom authentication script: guides/authentication/conditional-auth/write-your-first-script.md
- App-native authentication:
- App-native authentication: guides/authentication/app-native-authentication/index.md
- Add app-native authentication: guides/authentication/app-native-authentication/add-app-native-authentication.md
- Secure app-native authentication flows: guides/authentication/app-native-authentication/secure-app-native-authentication-flows.md
- Handle advanced login scenarios: guides/authentication/app-native-authentication/handle-advanced-login-scenarios.md
- Login Flow AI: guides/authentication/login-flow-ai.md
- Configure OIDC flows:
- Configure OIDC flows: guides/authentication/oidc/index.md
- Discover OIDC endpoints: guides/authentication/oidc/discover-oidc-configs.md
- Implement login using the Authorization Code flow: guides/authentication/oidc/implement-auth-code.md
- Implement login using the Authorization Code flow and PKCE: guides/authentication/oidc/implement-auth-code-with-pkce.md
- Implement private key JWT client authentication: guides/authentication/oidc/private-key-jwt-client-auth.md
- Implement login using Pushed Authorization Requests: guides/authentication/oidc/implement-login-with-par.md
- JWT Secured Authorization Response Mode (JARM) for OAuth 2.0: guides/authentication/oidc/jarm.md
- Implement login using the OIDC Hybrid Flow: guides/authentication/oidc/implement-oidc-hybrid-flow.md
- Configure token exchange: guides/authentication/configure-token-exchange.md
- Validate ID tokens: guides/authentication/oidc/validate-id-tokens.md
- Request user information: guides/authentication/oidc/request-user-info.md
- Validate tokens: guides/authentication/oidc/token-validation-resource-server.md
- Revoke tokens: guides/authentication/oidc/revoke-tokens.md
- Implement logout:
- RP-initiated logout: guides/authentication/oidc/add-logout.md
- Back channel logout: guides/authentication/oidc/add-back-channel-logout.md
- Configure SAML flows:
- Configure SAML flows: guides/authentication/saml/index.md
- Discover SAML endpoints and settings: guides/authentication/saml/discover-saml-configs.md
- Configure Just-in-Time user provisioning: guides/authentication/jit-user-provisioning.md
- Authorization:
- Authorization: guides/authorization/index.md
- API authorization:
- Role-based access control: guides/authorization/api-authorization/api-authorization.md
- User impersonation: guides/authorization/user-impersonation.md
- Identity Verification:
- Identity Verification: guides/identity-verification/index.md
- Configure an Identity Verification Provider: guides/identity-verification/configure-identity-verification-provider.md
- Identity Verification with Onfido: guides/identity-verification/add-identity-verification-with-onfido.md
- User management:
- User management: guides/users/index.md
- Manage administrators: guides/users/manage-administrators.md
- Manage users: guides/users/manage-users.md
- Manage groups: guides/users/manage-groups.md
- Manage roles: guides/users/manage-roles.md
- Manage active sessions: guides/users/manage-sessions.md
- Migrate users to Asgardeo:
- Migrate users to Asgardeo: guides/users/migrate-users/index.md
- Migrate user accounts: guides/users/migrate-users/migrate-users.md
- Migrate user passwords: guides/users/migrate-users/migrate-passwords.md
- Manage attributes and mappings:
- Manage attributes and mappings: guides/users/attributes/index.md
- User attributes: guides/users/attributes/manage-attributes.md
- OIDC attribute mappings: guides/users/attributes/manage-oidc-attribute-mappings.md
- OIDC scopes: guides/users/attributes/manage-scopes.md
- SCIM2 attribute mappings: guides/users/attributes/manage-scim2-attribute-mappings.md
- Configure unique attributes: guides/users/attributes/configure-unique-attributes.md
- Verification and notification settings for attribute updates:
- Configure settings: guides/users/attributes/user-attribute-change-verification.md
- Try it out:
- Email address update verification: guides/users/attributes/email-verification-on-update.md
- Mobile number update verification: guides/users/attributes/mobile-verification-on-update.md
- Manage user stores:
- Manage user stores: guides/users/user-stores/index.md
- Connect a remote user store: guides/users/user-stores/configure-a-user-store.md
- Configure high availability: guides/users/user-stores/configure-high-availability.md
- Manage remote user stores: guides/users/user-stores/update-user-stores.md
- Deployment best practices: guides/users/user-stores/deployment-best-practices.md
- Advanced configuration for the agent: guides/users/user-stores/advanced-configurations-for-the-agent.md
- Account configurations:
- Account configurations: guides/account-configurations/index.md
- Login security:
- Login attempts: guides/account-configurations/login-security/login-attempts.md
- Password validation: guides/account-configurations/login-security/password-validation.md
- Bot detection: guides/account-configurations/login-security/bot-detection.md
- Fraud detection: guides/account-configurations/login-security/sift-fraud-detection.md
- Account recovery:
- Password recovery: guides/account-configurations/account-recovery/password-recovery.md
- User onboarding:
- Self-registration: guides/account-configurations/user-onboarding/self-registration.md
- Manage login identifiers:
- Configure username validation: guides/account-configurations/account-login/username-validation.md
- Configure alternative login identifiers: guides/user-accounts/account-login/configure-login-identifiers.md
- Account disabling: guides/account-configurations/account-disabling.md
- User self-service:
- User self-service: guides/user-self-service/index.md
- Self-service portal:
- Configure the self-service portal: guides/user-self-service/configure-self-service-portal.md
- Update profile information: guides/user-self-service/update-profile-info.md
- Change password: guides/user-self-service/change-password.md
- Manage linked social accounts: guides/user-self-service/manage-linked-accounts.md
- Export profile information: guides/user-self-service/export-profile-information.md
- Manage consents: guides/user-self-service/manage-consents.md
- Manage login sessions: guides/user-self-service/manage-login-sessions.md
- Self-register: guides/user-self-service/self-register.md
- Register passkeys: guides/user-self-service/register-passkey.md
- Register Push Notification Device: guides/user-self-service/register-push-notification-device.md
- Password recovery: guides/user-self-service/user-password-recovery.md
- Enroll TOTP: guides/user-self-service/enable-totp.md
- Manage backup codes: guides/user-self-service/manage-backup-codes.md
- Discover applications: guides/user-self-service/discover-applications.md
- Build self-service capabilities: guides/user-self-service/build-self-service-capabilities.md
- Organizations:
- Organizations: guides/organization-management/index.md
- Set up organizations: guides/organization-management/manage-organizations.md
- Administration of organizations: guides/organization-management/manage-b2b-administration.md
- Share applications: guides/organization-management/share-applications.md
- Onboard admins:
- Onboard admins: guides/organization-management/onboard-org-admins/index.md
- Sales-led approach: guides/organization-management/onboard-org-admins/sales-led-approach.md
- Self-service approach: guides/organization-management/onboard-org-admins/self-service-approach.md
- Onboard users: guides/organization-management/onboard-users.md
- Share user profiles with organizations: guides/organization-management/share-user-profiles.md
- Try a B2B use case: guides/organization-management/try-a-b2b-use-case.md
- API authorization for organizations: guides/organization-management/api-authorization-for-b2b.md
- Email domain based organization discovery: guides/organization-management/email-domain-based-organization-discovery.md
- Customizations:
- Customize branding:
- Customize branding: guides/branding/index.md
- Configure UI branding: guides/branding/configure-ui-branding.md
- Branding AI: guides/branding/branding-ai.md
- Configure custom domains: guides/branding/configure-custom-domains.md
- Customize email templates: guides/branding/customize-email-templates.md
- Customize SMS templates: guides/branding/customize-sms-templates.md
- Localization in Asgardeo: guides/branding/localization.md
- Extend with service extensions:
- Understanding service extensions: guides/service-extensions/understanding-service-extensions.md
- In-flow extensions:
- Custom authentication: guides/service-extensions/in-flow-extensions/custom-authentication.md
- Pre-flow extensions (Actions):
- Setting up an action: guides/service-extensions/pre-flow-extensions/setting-up-actions.md
- Pre issue access token action: guides/service-extensions/pre-flow-extensions/pre-issue-access-token-action.md
- Pre update password action: guides/service-extensions/pre-flow-extensions/pre-update-password-action.md
- Pre update profile action: guides/service-extensions/pre-flow-extensions/pre-update-profile-action.md
- Your Asgardeo:
- Your Asgardeo: guides/your-asgardeo/index.md
- Manage root organizations: guides/your-asgardeo/manage-root-organizations.md
- Manage environments: guides/your-asgardeo/manage-environments.md
- Self-service: guides/your-asgardeo/asgardeo-self-service.md
- Recover your password: guides/your-asgardeo/recover-password.md
- Delete your user account: guides/your-asgardeo/delete-your-user-account.md
- Subscribe to Asgardeo:
- Subscribe to Asgardeo: guides/your-asgardeo/subscribe-to-asgardeo/index.md
- via Billing Portal: guides/your-asgardeo/subscribe-to-asgardeo/subscribe-via-billing-portal.md
- via Azure Marketplace: guides/your-asgardeo/subscribe-to-asgardeo/subscribe-via-azure-marketplace.md
- Asgardeo logs:
- Asgardeo logs: guides/asgardeo-logs/index.md
- Diagnostic logs: guides/asgardeo-logs/diagnostic-logs.md
- Audit logs: guides/asgardeo-logs/audit-logs.md
- Remote log publish: guides/asgardeo-logs/remote-log-publish.md
- Monitoring:
- Monitoring: guides/monitoring/index.md
- PII in Asgardeo logs: guides/monitoring/pii-in-asgardeo-logs.md
- Asgardeo events: guides/monitoring/asgardeo-events.md
- Organization insights: guides/organization-insights.md
- Tutorials:
- Tutorials - Overview: tutorials/index.md
- Authenticate users into Android applications: tutorials/auth-users-into-android-apps.md
- Authenticate users into Flutter applications: tutorials/auth-users-into-flutter-apps.md
- Connect Asgardeo as an OIDC attribute provider (with Microsoft Entra Verified ID): tutorials/connect-asgardeo-with-ms-entra.md
- Connect Asgardeo as an OIDC attribute provider (with MATTR): tutorials/connect-asgardeo-with-mattr.md
- Secure Spring Boot API with Asgardeo: tutorials/secure-spring-boot-api.md
- Integrate Asgardeo with Smart on FHIR healthcare apps: tutorials/smart-on-fhir.md
- SDKs:
- Integrate Asgardeo into your application: integrations/index.md
- APIs:
- APIs - Overview: apis/index.md
- Management APIs:
- Action Management API: apis/action-management-rest-api.md
- API resource management API: apis/api-resource-management-rest-api.md
- Application management API: apis/application-management.md
- App-native authentication API: apis/app-native-authentication-api.md
- Attribute management API: apis/attribute-management.md
- Authenticators API: apis/authenticators.md
- Branding Preferences API: apis/branding-preference-rest-api.md
- Consent management API: apis/consent-management.md
- Email templates API: apis/email-template.md
- Event configuration API: apis/event-configuration.md
- Identity governance API: apis/identity-governance.md
- Identity provider API: apis/idp.md
- Identity verification provider API: apis/identity-verification-providers.md
- Idle account identification API: apis/idle-account-identification.md
- Notification sender API: apis/notification-sender-rest-api.md
- Notification templates management API: apis/notification-templates.md
- OAuth Dynamic Client Registration API: apis/dynamic-client-registration-rest-api.md
- Organization discovery API: apis/organization-discovery.md
- Organization discovery configuration management API: apis/organization-discovery-config-mgt-rest-api.md
- Organization management API: apis/organization-management.md
- Role management (SCIM 2.0) API: apis/roles.md
- Rule Metadata API: apis/rule-metadata-rest-api.md
- User management:
- SCIM 2.0 API:
- SCIM 2.0 API: apis/scim2/index.md
- SCIM 2.0 Users API: apis/scim2/scim2-users-rest-api.md
- SCIM 2.0 Groups API: apis/scim2/scim2-groups-rest-api.md
- SCIM 2.0 Bulk API: apis/scim2/scim2-bulk-rest-api.md
- SCIM 2.0 Resource types API: apis/scim2/scim2-resource-types-rest-api.md
- SCIM 2.0 Service provider configs API: apis/scim2/scim2-service-provider-configs-rest-api.md
- SCIM 2.0 Build user creation payload: apis/scim2/build-scim2-user-creation-payload.md
- User account associations API: apis/association-management-by-admin.md
- Account Recovery API: apis/user-account-recovery.md
- Offline user onboard management API: apis/offline-user-onboard.md
- Identity verification API: apis/admin-identity-verification.md
- User sessions:
- Session management API: apis/session.md
- Session extension API: apis/extend-sessions.md
- User sharing management API: apis/organization-user-share-rest-api.md
- User store management API: apis/user-store.md
- Validation API: apis/validation.md
- Organization APIs:
- Organization APIs: apis/organization-apis/index.md
- Get access for organization APIs: apis/organization-apis/authentication.md
- API resource management API: apis/organization-apis/api-resource-management-rest-api.md
- Application management API:
- Application management API (Shared Applications): apis/organization-apis/shared-application-management.md
- Application management API: apis/organization-apis/organization-application-mgt.md
- Authenticators API: apis/organization-apis/org-authenticators.md
- Branding API: apis/organization-apis/org-branding-management.md
- Claim management API: apis/organization-apis/org-claim-management.md
- Identity provider management API: apis/organization-apis/org-idp.md
- Identity recovery API: apis/organization-apis/org-account-recovery.md
- Idle account identification API: apis/organization-apis/org-idle-account-identification.md
- Invite parent organization's users API: apis/organization-apis/organization-user-invitation.md
- Notification sender API: apis/organization-apis/notification-sender-rest-api.md
- Offline user onboard management API: apis/organization-apis/organization-discovery.md
- Organization discovery API: apis/organization-apis/organization-discovery.md
- Organization management API: apis/organization-apis/org-management.md
- Role management API: apis/organization-apis/org-role-mgt.md
- User management:
- User management: apis/organization-apis/scim2/index.md
- SCIM 2.0 Users API: apis/organization-apis/scim2/scim2-org-user-mgt.md
- SCIM 2.0 Groups API: apis/organization-apis/scim2/scim2-org-group-mgt.md
- SCIM 2.0 Bulk API: apis/organization-apis/scim2/scim2-org-bulk.md
- User Account Association API: apis/organization-apis/org-association-rest-api.md
- User sharing management API: apis/organization-apis/organization-user-share.md
- User store management API: apis/organization-apis/org-user-store.md
- End User APIs:
- SCIM 2.0 Me API: apis/scim2-me.md
- Backup codes API: apis/register-mfa/backup-code.md
- Export user information API: apis/register-mfa/export-user-info.md
- Password recovery API: apis/register-mfa/password-recovery.md
- TOTP API: apis/register-mfa/totp.md
- Push Notification Device API: apis/push-notification-device-rest-api.md
- User account associations API: apis/association-management-by-user.md
- Export user information API: apis/export-user-info.md
- Identity Verification: apis/user-identity-verification.md
- References:
- References - Overview: references/index.md
- Operational policies: references/operational-policies.md
- Asgardeo outbound IP addresses: references/asgardeo-outbound-ip-addresses.md
- Asgardeo user roles: references/user-management/user-roles.md
- App configurations:
- App configurations: references/app-settings/index.md
- OIDC configurations: references/app-settings/oidc-settings-for-app.md
- SAML configurations: references/app-settings/saml-settings-for-app.md
- IdP configurations:
- IdP configurations: references/idp-settings/index.md
- OIDC configurations: references/idp-settings/oidc-settings-for-idp.md
- SAML configurations: references/idp-settings/saml-settings-for-idp.md
- Conditional authentication:
- Conditional auth - API: references/conditional-auth/api-reference.md
- Remote agent properties: references/remote-user-store/remote-user-store-properties.md
- Authorization policies for apps: references/authorization-policies-for-apps.md
- Email templates: references/email-templates.md
- SMS templates: references/sms-templates.md
- Service extensions:
- In-flow extensions:
- Custom authentication:
- API contract to implement: references/service-extensions/in-flow-extensions/custom-authentication/api-contract.md
- Pre-flow extensions (Actions):
- Pre issue access token action:
- API contract to implement: references/service-extensions/pre-flow-extensions/pre-issue-access-token-action/api-contract.md
- Sample success reponses: references/service-extensions/pre-flow-extensions/pre-issue-access-token-action/sample-success-responses.md
- Pre update password action:
- API contract to implement: references/service-extensions/pre-flow-extensions/pre-update-password-action/api-contract.md
- Pre update profile action:
- API contract to implement: references/service-extensions/pre-flow-extensions/pre-update-profile-action/api-contract.md
- Accessibility compliance: references/accessibility.md
- Data residency in Asgardeo: references/data-residency-in-asgardeo.md
- Production checklist:
- references/production-checklist/index.md
- Readiness check: references/production-checklist/readiness-check.md
- Security check: references/production-checklist/security-check.md
- Best practices: references/production-checklist/best-practices.md
- Asgardeo rate limits: references/rate-limits.md
- Tutorials:
- Build your own push authenticator app: references/tutorials/build-your-own-push-authenticator-app.md
- IAM concepts:
- OAuth2 grant types: references/grant-types.md
- OAuth2 Pushed Authorization Requests: references/pushed-authorization-requests.md
- Token binding:
- Token binding: references/token-binding/index.md
- Client-request: references/token-binding/client-request.md
- Financial-grade API: references/financial-grade-api.md
- App-native authentication: references/app-native-authentication.md
- Push Notification based authentication: references/push-notification-based-authentication.md
- Technology Guides:
- React:
- Introduction: complete-guides/react/introduction.md
- Prerequisite: complete-guides/react/prerequisite.md
- Configure an application: complete-guides/react/register-an-application.md
- Create a React app: complete-guides/react/create-a-react-app.md
- Configure Asgardeo SDK: complete-guides/react/install-asgardeo-sdk.md
- Add login and logout: complete-guides/react/add-login-and-logout.md
- Display user details: complete-guides/react/display-logged-in-user-details.md
- Securing Routes: complete-guides/react/securing-routes-within-the-app.md
- Accessing protected API : complete-guides/react/accessing-protected-api.md
- Manage tokens in React : complete-guides/react/manage-tokens-in-React-apps.md
- Next Steps: complete-guides/react/next-steps.md
- Next.js:
- B2B:
- Introduction: complete-guides/nextjs-b2b/introduction.md
- Prerequisites: complete-guides/nextjs-b2b/prerequisite.md
- Register an application: complete-guides/nextjs-b2b/register-an-application.md
- Give access to APIs and create roles: complete-guides/nextjs-b2b/give-access-to-apis-and-create-roles.md
- Create a Next.js app: complete-guides/nextjs-b2b/create-app.md
- Configure app for login: complete-guides/nextjs-b2b/configure-app-for-login.md
- Add user sign up: complete-guides/nextjs-b2b/add-user-sign-up.md
- Add login and logout: complete-guides/nextjs-b2b/add-login-and-logout.md
- Manage teams: complete-guides/nextjs-b2b/manage-teams.md
- Switch to a team: complete-guides/nextjs-b2b/switch-to-a-team.md
- Manage team members: complete-guides/nextjs-b2b/manage-team-members.md
- Redirect-Based:
- Introduction: complete-guides/nextjs/introduction.md
- Prerequisite: complete-guides/nextjs/prerequisite.md
- Register an application: complete-guides/nextjs/register-an-application.md
- Create a Next.js app: complete-guides/nextjs/create-app.md
- Configure Asgardeo provider: complete-guides/nextjs/install-asgardeo-sdk.md
- Add login and logout: complete-guides/nextjs/add-login-and-logout.md
- Display user details: complete-guides/nextjs/display-logged-in-user-details.md
- Securing Routes: complete-guides/nextjs/securing-routes-within-the-app.md
- Accessing protected API : complete-guides/nextjs/accessing-protected-api.md
- Manage tokens in Next.js : complete-guides/nextjs/manage-tokens-in-apps.md
- Next Steps: complete-guides/nextjs/next-steps.md
- App-Native:
- Introduction: complete-guides/app-native/introduction.md
- Prerequisites: complete-guides/app-native/prerequisites.md
- Register an application: complete-guides/app-native/register-an-application.md
- Create an app for app-native authentication: complete-guides/app-native/create-app.md
- Configure Provider: complete-guides/app-native/configure-provider.md
- Configure utility functions for app-native authentication: complete-guides/app-native/configure-utility-functions.md
- Add login and logout: complete-guides/app-native/add-login-and-logout.md
- Add MFA using app-native APIs: complete-guides/app-native/add-mfa.md
- Add Social Login using app-native APIs: complete-guides/app-native/add-social-login.md
- Manage tokens in app-native apps: complete-guides/app-native/manage-tokens-in-apps.md
- Next Steps: complete-guides/app-native/next-steps.md
- Node.js:
- Introduction: complete-guides/nodejs/introduction.md
- Prerequisite: complete-guides/nodejs/prerequisite.md
- Configure an application: complete-guides/nodejs/register-an-application.md
- Create a Node.js app: complete-guides/nodejs/create-a-nodejs-app.md
- Configure Passport Asgardeo: complete-guides/nodejs/install-passport-asgardeo.md
- Add login and logout: complete-guides/nodejs/add-login-and-logout.md
- Persist user sessions: complete-guides/nodejs/persist-user-sessions.md
- Display user details: complete-guides/nodejs/display-logged-in-user-details.md
- Securing Routes: complete-guides/nodejs/securing-routes-within-the-app.md
- Accessing protected API : complete-guides/nodejs/accessing-protected-api.md
- Next Steps: complete-guides/nodejs/next-steps.md
- Angular:
- Introduction: complete-guides/angular/introduction.md
- Prerequisite: complete-guides/angular/prerequisite.md
- Register an application: complete-guides/angular/register-an-application.md
- Create a Angular app: complete-guides/angular/create-app.md
- Configure Asgardeo provider: complete-guides/angular/install-asgardeo-sdk.md
- Add login and logout: complete-guides/angular/add-login-and-logout.md
- Display user details: complete-guides/angular/display-logged-in-user-details.md
- Securing Routes: complete-guides/angular/securing-routes-within-the-app.md
- Accessing protected API : complete-guides/angular/accessing-protected-api.md
- Manage tokens in Angular : complete-guides/angular/manage-tokens.md
- Next Steps: complete-guides/angular/next-steps.md
- Javascript:
- Introduction: complete-guides/javascript/introduction.md
- Prerequisite: complete-guides/javascript/prerequisite.md
- Register an application: complete-guides/javascript/register-an-application.md
- Create a JavaScript app: complete-guides/javascript/create-app.md
- Configure Asgardeo SDK: complete-guides/javascript/install-asgardeo-sdk.md
- Add login and logout: complete-guides/javascript/add-login-and-logout.md
- Display user details: complete-guides/javascript/display-logged-in-user-details.md
- Accessing protected API : complete-guides/javascript/accessing-protected-api.md
- Manage tokens in JavaScript : complete-guides/javascript/manage-tokens-in-apps.md
- Next Steps: complete-guides/javascript/next-steps.md
- .NET:
- Introduction: complete-guides/dotnet/introduction.md
- Prerequisites: complete-guides/dotnet/prerequisites.md
- Register an application: complete-guides/dotnet/register-an-application.md
- Create a .NET app: complete-guides/dotnet/create-a-dotnet-app.md
- Configure auth properties: complete-guides/dotnet/configure-authentication-properties.md
- Add login and logout: complete-guides/dotnet/add-login-and-logout.md
- Securing Routes: complete-guides/dotnet/securing-routes-within-the-app.md
- Display user details: complete-guides/dotnet/display-logged-in-user-details.md
- Accessing protected API: complete-guides/dotnet/protected-api.md
- Manage tokens in .NET: complete-guides/dotnet/manage-tokens-in-dotnet-apps.md
- Next Steps: complete-guides/dotnet/next-steps.md
- Best Practice Guides:
- Frontend Security:
- Introduction: complete-guides/fesecurity/introduction.md
- In-app vs IdP-based login: complete-guides/fesecurity/login-options.md
- Public clients: complete-guides/fesecurity/public-clients.md
- Insecure token handling : complete-guides/fesecurity/insecure-tokens.md
- Weak access control: complete-guides/fesecurity/weak-access-control.md
- Unauthorized access: complete-guides/fesecurity/unauthorized-privilege-gain.md
- Weak MFA : complete-guides/fesecurity/weak-mfa.md
- Partial user logouts: complete-guides/fesecurity/partial-user-logouts.md
- Product misconfiguration: complete-guides/fesecurity/misconfiguration.md
- Cross-Site Scripting (XSS): complete-guides/fesecurity/xss.md
- Cross-Site Request Forgery (CSRF): complete-guides/fesecurity/csrf.md
- Next Steps: complete-guides/fesecurity/next-steps.md
not_in_nav: |
/page-not-found.md
/get-started/explore-asgardeo.md
/get-started/start-integrating-apps.md
/get-started/try-samples/index.md
/get-started/try-your-own-app/index.md
/get-started/try-your-own-app/angular.md