| 
									
										
										
										
											2024-07-04 12:37:31 +05:30
										 |  |  | --- | 
					
						
							|  |  |  | title: SAML SSO for Bare Metal | 
					
						
							|  |  |  | slug: /deployment/security/saml/bare-metal | 
					
						
							| 
									
										
										
										
											2024-09-05 10:30:31 +02:00
										 |  |  | collate: false | 
					
						
							| 
									
										
										
										
											2024-07-04 12:37:31 +05:30
										 |  |  | --- | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # SAML SSO for Bare Metal
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ## Update conf/openmetadata.yaml
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Follow this sections in this guide to set up Saml for almost any IDP. In Openmetadata the SAML configuration | 
					
						
							|  |  |  | are divided into the following three sections:- | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | - Identity Provide (IDP) Configuration | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```yaml | 
					
						
							|  |  |  |     idp: | 
					
						
							|  |  |  |       entityId: ${SAML_IDP_ENTITY_ID:-"https://mocksaml.com/api/saml/sso"} | 
					
						
							|  |  |  |       ssoLoginUrl: ${SAML_IDP_SSO_LOGIN_URL:-"https://saml.example.com/entityid"} | 
					
						
							|  |  |  |       idpX509Certificate: ${SAML_IDP_CERTIFICATE:-""} | 
					
						
							|  |  |  |       authorityUrl: ${SAML_AUTHORITY_URL:-"http://localhost:8585/api/v1/saml/login"} | 
					
						
							|  |  |  |       nameId: ${SAML_IDP_NAME_ID:-"urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"} | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | - Service Provider (SP) Configuration (SP is Openmetadata) | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```yaml | 
					
						
							|  |  |  |   sp: | 
					
						
							| 
									
										
										
										
											2024-09-12 20:46:44 +05:30
										 |  |  |     entityId: ${SAML_SP_ENTITY_ID:-"http://localhost:8585/api/v1/saml/acs"} | 
					
						
							| 
									
										
										
										
											2024-07-04 12:37:31 +05:30
										 |  |  |     acs: ${SAML_SP_ACS:-"http://localhost:8585/api/v1/saml/acs"} | 
					
						
							|  |  |  |     spX509Certificate: ${SAML_SP_CERTIFICATE:-""} | 
					
						
							|  |  |  |     callback: ${SAML_SP_CALLBACK:-"http://localhost:8585/saml/callback"} | 
					
						
							|  |  |  |    | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | - Security Config | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```yaml | 
					
						
							|  |  |  |   security: | 
					
						
							|  |  |  |     strictMode: ${SAML_STRICT_MODE:-false} | 
					
						
							|  |  |  |     tokenValidity: ${SAML_SP_TOKEN_VALIDITY:-"3600"} | 
					
						
							|  |  |  |     sendEncryptedNameId: ${SAML_SEND_ENCRYPTED_NAME_ID:-false} | 
					
						
							|  |  |  |     sendSignedAuthRequest: ${SAML_SEND_SIGNED_AUTH_REQUEST:-false} | 
					
						
							|  |  |  |     signSpMetadata: ${SAML_SIGNED_SP_METADATA:-false} | 
					
						
							|  |  |  |     wantMessagesSigned: ${SAML_WANT_MESSAGE_SIGNED:-false} | 
					
						
							|  |  |  |     wantAssertionsSigned: ${SAML_WANT_ASSERTION_SIGNED:-false} | 
					
						
							|  |  |  |     wantAssertionEncrypted: ${SAML_WANT_ASSERTION_ENCRYPTED:-false} | 
					
						
							|  |  |  |     wantNameIdEncrypted: ${SAML_WANT_NAME_ID_ENCRYPTED:-false} | 
					
						
							|  |  |  |     keyStoreFilePath: ${SAML_KEYSTORE_FILE_PATH:-""} | 
					
						
							|  |  |  |     keyStoreAlias: ${SAML_KEYSTORE_ALIAS:-""} | 
					
						
							|  |  |  |     keyStorePassword: ${SAML_KEYSTORE_PASSWORD:-""} | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-12-13 15:33:35 +05:30
										 |  |  | {% partial file="/v1.7/deployment/configure-ingestion.md" /%} |