Superwall WorkOS Organization Admin API
Mint WorkOS Admin Portal links for organization administrators to self-configure SSO, Directory Sync, audit log streaming, and domain verification.
Mint WorkOS Admin Portal links for organization administrators to self-configure SSO, Directory Sync, audit log streaming, and domain verification.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/superwall:superwall-workos-organization-admin-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Superwall API V2 WorkOS Organization Admin API
version: 2.0.0
description: Superwall V2 API - Scope-based authentication with organization API keys
servers:
- url: https://api.superwall.com
description: Production
- url: https://api.superwall.dev
description: Staging
- url: /
description: Local
security: []
tags:
- name: WorkOS Organization Admin
description: Mint WorkOS Admin Portal links for organization administrators to self-configure SSO, Directory Sync, audit log streaming, and domain verification.
paths:
/v2/organizations/{organization_id}/workos/admin-portal-link:
post:
tags:
- WorkOS Organization Admin
operationId: workosv2.createAdminPortalLink
parameters:
- name: organization_id
in: path
schema:
type: string
required: true
security:
- bearer: []
- cookie: []
- oauth: []
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
object:
type: string
enum:
- portal_link
url:
type: string
intent:
type: string
enum:
- sso
- dsync
- audit_logs
- log_streams
- domain_verification
expires_at:
anyOf:
- type: string
- type: 'null'
required:
- object
- url
- intent
- expires_at
additionalProperties: false
'400':
description: The request did not match the expected schema | The request was invalid or malformed
content:
application/json:
schema:
anyOf:
- type: object
properties:
_tag:
type: string
enum:
- HttpApiDecodeError
issues:
type: array
items:
type: object
properties:
_tag:
type: string
enum:
- Type
- Missing
- Unexpected
- Forbidden
- Pointer
- Refinement
- Transformation
- Composite
path:
type: array
items:
anyOf:
- type: string
- type: number
- type: object
properties:
_tag:
type: string
enum:
- symbol
key:
type: string
required:
- _tag
- key
additionalProperties: false
message:
type: string
required:
- _tag
- path
- message
additionalProperties: false
message:
type: string
required:
- _tag
- issues
- message
additionalProperties: false
- type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/BadRequest'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
type: string
param:
anyOf:
- type: string
doc_url:
anyOf:
- type: string
required:
- _tag
- code
- message
additionalProperties: false
'401':
description: An error occurred while validating the API key | No API key was provided in the request | The API key does not have a valid format | The API key is invalid or has been revoked | The session cookie is invalid or expired
content:
application/json:
schema:
anyOf:
- type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/AuthenticationFailed'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
anyOf:
- type: string
doc_url:
anyOf:
- type: string
required:
- _tag
additionalProperties: false
- type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/MissingApiKey'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
anyOf:
- type: string
doc_url:
anyOf:
- type: string
required:
- _tag
additionalProperties: false
- type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/InvalidApiKeyFormat'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
anyOf:
- type: string
doc_url:
anyOf:
- type: string
required:
- _tag
additionalProperties: false
- type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/InvalidApiKey'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
anyOf:
- type: string
doc_url:
anyOf:
- type: string
required:
- _tag
additionalProperties: false
- type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/InvalidSession'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
anyOf:
- type: string
required:
- _tag
additionalProperties: false
'403':
description: The API key does not have permission to perform this action
content:
application/json:
schema:
type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/PermissionError'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
type: string
required_scope:
anyOf:
- type: string
doc_url:
anyOf:
- type: string
required:
- _tag
- message
additionalProperties: false
'404':
description: The requested resource was not found
content:
application/json:
schema:
type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/ResourceNotFound'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
anyOf:
- type: string
param:
anyOf:
- type: string
doc_url:
anyOf:
- type: string
resource_type:
anyOf:
- type: string
resource_id:
anyOf:
- type: string
required:
- _tag
additionalProperties: false
'429':
description: Too many requests have been made in a short period
content:
application/json:
schema:
type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/RateLimit'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
anyOf:
- type: string
retry_after:
anyOf:
- type: number
required:
- _tag
additionalProperties: false
'500':
description: An unexpected error occurred on the server
content:
application/json:
schema:
type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/InternalError'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
anyOf:
- type: string
cause:
anyOf:
- {}
required:
- _tag
additionalProperties: false
'503':
description: The upstream WorkOS request failed
content:
application/json:
schema:
type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/WorkOSProviderError'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
anyOf:
- type: string
provider:
anyOf:
- type: string
operation:
anyOf:
- type: string
upstream_status:
anyOf:
- type: number
upstream_code:
anyOf:
- type: string
upstream_message:
anyOf:
- type: string
required:
- _tag
additionalProperties: false
description: Generates a short-lived URL that an organization owner or admin can share with their IT administrator to configure SSO, Directory Sync, audit log streaming, log streams, or domain verification via the WorkOS-hosted Admin Portal. Requires OWNER or ADMIN membership in the organization.
summary: Create WorkOS Admin Portal link
requestBody:
content:
application/json:
schema:
type: object
properties:
intent:
type: string
enum:
- sso
- dsync
- audit_logs
- log_streams
- domain_verification
return_url:
anyOf:
- type: string
required:
- intent
additionalProperties: false
required: true
components:
securitySchemes:
bearer:
type: http
scheme: Bearer
cookie:
type: apiKey
name: accounts_superwall_token
in: cookie
oauth:
type: http
scheme: Bearer