Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WorkOS user-management.organization-membership API

Manage user organization memberships.

WorkOS user-management.organization-membership API is one of 41 APIs that WorkOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include user-management.organization-membership. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a GitHub repository, a changelog, and pricing.

This API exposes 7 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.1.1, at version 1.0.

Requests are made against 2 base URLs: https://api.workos.com, https://api.workos-test.com.

7 operations 4 paths 6 schemas 1 DELETE2 GET1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.1
API Version
1.0
Base URL
https://api.workos.com
Authentication
HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 2

WorkOS user-management.organization-membership API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer). It accepts HTTP bearer tokens (JWT) (access_token). By default, every request must be authenticated.

  • bearer — Your WorkOS API key prefixed with sk. Pass it as a Bearer token: Authorization: Bearer skexample123456789.
  • access_token — An SSO access token returned from the Get a Profile and Token endpoint.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

user-management.organization-membership 7

Manage user organization memberships.

GET
/user_management/organization_memberships
List Organization Memberships
UserlandUserOrganizationMembershipsController_list 7 params → 200400404422
POST
/user_management/organization_memberships
Create an Organization Membership
UserlandUserOrganizationMembershipsController_create body → 201400404422
GET
/user_management/organization_memberships/{id}
Get an Organization Membership
UserlandUserOrganizationMembershipsController_get 1 param → 200404
DELETE
/user_management/organization_memberships/{id}
Delete an Organization Membership
UserlandUserOrganizationMembershipsController_delete 1 param → 200404
PUT
/user_management/organization_memberships/{id}
Update an Organization Membership
UserlandUserOrganizationMembershipsController_update 1 param body → 200404422
PUT
/user_management/organization_memberships/{id}/deactivate
Deactivate an Organization Membership
UserlandUserOrganizationMembershipsController_deactivate 1 param → 200400404422
PUT
/user_management/organization_memberships/{id}/reactivate
Reactivate an Organization Membership
UserlandUserOrganizationMembershipsController_reactivate 1 param → 200400404422

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are UserlandUser (13 properties), UserlandUserOrganizationMembership (12 properties), SlimRole (1 property). Each schema is shown below with its type and property counts.

UserlandUser
object
The user object.
13 properties 11 required
PaginationOrder
string
CreateUserlandUserOrganizationMembershipDto
UserlandUserOrganizationMembership
object
12 properties 10 required
UpdateUserlandUserOrganizationMembershipDto
SlimRole
object
The primary role assigned to the user.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workos-user-management-organization-membership-api-openapi.yml Raw ↑

Other APIs WorkOS publishes across the network.

WorkOS admin-portal API
WorkOS api_keys API
WorkOS application.client-secrets API
WorkOS applications API
WorkOS audit-logs API
WorkOS authorization API
WorkOS connections API
WorkOS directories API
WorkOS directory-groups API
WorkOS directory-users API
WorkOS events API
WorkOS feature-flags API