Skip to main content
All CollectionsAbout FamlyFamly's API
Setting up Azure Active Directory (OIDC)
Setting up Azure Active Directory (OIDC)
Josie avatar
Written by Josie
Updated this week

Famly supports OpenID Connect (OIDC) for user authentication, allowing integration with any OIDC provider. This guide focuses on setting up Azure Active Directory with Famly.


Step 1: Register the App in Azure

Create an app registration

  • In Azure Active Directory, go to App registrations

  • Click New registration

  • Enter a name (e.g. “Famly”) and click Register

Configure branding & authentication

  • Open the newly created App registration

  • Go to the Branding section and enter the home page URL:

    • https://app.famly.co

💡 If you're using white labelling, add the white label domain as the home page URL instead

Set up authentication

  • Navigate to the Authentication section

  • Click Add a platform → Web

  • Enter https://app.famly.co as the Redirect URI

  • Tick the ID tokens box

  • Click Configure

Add an additional redirect URI

  • Click Add URI

  • Enter https://app.famly.co/app-trap

💡 If you are using white labeling, add the white label domain in addition to the two Famly URIs

Generate a client secret

  • Go to Certificates & secrets

  • Click New client secret

  • Copy and save the Value immediately, as it won’t be accessible later

  • Set a reminder to generate a new secret before the current one expires


Step 2: Collect Required Information for Famly

To enable the integration, collect the following details:

  • Client ID: Found in the Overview under "Application (client) ID"

  • Client Secret: Copied when generated

  • Endpoint/Base URI: Found under Endpoints → "OpenID Connect metadata document"

The endpoint will look something like this:
https://login.microsoftonline.com/c630ad49-3d5d-4692-9a48-74a5372c1b0b

Entering the details in Famly

  • Go to: https://app.famly.co/#/account/organization/<your-organization-id>/openid/createProvider

  • Enter the Client ID, Client Secret, and Base URI

  • Choose a Title (this appears on the login screen)

  • Save the settings

💡 Famly support can provide the correct organisation ID if needed

Updating the client secret

To update an expired client secret:

  • Go to the same settings page in Famly

  • Enter the existing Client ID and Base URI

  • Add the new Client Secret

  • Save the changes


Troubleshooting

  • Are you getting a “Not authorised” error when saving settings?

    • The required “Manage single sign-on settings” permission may be missing

Did this answer your question?