POST /oauth2/register
Register an OAuth2 application
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
A list of redirect URIs. Eg: ["https://client.example.com/callback"]
The authentication method for the token endpoint. Eg: "client_secret_basic"
"client_secret_basic"Value in
- "none"
- "client_secret_basic"
- "client_secret_post"
The grant types supported by the application. Eg: ["authorization_code"]
Default
[ "authorization_code"]The response types supported by the application. Eg: ["code"]
Default
[ "code"]The name of the application. Eg: "My App"
The URI of the application. Eg: "https://client.example.com"
The URI of the application logo. Eg: "https://client.example.com/logo.png"
The scopes supported by the application. Separated by spaces. Eg: "profile email"
The contact information for the application. Eg: ["admin@example.com"]
The URI of the application terms of service. Eg: "https://client.example.com/tos"
The URI of the application privacy policy. Eg: "https://client.example.com/policy"
The URI of the application JWKS. Eg: "https://client.example.com/jwks"
The JWKS of the application. Eg: {"keys": [{"kty": "RSA", "alg": "RS256", "use": "sig", "n": "...", "e": "..."}]}
The metadata of the application. Eg: {"key": "value"}
The software ID of the application. Eg: "my-software"
The software version of the application. Eg: "1.0.0"
The software statement of the application.
Response Body
application/json
curl -X POST "https://example.com/api/auth/oauth2/register" \ -H "Content-Type: application/json" \ -d '{ "redirect_uris": [ "string" ] }'{ "name": "string", "icon": "string", "metadata": {}, "clientId": "string", "clientSecret": "string", "redirectURLs": [ "http://example.com" ], "type": "web", "authenticationScheme": "client_secret", "disabled": false, "userId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}Is this page helpful?