Meta tags:
description= Build frictionless onboarding for organizations with real‑time user provisioning and deprovisioning.;
Headings (most frequently used words):
directory, sync, your, what, use, app, on, this, page, introduction, definitions, is, why, customer, experiences, api, overview, doesn, uses, group, user,
Text of the page (most frequently used words):
#directory (69), your (47), app (40), the (39), and (34), user (31), workos (25), string (23), sync (21), with (16), users (15), provider (15), for (14), group (14), data (13), employee (12), can (11), from (10), ulm (10), api (9), groups (9), this (9), events (9), use (9), access (8), interfaces (8), customer (8), attributes (7), has (7), then (7), are (7), scim (7), provisioning (7), that (6), normalizes (6), updates (6), you (6), integrations (6), their (6), providers (6), identity (6), customers (5), resources (5), quick (5), start (5), have (5), role (5), page (5), manually (5), process (5), reference (5), security (4), admin (4), interface (4), often (4), software (4), using (4), via (4), they (4), contact (4), changes (4), what (4), deprovisioning (4), sdks (4), migrate (4), idp (4), assignment (4), prem (4), deployment (4), bearer (4), token (4), rotation (4), understanding (4), unique (4), emails (4), handle (4), inactive (4), example (4), apps (4), fundamentals (4), company (3), set (3), organization (3), diagram (3), showing (3), relay (3), receiving (3), pushing (3), state (3), provides (3), mapping (3), allows (3), source (3), truth (3), all (3), provision (3), contacts (3), information (3), account (3), include (3), directories (3), management (3), hris (3), inc (2), developers (2), portal (2), sign (2), features (2), them (2), these (2), within (2), who (2), been (2), provisioned (2), email (2), directory_id (2), idp_id (2), most (2), used (2), collection (2), engineering (2), updated_at (2), created_at (2), name (2), organization_id (2), enable (2), self (2), setup (2), supports (2), between (2), maintain (2), lists (2), domain (2), overview (2), makes (2), apis (2), sent (2), through (2), not (2), sso (2), add (2), one (2), uses (2), more (2), manual (2), error (2), lead (2), product (2), vulnerabilities (2), where (2), registration (2), method (2), sends (2), either (2), new (2), update (2), doesn (2), experiences (2), into (2), inform (2), why (2), workday (2), enterprise (2), rules (2), tools (2), lifecycle (2), human (2), system (2), manage (2), standard (2), managing (2), onboarding (2), definitions (2), organizations (2), introduction (2), roles (2), going (2), live (2), getting (2), started (2), search (2), docs (2), privacy, legal, careers, about, support, pricing, podcast, blog, status, changelog, documentation, fine, grained, authorization, single, authkit, next, install, sdk, integrate, belong, multiple, associated, configured, needs, person, entity, last_name, first_name, mapped, categorize, based, shared, traits, grouping, under, sales, accounting, service, dozens, including, delivered, webhooks, retrieved, stores, type, external_key, object, main, components, integration, easy, providing, will, automatically, password, optional, assign, appropriate, once, place, adopt, cloud, processes, scale, well, input, drifting, result, become, table, stakes, requirement, enterprises, future, entered, prone, get, unauthorized, proceed, invite, link, initiating, back, forth, messaging, helpdesk, ticket, login, both, provisions, imagine, scenario, purchased, onboards, would, following, without, remove, let, take, look, two, different, scenarios, each, implements, differently, implementing, challenging, introduce, hides, complexity, focus, building, core, deletion, when, attribute, changed, creation, increases, easier, implemented, requests, common, see, full, list, supported, google, workspace, okta, microsoft, active, centrally, deprovision, automatic, developer, friendly, implement, grade, existing, removing, creating, setting, inside, designed, detailed, related, policies, examples, hibob, bamboohr, etc, cross, open, automated, many, occurs, until, removed, also, commonly, referred, systems, enforce, activate, deactivate, accounts, create, accelerate, adoption, copy, build, frictionless, real, time, dashboard, feedback, press, homepage,
Text of the page (random words):
directory sync workos docs workos docs homepage directory sync directory sync press k to search k search api reference feedback dashboard sign in getting started fundamentals fundamentals quick start quick start example apps example apps going live handle inactive users handle inactive users unique emails unique emails understanding events understanding events user attributes user attributes bearer token rotation bearer token rotation on prem deployment on prem deployment mapping roles idp role assignment idp role assignment api reference api reference events events integrations integrations migrate to workos migrate to workos sdks sdks getting started fundamentals fundamentals quick start quick start example apps example apps going live handle inactive users handle inactive users unique emails unique emails understanding events understanding events user attributes user attributes bearer token rotation bearer token rotation on prem deployment on prem deployment mapping roles idp role assignment idp role assignment api reference api reference events events integrations integrations migrate to workos migrate to workos sdks sdks directory sync build frictionless onboarding for organizations with real time user provisioning and deprovisioning copy page on this page introduction definitions what is directory sync why use directory sync what your customer experiences your app doesn t use directory sync your app uses directory sync api overview directory directory group directory user introduction organizations use company directories and hris systems to manage users and enforce their access to organization resources directories enable it contacts to activate and deactivate accounts create groups that inform access rules accelerate adoption of new tools and more definitions ulm user lifecycle management or ulm is the process of managing a user s access to an app this occurs from app onboarding until they are removed from an app ulm is also commonly referred to as identity provisioning scim system for cross domain identity management or scim is an open standard for managing automated user and group provisioning it s a standard that many directory providers interface with hris a human resources information system or hris is software designed to maintain manage and process detailed employee information and human resources related policies examples include workday hibob bamboohr etc user provisioning provisioning is the process of creating a user and setting attributes for them inside of an app user deprovisioning deprovisioning is the process of removing a user from an app what is directory sync directory sync is a set of developer friendly apis and it admin tools that allows you to implement enterprise grade user lifecycle management ulm into your existing app ulm allows it contacts to centrally provision and deprovision users from their directory provider a directory provider is the source of truth for your enterprise customer s user and group lists directory sync sends automatic updates to your app for changes to directories groups users or access rules common directory providers include microsoft active directory okta workday and google workspace see the full list of supported directory providers on the integrations page why use directory sync ulm increases the security of your app and makes it easier for your customers to use your app ulm is most often implemented using scim scim requests are sent between directory providers and your app to inform you of changes to a user s identity changes can include provisioning an identity for a user account creation when a user s attribute has changed account update deprovisioning a user from your app account deletion each directory provider implements scim differently implementing scim is often a challenging process and can introduce security vulnerabilities into your app directory sync hides this complexity so you can focus on building core product features in your app what your customer experiences let s take a look at two different user provisioning scenarios your app doesn t use directory sync without ulm your customers have to manually add update and remove users from your app imagine a scenario where your customer has purchased your software and onboards a new employee to your app your customer would have to do the following the it contact provisions the employee in their directory provider if they use one and manually in your app all employee information has to be set manually in both the directory provider and your app the it contact has to manually provision a login method for the employee through either sso if they use an identity provider or a self registration page the it contact sends the invite link to their employee often initiating a back and forth via either email messaging app or it helpdesk ticket the employee has to proceed with the registration method and can then use your app all future changes to this employee s data and access are manually entered by it contacts this is error prone and can lead to security vulnerabilities where users get unauthorized access to resources as your customers adopt more cloud software these manual processes do not scale well manual input error can lead to the source of truth directory drifting from your app s state as a result ulm has become a table stakes product requirement for enterprises your app uses directory sync if your app supports ulm via directory sync the it contact can provision this employee from one place add the employee to their directory provider assign the employee to your app with the appropriate role once via the directory provider admin page optional have the employee go through a password setup if they are not using an identity provider sso directory sync makes this integration easy by providing apis your app interfaces with all updates for this directory will automatically be sent to your app from workos api overview directory directory group and directory user are the main components your app interfaces with directory directory providers provides the directory data workos directory interface directory object directory id string domain string external_key string name string organization_id string state string type string created_at string updated_at string normalizes directory data your app interfaces with workos a diagram showing that directory providers relay the directory data to workos then workos normalizes the data and then your app interfaces with workos receiving and pushing updates a directory is the source of truth for your customer s user and group lists workos supports dozens of integrations including scim directory updates can be delivered to you via webhooks or retrieved using the events api your app stores a mapping between your customer and their directory this allows you to maintain your app in sync with the directory provider used by your customer you can enable self service directory sync setup for your customers using the admin portal directory group directory provider groups accounting sales engineering provides the user group data workos directory group interface group id string idp_id string directory_id string organization_id string name string created_at string updated_at string normalizes user group data your app interfaces with workos a diagram showing that directory provider groups relay the directory group data to workos then workos normalizes the data and then your app interfaces with workos receiving and pushing updates a directory group is a collection of users within an organization who have been provisioned with access to your app directory groups are mapped from directory provider groups directory groups are most often used to categorize a collection of users based on shared traits i e grouping software developers at a company under an engineering group directory user directory provider users provides the user data workos directory user interface user id string idp_id string directory_id string first_name string last_name string email string groups group state string normalizes user data your app interfaces with workos a diagram showing that directory provider users relay the user data to workos then workos normalizes the data and then your app interfaces with workos receiving and pushing updates a directory user is a person or entity within an organization who has been provisioned with access to your app users can belong to multiple directory groups users have attributes associated with them these attributes can be configured for your app s needs quick start set up a directory install the sdk and integrate directory sync up next workos inc features authkit single sign on directory sync admin portal fine grained authorization developers documentation changelog api status resources blog podcast pricing security support company about customers careers legal privacy workos inc
|