2023-08-27 10:55:55 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								---
							 
						 
					
						
							
								
									
										
										
										
											2025-06-26 16:13:03 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								title: SSO Auth Schema | OpenMetadata Single Sign-On
							 
						 
					
						
							
								
									
										
										
										
											2025-07-22 11:51:42 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								description: Authenticate with a single sign-on provider using this SSO auth schema.
							 
						 
					
						
							
								
									
										
										
										
											2023-08-27 10:55:55 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								slug: /main-concepts/metadata-standard/schemas/auth/ssoauth
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								---
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								# SSOAuthMechanism
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								*User/Bot SSOAuthN.*
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								## Properties
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2025-01-15 17:46:55 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								-  **`ssoServiceType` ** *(string)* : Type of database service such as Amundsen, Atlas... Must be one of: `["google", "okta", "auth0", "custom-oidc", "azure"]` . 
						 
					
						
							
								
									
										
										
										
											2023-08-27 10:55:55 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								-  **`authConfig` **: The authentication configuration used by the SSO. 
						 
					
						
							
								
									
										
										
										
											2025-01-15 17:46:55 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								  -  **One of**
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    -  : Google SSO Configuration. Refer to *[../security/client/googleSSOClientConfig.json](#/security/client/googleSSOClientConfig.json)* .
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    -  : Okta SSO Configuration. Refer to *[../security/client/oktaSSOClientConfig.json](#/security/client/oktaSSOClientConfig.json)* .
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    -  : Auth0 SSO Configuration. Refer to *[../security/client/auth0SSOClientConfig.json](#/security/client/auth0SSOClientConfig.json)* .
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    -  : Azure SSO Configuration. Refer to *[../security/client/azureSSOClientConfig.json](#/security/client/azureSSOClientConfig.json)* .
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    -  : Custom OIDC SSO Configuration. Refer to *[../security/client/customOidcSSOClientConfig.json](#/security/client/customOidcSSOClientConfig.json)* .
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    -  : SAML SSO Configuration. Refer to *[../security/client/samlSSOClientConfig.json](#/security/client/samlSSOClientConfig.json)* .
							 
						 
					
						
							
								
									
										
										
										
											2023-08-27 10:55:55 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2025-01-15 17:46:55 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								Documentation file automatically generated at 2025-01-15 09:05:41.923720+00:00.