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 application.client-secrets API

Manage client secrets for Connect Applications.

WorkOS application.client-secrets API is one of 41 APIs that WorkOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include application.client-secrets. 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 3 operations across 2 paths, and defines 2 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.

3 operations 2 paths 2 schemas 1 DELETE1 GET1 POST

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 application.client-secrets 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 3

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

application.client-secrets 3

Manage client secrets for Connect Applications.

GET
/connect/applications/{id}/client_secrets
List Client Secrets for a Connect Application
ApplicationCredentialsController_list 1 param → 200404
POST
/connect/applications/{id}/client_secrets
Create a New Client Secret for a Connect Application
ApplicationCredentialsController_create 1 param body → 201404422
DELETE
/connect/client_secrets/{id}
Delete a Client Secret
ApplicationCredentialsController_delete 1 param → 204404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed is NewConnectApplicationSecret (7 properties). Each schema is shown below with its type and property counts.

CreateApplicationSecretDto
object
NewConnectApplicationSecret
object
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workos-application-client-secrets-api-openapi.yml Raw ↑

Other APIs WorkOS publishes across the network.

WorkOS admin-portal API
WorkOS api_keys 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
WorkOS feature-flags.targets API