|
| 1 | +# Microsoft Entra ID |
| 2 | + |
| 3 | +Cube Cloud supports authenticating users through [Microsoft Entra |
| 4 | +ID][ext-ms-entra-id] (formerly Azure Active Directory), which is |
| 5 | +useful when you want your users to access Cube Cloud using single sign-on. |
| 6 | + |
| 7 | +This guide will walk you through the steps of configuring SAML authentication |
| 8 | +in Cube Cloud with Entra ID. You **must** have sufficient permissions in your |
| 9 | +Azure account to create a new Enterprise Application and configure SAML |
| 10 | +integration. |
| 11 | + |
| 12 | +<SuccessBox> |
| 13 | + |
| 14 | +Single sign-on with Microsoft Entra ID is available in Cube Cloud on |
| 15 | +[Enterprise](https://cube.dev/pricing) tier. |
| 16 | +[Contact us](https://cube.dev/contact) for details. |
| 17 | + |
| 18 | +</SuccessBox> |
| 19 | + |
| 20 | +## Enable SAML in Cube Cloud |
| 21 | + |
| 22 | +First, we'll enable SAML 2.0 authentication in Cube Cloud: |
| 23 | + |
| 24 | +1. Click your username from the top-right corner, then click <Btn>Team & |
| 25 | + Security</Btn>. |
| 26 | + |
| 27 | +2. On the <Btn>Authentication & SSO</Btn> tab, ensure <Btn>SAML 2.0</Btn> is |
| 28 | + enabled: |
| 29 | + |
| 30 | +<Screenshot |
| 31 | + alt="Cube Cloud Team Authentication and SSO tab" |
| 32 | + src="https://ucarecdn.com/f5ff1413-f37c-4476-afcc-0ff29e87e80a/" |
| 33 | +/> |
| 34 | + |
| 35 | +Take note of the <Btn>Single Sign On URL</Btn> and <Btn>Service Provider Entity |
| 36 | +ID</Btn> values here, as we will need them in the next step when we configure |
| 37 | +the SAML integration in Entra ID. |
| 38 | + |
| 39 | +## Create a new Enterprise Application in Azure |
| 40 | + |
| 41 | +Go to [Enterprise Applications](https://portal.azure.com/#view/Microsoft_AAD_IAM/StartboardApplicationsMenuBlade/~/AppAppsPreview) |
| 42 | +in your Azure account and click <Btn>New application</Btn>. |
| 43 | + |
| 44 | +<Screenshot src="https://ucarecdn.com/57ed6718-5c4e-46e1-831b-f372153696bd/"/> |
| 45 | + |
| 46 | +Select <Btn>Create your own application</Btn> at the top: |
| 47 | + |
| 48 | +<Screenshot src="https://ucarecdn.com/06f40439-995a-4156-81b1-7d340b87e945/"/> |
| 49 | + |
| 50 | +Give it a name and choose a *non-gallery application*: |
| 51 | + |
| 52 | +<Screenshot src="https://ucarecdn.com/36f6c0c1-4d4d-460a-a640-0aba178490d8/"/> |
| 53 | + |
| 54 | +Go to the <Btn>Single sign-on</Btn> section and select <Btn>SAML</Btn>: |
| 55 | + |
| 56 | +<Screenshot src="https://ucarecdn.com/81d9df03-a08f-452f-b55a-574b2d4db875/"/> |
| 57 | + |
| 58 | +Fill-in <Btn>Entity ID</Btn> and <Btn>Reply URL</Btn> from the [SAML |
| 59 | +configuration page](#enable-saml-in-cube-cloud) in Cube Cloud: |
| 60 | + |
| 61 | +<Screenshot src="https://ucarecdn.com/266696dc-09ef-403f-a3e5-5ba913941875/"/> |
| 62 | + |
| 63 | +Go to <Btn>Attributes & Claims → Edit → Advanced settings</Btn>: |
| 64 | + |
| 65 | +<Screenshot src="https://ucarecdn.com/752b5a3a-29eb-4863-8ce8-8cc8a7caa0c2/"/> |
| 66 | + |
| 67 | +Set the audience claim override to the value given you by the [SAML |
| 68 | +configuration page](#enable-saml-in-cube-cloud) in Cube Cloud: |
| 69 | + |
| 70 | +<Screenshot src="https://ucarecdn.com/a2650781-be3a-48a1-8e79-7e1e7a8607a5/"/> |
| 71 | + |
| 72 | +Go to <Btn>SAML Certificates → Edit</Btn> and select <Btn>Sign SAML response |
| 73 | +and assertion</Btn> for <Btn>Signing Option</Btn>: |
| 74 | + |
| 75 | +<Screenshot src="https://ucarecdn.com/c81e7900-d448-4e8c-85be-99854ec1b582/"/> |
| 76 | + |
| 77 | +Download <Btn>Federation Metadata XML</Btn>: |
| 78 | + |
| 79 | +<Screenshot src="https://ucarecdn.com/d98970cf-a6ea-4206-be23-078e460515ff/"/> |
| 80 | + |
| 81 | +## Complete configuration in Cube Cloud |
| 82 | + |
| 83 | +Upload it to Cube Cloud through <Btn>Advanced Settings</Btn> tab on the [SAML |
| 84 | +configuration page](#enable-saml-in-cube-cloud) in Cube Cloud: |
| 85 | + |
| 86 | +<Screenshot src="https://ucarecdn.com/3ae24797-bd0a-477c-9b9a-420602694616/"/> |
| 87 | + |
| 88 | +Select <Btn>SHA-256</Btn> as <Btn>Signature Algorithm</Btn>: |
| 89 | + |
| 90 | +<Screenshot src="https://ucarecdn.com/e0c8c608-9b1e-4b84-a51e-0613362c6aec/"/> |
| 91 | + |
| 92 | +Enter “[http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name](http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name)” |
| 93 | +or a preferred attribute to lookup email address in <Btn>Attributes → Email</Btn>: |
| 94 | + |
| 95 | +<Screenshot src="https://ucarecdn.com/4fe50791-8203-49d4-9056-e5de6dc5643c/"/> |
| 96 | + |
| 97 | +Save settings on the Cube Cloud side. |
| 98 | + |
| 99 | +## Final steps |
| 100 | + |
| 101 | +Make sure the new Azure application is assigned to some users or a group: |
| 102 | + |
| 103 | +<Screenshot src="https://ucarecdn.com/05b7cd95-5afd-4b00-8946-5ab0c955365b/"/> |
| 104 | + |
| 105 | +At the bottom of the <Btn>Single sign-on</Btn> section, select <Btn>Test</Btn> |
| 106 | +and verify that the SAML integration now works for your Cube Cloud account: |
| 107 | + |
| 108 | +<Screenshot src="https://ucarecdn.com/f30f9416-64da-4cf6-ae45-e24ce678e001/"/> |
| 109 | + |
| 110 | +Done! 🎉 |
| 111 | + |
| 112 | +[ext-ms-entra-id]: https://www.microsoft.com/en-us/security/business/identity-access/microsoft-entra-id |
0 commit comments