Files
clerk-sdk-java/docs/models/operations/CreateOAuthApplicationRequestBody.md
2024-06-13 13:51:50 -04:00

11 lines
7.8 KiB
Markdown

# CreateOAuthApplicationRequestBody
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | *String* | :heavy_check_mark: | The name of the new OAuth application | |
| `callbackUrl` | *String* | :heavy_check_mark: | The callback URL of the new OAuth application | |
| `scopes` | *Optional<? extends String>* | :heavy_minus_sign: | Define the allowed scopes for the new OAuth applications that dictate the user payload of the OAuth user info endpoint. Available scopes are `profile`, `email`, `public_metadata`, `private_metadata`. Provide the requested scopes as a string, separated by spaces. | profile email public_metadata |
| `public_` | *Optional<? extends Boolean>* | :heavy_minus_sign: | If true, this client is public and cannot securely store a client secret.<br/>Only the authorization code flow with proof key for code exchange (PKCE) may be used.<br/>Public clients cannot be updated to be confidential clients, and vice versa. | |