Create a machine-to-machine client
POST /v1/m2m_clients: Create a machine-to-machine client.
POST /v1/m2m_clients
The secret is in this response only. A private_key_jwt client registers a JWKS instead and has no secret.
- Scope
machine_clients:write- Auth
- Secret key (
sk_…) - Since
- 1.0
Headers
Section titled “Headers”
Honoured for 24 h; a replay returns the original response.Idempotency-Keystringmin length 1 · max length 255
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Request body
Section titled “Request body”namestring Requiredmin length 1 · max length 200
organizationstringauth_methodstringone of
client_secret,private_key_jwtjwksobjectscopesarray of stringmax items 100
audiencesarray of string Requiredmin items 1 · max items 20
access_token_secondsintegermin 60 · max 3600
Responses
Section titled “Responses”- 201 OK M2MClientWithSecret
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 409 Codes: idempotency_key_reused and resource-specific conflicts. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X POST \ "https://api.ohauthcat.com/v1/m2m_clients" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Corp", "audiences": [ "https://api.acme.com" ]}'const response = await fetch("https://api.ohauthcat.com/v1/m2m_clients", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "name": "Acme Corp", "audiences": [ "https://api.acme.com" ] }),});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/m2m_clients", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "name": "Acme Corp", "audiences": [ "https://api.acme.com", ], },)data = response.json(){ "client": { "id": "mcli_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "object": "m2m_client", "organization": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "name": "Acme Corp", "auth_method": "client_secret", "secret_hint": "example_secret_hint", "previous_secret_expires_at": "2026-01-15T09:30:00Z", "jwks": {}, "scopes": [ "organizations:read" ], "audiences": [ "https://api.acme.com" ], "access_token_seconds": 60, "revoked_at": "2026-01-15T09:30:00Z", "last_used_at": "2026-01-15T09:30:00Z", "created_at": "2026-01-15T09:30:00Z", "updated_at": "2026-01-15T09:30:00Z" }, "client_secret": "sk_test_example"}