> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/dokumentation/settings/integrations-and-sso.md). # Integrations and single sign-on Integrations: HR sync, API keys for interfaces and automation, Microsoft Entra ID enrollment and single sign-on. **Path:** Settings → **"Integrations"** The page has the tabs **"HR sync"**, **"API key"** and, if enabled, **"Microsoft Entra ID Enrollment"**. ## HR sync Described under [HR sync](/dokumentation/organization/hr-sync.md). ## API key With an API key you connect other systems or the [automation module](/dokumentation/automation.md) or the [equipme connector](/dokumentation/automation/connectors/equipme.md) to equipme. 1. Select the **"Expiration date"**: "Unlimited" (default), "1 month", "6 months" or "1 year". 2. Click **"Add"**. 3. **Copy the key immediately and store it securely.** It is only shown when it is created. Here you also find the **"Tenant ID"**, which is required for API communication. The list shows "API key" (masked), "Creator" and "Expiration date"; expired keys are marked. **Deleting** a key invalidates it immediately; integrations that use it lose access. {% hint style="warning" %} **An API key has full administrator rights** for the entire company. Treat it like a password, do not share it, and create a separate key for each integration. If a key is lost or compromised, delete it and create a new one. {% endhint %} ## Microsoft Entra ID Enrollment With Entra ID enrollment, employees of your own Microsoft tenant can **register automatically**: when a user of this tenant signs in, they are created as an employee. The feature is enabled by equipme. If it is not enabled, a corresponding notice appears; in that case, create a support ticket. | Section | Setting | | --------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **"Microsoft Entra ID user registration"** | **"Active"**: turn on automatic registration | | **"Microsoft Entra ID tenant configuration"** | **"Connect Microsoft Entra ID"**: sign in with a Microsoft administrator account and give consent; the "Client ID" is saved. Disconnect via "Remove Microsoft Entra ID connection". | | **"Automatic location assignment"** | **"Location"** that new users are assigned to (required) | | **"Options"** | **"Enable self-service"** for new users | | **"Synchronize profile data"** | After **"Grant administrator approval"**: take over the profile, optionally "Synchronize department" and "Synchronize location", at every sign-in | | **"Synchronize superiors"** | After administrator consent, take over the supervisor; optionally "Automatically create superiors if they do not already exist" | | **"Automatic tag assignment"** | Automatically assign self-service tags to members of specific Entra groups (group ID) | To synchronize profile data, equipme requests only the read permissions shown in each case from Microsoft. ## Single sign-on (SSO) With single sign-on, employees sign in with their company account, by default with Microsoft. Other providers based on OpenID Connect are possible on request via support. ### Setup with Microsoft Entra ID 1. A Microsoft administrator with sufficient rights signs in once with **"Sign in with Microsoft"** and grants **administrator consent**. 2. equipme then appears as an **Enterprise Application** in your own Entra tenant. 3. Optionally, you can restrict access there: in the properties, enable "Assignment required" and add the authorized people under "Users and groups". **What equipme receives at sign-in:** only basic identity data (sign-in name, email, name), but no access to groups, roles or other data in the tenant. The consent remains in place until you revoke it in Microsoft. ### Good to know * SSO is only used for **signing in**. You continue to maintain roles, locations and groups in equipme or via HR sync. * The **user name** in equipme must match the Microsoft sign-in (UPN). * **Create employees beforehand** (or use Entra ID enrollment). If someone signs in whose account is unknown in equipme, they end up in the registration. * Signing in with user name and password remains possible. When inviting, you select the **"Preferred login method"** for each employee. * With the **direct SSO link** `https:///sso?provider=microsoft` you skip the sign-in screen. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://hub.equipme.io/dokumentation/settings/integrations-and-sso.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.