2023-04-17 16:45:47 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								---
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								title: Enable Security
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								slug: /deployment/security
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								---
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								# Enable Security
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								This section provides detailed instructions to secure the REST endpoints of the OpenMetadata Server.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								OpenMetadata has support for Google SSO, Okta SSO, custom OIDC, Auth0, Azure SSO, Amazon Cognito, and OneLogin as identity providers. Please see the next sections about how to configure them.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								Enabling Security is only required for your **Production**  installation. If you are testing OpenMetadata, it will be easier 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								and faster to set up without security. To get up and running quickly with OpenMetadata (without security), 
							 
						 
					
						
							
								
									
										
										
										
											2023-12-20 18:20:33 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								please follow the [Quickstart ](/quick-start ) guide.
							 
						 
					
						
							
								
									
										
										
										
											2023-04-17 16:45:47 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2024-07-27 20:45:18 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								{% note %}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								OpenMetadata currently does not support the simultaneous use of multiple authentication mechanisms, such as combining SSO and Basic Authentication.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{% /note %}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2023-04-21 21:59:41 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								{%inlineCalloutContainer%}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  {%inlineCallout
							 
						 
					
						
							
								
									
										
										
										
											2023-04-17 16:45:47 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								    color="violet-70"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    bold="Auth0 SSO"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    icon="add_moderator"
							 
						 
					
						
							
								
									
										
										
										
											2023-04-21 21:59:41 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								    href="/deployment/security/auth0"%}
							 
						 
					
						
							
								
									
										
										
										
											2023-04-17 16:45:47 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								    Configure Auth0 SSO to access the UI and APIs
							 
						 
					
						
							
								
									
										
										
										
											2023-04-21 21:59:41 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								  {%/inlineCallout%}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  {%inlineCallout
							 
						 
					
						
							
								
									
										
										
										
											2023-04-17 16:45:47 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								    color="violet-70"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    bold="Azure SSO"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    icon="add_moderator"
							 
						 
					
						
							
								
									
										
										
										
											2023-04-21 21:59:41 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								    href="/deployment/security/azure"%}
							 
						 
					
						
							
								
									
										
										
										
											2023-04-17 16:45:47 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								    Configure Azure SSO to access the UI and APIs
							 
						 
					
						
							
								
									
										
										
										
											2023-04-21 21:59:41 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								  {%/inlineCallout%}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  {%inlineCallout
							 
						 
					
						
							
								
									
										
										
										
											2023-04-17 16:45:47 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								    color="violet-70"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    bold="Custom OIDC SSO"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    icon="add_moderator"
							 
						 
					
						
							
								
									
										
										
										
											2023-04-21 21:59:41 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								    href="/deployment/security/custom-oidc"%}
							 
						 
					
						
							
								
									
										
										
										
											2023-04-17 16:45:47 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								    Configure a Custom OIDC SSO to access the UI and APIs
							 
						 
					
						
							
								
									
										
										
										
											2023-04-21 21:59:41 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								  {%/inlineCallout%}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  {%inlineCallout
							 
						 
					
						
							
								
									
										
										
										
											2023-04-17 16:45:47 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								    color="violet-70"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    bold="Google SSO"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    icon="add_moderator"
							 
						 
					
						
							
								
									
										
										
										
											2023-04-21 21:59:41 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								    href="/deployment/security/google"%}
							 
						 
					
						
							
								
									
										
										
										
											2023-04-17 16:45:47 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								    Configure Google SSO to access the UI and APIs
							 
						 
					
						
							
								
									
										
										
										
											2023-04-21 21:59:41 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								  {%/inlineCallout%}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  {%inlineCallout
							 
						 
					
						
							
								
									
										
										
										
											2023-04-17 16:45:47 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								    color="violet-70"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    bold="Okta SSO"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    icon="add_moderator"
							 
						 
					
						
							
								
									
										
										
										
											2023-04-21 21:59:41 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								    href="/deployment/security/okta"%}
							 
						 
					
						
							
								
									
										
										
										
											2023-04-17 16:45:47 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								    Configure Okta SSO to access the UI and APIs
							 
						 
					
						
							
								
									
										
										
										
											2023-04-21 21:59:41 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								  {%/inlineCallout%}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  {%inlineCallout
							 
						 
					
						
							
								
									
										
										
										
											2023-04-17 16:45:47 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								    color="violet-70"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    bold="Amazon Cognito SSO"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    icon="add_moderator"
							 
						 
					
						
							
								
									
										
										
										
											2023-04-21 21:59:41 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								    href="/deployment/security/amazon-cognito"%}
							 
						 
					
						
							
								
									
										
										
										
											2023-04-17 16:45:47 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								    Configure Amazon Cognito SSO to access the UI and APIs
							 
						 
					
						
							
								
									
										
										
										
											2023-04-21 21:59:41 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								  {%/inlineCallout%}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  {%inlineCallout
							 
						 
					
						
							
								
									
										
										
										
											2023-04-17 16:45:47 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								    color="violet-70"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    bold="OneLogin SSO"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    icon="add_moderator"
							 
						 
					
						
							
								
									
										
										
										
											2023-04-21 21:59:41 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								    href="/deployment/security/one-login"%}
							 
						 
					
						
							
								
									
										
										
										
											2023-04-17 16:45:47 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								    Configure OneLogin SSO to access the UI and APIs
							 
						 
					
						
							
								
									
										
										
										
											2023-04-21 21:59:41 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								  {%/inlineCallout%}
							 
						 
					
						
							
								
									
										
										
										
											2023-05-04 07:04:30 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								  {%inlineCallout
							 
						 
					
						
							
								
									
										
										
										
											2023-04-17 16:45:47 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								    color="violet-70"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    bold="Keycloak SSO"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    icon="add_moderator"
							 
						 
					
						
							
								
									
										
										
										
											2023-04-21 21:59:41 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								    href="/deployment/security/keycloak"%}
							 
						 
					
						
							
								
									
										
										
										
											2023-04-17 16:45:47 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								    Configure Keycloak SSO to access the UI and APIs
							 
						 
					
						
							
								
									
										
										
										
											2023-04-21 21:59:41 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								  {%/inlineCallout%}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{%/inlineCalloutContainer%}