# OrbitID

> OrbitID is a hosted identity bridge for B2B software: enterprise SSO (SAML 2.0 and OIDC) with any identity provider, and SCIM 2.0 Directory Sync, behind one OAuth 2.0 integration.

Every docs page is also served as Markdown: add `.md` to its URL.
Guides that change code start with a prompt for coding agents under "Prompt for your coding agent".
The REST API lives at `https://app.orbitid.com/api/v1` and takes an environment API key as a bearer token.

## Start here
- [OrbitID documentation](https://orbitid.com/docs.md): Learn how to add enterprise SSO (SAML and OIDC) and SCIM Directory Sync to your app with OrbitID.
- [Quickstart](https://orbitid.com/docs/quickstart.md): Create a team, get a sandbox API key, connect an identity provider and complete a login through OrbitID.
- [Environments](https://orbitid.com/docs/environments.md): Production and Sandbox environments in OrbitID: what they are for, what they cost and where to find the product id.
- [API keys](https://orbitid.com/docs/api-keys.md): Create, use and revoke OrbitID API keys. Keys are scoped to an environment and sent as a bearer token.
- [Billing](https://orbitid.com/docs/billing.md): How OrbitID bills production connections: $25 per SSO or Directory Sync connection per month, through Paddle, prorated, cancel any time.

## Single sign-on
- [SSO setup guides](https://orbitid.com/docs/sso.md): Step-by-step guides for connecting Okta, Microsoft Entra ID, Google Workspace, Auth0, OneLogin, JumpCloud, PingOne, Rippling, AD FS and any SAML or OIDC identity provider to OrbitID.
- [Admin Portal](https://orbitid.com/docs/admin-portal.md): Send your customers a self-serve Admin Portal link so their IT admin can connect their identity provider, with optional domain verification.
- [Okta](https://orbitid.com/docs/sso/okta.md): Set up a SAML 2.0 application in Okta and connect it to OrbitID.
- [Microsoft Entra ID](https://orbitid.com/docs/sso/azure.md): Set up a SAML 2.0 enterprise application in Microsoft Entra ID (Azure AD) and connect it to OrbitID.
- [Google Workspace](https://orbitid.com/docs/sso/google.md): Set up a custom SAML application in Google Workspace and connect it to OrbitID.
- [Auth0](https://orbitid.com/docs/sso/auth0.md): Enable the SAML2 Web App addon on an Auth0 application and connect it to OrbitID.
- [OneLogin](https://orbitid.com/docs/sso/onelogin.md): Set up a SAML Custom Connector (Advanced) application in OneLogin and connect it to OrbitID.
- [JumpCloud](https://orbitid.com/docs/sso/jumpcloud.md): Set up a custom SAML application in JumpCloud and connect it to OrbitID.
- [PingOne](https://orbitid.com/docs/sso/pingone.md): Set up a SAML application in PingOne and connect it to OrbitID.
- [Rippling](https://orbitid.com/docs/sso/rippling.md): Create a custom SAML app in Rippling and connect it to OrbitID.
- [Microsoft AD FS](https://orbitid.com/docs/sso/microsoft-adfs.md): Create a claims-aware relying party trust in Microsoft AD FS and connect it to OrbitID.
- [Generic SAML](https://orbitid.com/docs/sso/generic-saml.md): Connect any SAML 2.0 identity provider to OrbitID: service provider values, signing settings and attribute mapping.
- [Generic OIDC](https://orbitid.com/docs/sso/generic-oidc.md): Connect any OpenID Connect identity provider to OrbitID: callback URL, client ID and client secret.

## Directory Sync
- [Directory Sync](https://orbitid.com/docs/directory-sync.md): Sync users and groups from your customers’ directories into your app with SCIM 2.0 or Google Workspace, and receive webhook events.
- [Webhooks](https://orbitid.com/docs/webhooks.md): Receive Directory Sync user and group events on your endpoint and verify the OrbitID-Signature header.
- [Okta Directory Sync](https://orbitid.com/docs/directory-sync/okta.md): Provision users and groups from Okta into OrbitID with SCIM 2.0.
- [Microsoft Entra ID Directory Sync](https://orbitid.com/docs/directory-sync/azure.md): Provision users and groups from Microsoft Entra ID (Azure AD) into OrbitID with SCIM 2.0.
- [Google Workspace Directory Sync](https://orbitid.com/docs/directory-sync/google.md): Sync users and groups from Google Workspace into OrbitID by connecting a Google admin account with read-only access.

## Optional
- [Full documentation in one file](https://orbitid.com/llms-full.txt)