Register OAuth client
Exact HTTPS callbacks or literal loopback HTTP callbacks only. OAuth read/act scopes cap access but do not create device grants.
POST
/v1/oauth-clientsAuthorization
AuthorizationBearer token (Clerk owner session) · headerrequiredOwner identity required.
Request body
requiredapplication/jsonnamestringrequiredmin length 1 · max length 64
redirectUrisstring<uri>[]requiredmin items 1 · max items 8
publicbooleandefault: true
accessstringdefault: "read"
Allowed:
readactResponses
201
Created; client secret, when issued, appears only in this response
dataOAuthRegistrationrequiredShow propertiesHide properties
idstring<uuid>requiredprincipalstringrequirednamestringrequiredexpiresAtinteger | nullrequiredrevokedbooleanrequiredaccessstringrequiredAllowed:
readactpurposestringrequiredcanAttachbooleandeviceLimitintegeroauthobjectrequiredShow propertiesHide properties
applicationIdstringrequiredclientIdstringrequiredredirectUrisstring<uri>[]requiredpublicbooleanrequiredclientSecretstringReturned only when the provider issued a secret; store securely and never log.
400
Invalid request or validation failure
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring401
Missing or invalid credential
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring403
Insufficient access or grant
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring404
Resource not found
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring413
Request body exceeds the 16 KiB limit
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring429
Rate limit or workspace capacity limit
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring500
Internal error
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring503
Service or required integration is not configured
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring