Skip to main content

Admin: people and sign-in

These endpoints manage organizations whose people live in vastframe itself rather than in a synced directory, and how each organization signs in. Anyone with admin access can read; only Org Admins change things.

People​

MethodPathBodyWhat it does
GET/api/admin/people{ editable, people, groups }
POST/api/admin/people{ email, name?, department?, jobTitle?, managerId?, groupIds? }Invite a person (they sign in with their email). 201 with the person.
POST/api/admin/people/import{ csv }Bulk import: { added, skipped }
PATCH/api/admin/people/:id{ name?, department?, jobTitle?, managerId?, enabled?, groupIds? }Update or turn off a person (turning off also ends their sessions)
POST/api/admin/people/:id/sign-outSign the person out on every device: { signedOut: true, id }. Org Admins; works on every organization, directory-synced ones too.

Errors: 400 INVALID_EMAIL, 409 PERSON_EXISTS, 400 INVALID_MANAGER (unknown, or it would create a reporting loop), 400 INVALID_GROUP, 400 CANNOT_DISABLE_SELF, 404 NOT_FOUND.

Groups​

MethodPathBodyWhat it does
GET/api/admin/groups{ editable, groups }
POST/api/admin/groups{ name, description?, members? }Create a group. 201.
PATCH/api/admin/groups/:id{ name?, description?, members? }Update a group. members replaces the list.
DELETE/api/admin/groups/:id{ removed: true }

Errors: 400 INVALID_NAME, 409 GROUP_EXISTS, 400 INVALID_MEMBER (a group can't contain itself), 404 NOT_FOUND.

When the organization's people come from a directory (Entra, or directory sync), writes answer 409 DIRECTORY_READ_ONLY: change people there instead.

Sign-in​

MethodPathBodyWhat it does
GET/api/admin/sign-inThe current sign-in setup, domains and join policy
POST/api/admin/sign-in/test{ kind, issuer?, entraTid? }Check a provider's OpenID configuration without saving
PUT/api/admin/sign-in{ kind, issuer?, clientId?, clientSecret?, entraTid?, scopes? }Choose how people sign in
POST/api/admin/sign-in/workos/portal{ intent: "sso" | "dsync" }A setup-portal link for enterprise SSO or directory sync
POST/api/admin/sign-in/workos/syncFind the connected directory and sync people now
POST/api/admin/sign-in/domains{ domain }Add an email domain to verify (201)
POST/api/admin/sign-in/domains/:domain/verifyVerify it via its DNS TXT record
DELETE/api/admin/sign-in/domains/:domainRemove a domain (404 NOT_FOUND if unknown)
PUT/api/admin/sign-in/join-policy{ policy: "invite_only" | "verified_domains" }Who may join

kind is one of:

KindSign-in
localvastframe accounts with email links (default for new organizations)
entraYour own Entra tenant: pass entraTid (a GUID), clientId, clientSecret
oidcAny OpenID Connect provider (Google Workspace, Okta…): pass issuer, clientId, clientSecret
workosEnterprise SSO (SAML) and directory sync through WorkOS

The client secret is never returned; leave it blank on a later PUT to keep the stored one.

Errors: 400 INVALID, 400 IDP_UNREACHABLE, 400 IDP_INVALID, 409 NOT_VERIFIED (the TXT record isn't visible yet), 409 NO_VERIFIED_DOMAIN, 409 WORKOS_NOT_ENABLED, 409 NO_DIRECTORY, 501 WORKOS_NOT_CONFIGURED, 402 LICENSE_FEATURE, and 409 INSTALLATION_SIGN_IN for the installation's default organization, whose sign-in is set at install time.

The setup flow is described in Sign-in.

Was this page helpful?