Jump To Close Expand all Collapse all Table of contents Server Developer Guide Making open source more inclusive 1. Preface 2. Admin REST API Expand section "2. Admin REST API" Collapse section "2. Admin REST API" 2.1. Examples of using CURL Expand section "2.1. Examples of using CURL" Collapse section "2.1. Examples of using CURL" 2.1.1. Authenticating with a username and password 2.1.2. Authenticating with a service account 2.2. Additional resources 3. Themes Expand section "3. Themes" Collapse section "3. Themes" 3.1. Theme types 3.2. Configuring a theme 3.3. Default themes 3.4. Creating a theme Expand section "3.4. Creating a theme" Collapse section "3.4. Creating a theme" 3.4.1. Theme properties 3.4.2. Add a stylesheet to a theme 3.4.3. Adding a script to a theme 3.4.4. Adding an image to a theme 3.4.5. Messages 3.4.6. Adding a language to a realm 3.4.7. Adding custom Identity Providers icons 3.4.8. Creating a custom HTML template 3.4.9. Emails 3.5. Deploying themes 3.6. Theme selector 3.7. Theme resources 3.8. Locale selector 3.9. Additional resources 4. Custom user attributes Expand section "4. Custom user attributes" Collapse section "4. Custom user attributes" 4.1. Registration page 4.2. Account Management Console 4.3. Additional resources 5. Identity Brokering APIs Expand section "5. Identity Brokering APIs" Collapse section "5. Identity Brokering APIs" 5.1. Retrieving external IDP tokens 5.2. Client initiated account linking Expand section "5.2. Client initiated account linking" Collapse section "5.2. Client initiated account linking" 5.2.1. Refreshing external tokens 6. Service Provider Interfaces (SPI) Expand section "6. Service Provider Interfaces (SPI)" Collapse section "6. Service Provider Interfaces (SPI)" 6.1. Implementing an SPI Expand section "6.1. Implementing an SPI" Collapse section "6.1. Implementing an SPI" 6.1.1. Show info from your SPI implementation in the Admin Console 6.2. Use available providers 6.3. Registering provider implementations Expand section "6.3. Registering provider implementations" Collapse section "6.3. Registering provider implementations" 6.3.1. Using the Red Hat Single Sign-On deployer 6.3.2. Register a provider using Modules 6.3.3. Disabling a provider 6.4. Leveraging Jakarta EE 6.5. JavaScript providers Expand section "6.5. JavaScript providers" Collapse section "6.5. JavaScript providers" 6.5.1. Authenticator 6.5.2. Create a JAR with the scripts to deploy 6.5.3. Deploy the script JAR Expand section "6.5.3. Deploy the script JAR" Collapse section "6.5.3. Deploy the script JAR" 6.5.3.1. Deploy the script engine on Java 15 and later 6.6. Available SPIs 7. User Storage SPI Expand section "7. User Storage SPI" Collapse section "7. User Storage SPI" 7.1. Provider interfaces 7.2. Provider capability interfaces 7.3. Model interfaces Expand section "7.3. Model interfaces" Collapse section "7.3. Model interfaces" 7.3.1. Storage Ids 7.4. Packaging and deployment Expand section "7.4. Packaging and deployment" Collapse section "7.4. Packaging and deployment" 7.4.1. Provider class Expand section "7.4.1. Provider class" Collapse section "7.4.1. Provider class" 7.4.1.1. UserLookupProvider implementation 7.4.1.2. CredentialInputValidator implementation 7.4.1.3. CredentialInputUpdater implementation 7.4.2. Provider factory implementation Expand section "7.4.2. Provider factory implementation" Collapse section "7.4.2. Provider factory implementation" 7.4.2.1. Initialization 7.4.2.2. Create method 7.4.3. Packaging and deployment 7.4.4. Enabling the provider in the Admin Console 7.5. Configuration techniques Expand section "7.5. Configuration techniques" Collapse section "7.5. Configuration techniques" 7.5.1. Configuration example 7.5.2. Configuring the provider in the Admin Console 7.6. Add/Remove user and query capability interfaces Expand section "7.6. Add/Remove user and query capability interfaces" Collapse section "7.6. Add/Remove user and query capability interfaces" 7.6.1. Implementing UserRegistrationProvider 7.6.2. Implementing UserQueryProvider 7.7. Augmenting external storage Expand section "7.7. Augmenting external storage" Collapse section "7.7. Augmenting external storage" 7.7.1. Augmentation example 7.8. Import implementation strategy Expand section "7.8. Import implementation strategy" Collapse section "7.8. Import implementation strategy" 7.8.1. ImportedUserValidation interface 7.8.2. ImportSynchronization interface 7.9. User caches Expand section "7.9. User caches" Collapse section "7.9. User caches" 7.9.1. Managing the user cache 7.9.2. OnUserCache callback interface 7.9.3. Cache policies 7.10. Leveraging Jakarta EE 7.11. REST management API 7.12. Migrating from an earlier user federation SPI Expand section "7.12. Migrating from an earlier user federation SPI" Collapse section "7.12. Migrating from an earlier user federation SPI" 7.12.1. Import versus non-import 7.12.2. UserFederationProvider versus UserStorageProvider 7.12.3. UserFederationProviderFactory versus UserStorageProviderFactory 7.12.4. Upgrading to a new model 7.13. Stream-based interfaces 8. Vault SPI Expand section "8. Vault SPI" Collapse section "8. Vault SPI" 8.1. Vault provider 8.2. Consuming values from vault Legal Notice Settings Close Language: 日本語 简体中文 한국어 English Language: 日本語 简体中文 한국어 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: 日本語 简体中文 한국어 English Language: 日本語 简体中文 한국어 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Server Developer Guide Red Hat Single Sign-On 7.6For Use with Red Hat Single Sign-On 7.6Red Hat Customer Content ServicesLegal NoticeAbstract This guides consist of information for developers to customize Red Hat Single Sign-On 7.6 Next