wikijs-fork/server/modules/authentication/oauth2/definition.yml
2023-01-29 17:14:34 -05:00

79 lines
2.1 KiB
YAML

key: oauth2
title: Generic OAuth2
description: OAuth 2.0 is the industry-standard protocol for authorization.
author: requarks.io
logo: https://static.requarks.io/logo/oauth2.svg
color: blue-grey darken-2
website: https://oauth.net/2/
isAvailable: true
useForm: false
props:
clientId:
type: String
title: Client ID
hint: Application Client ID
order: 1
clientSecret:
type: String
title: Client Secret
hint: Application Client Secret
order: 2
authorizationURL:
type: String
title: Authorization Endpoint URL
hint: Application Authorization Endpoint URL
order: 3
tokenURL:
type: String
title: Token Endpoint URL
hint: Application Token Endpoint URL
order: 4
userInfoURL:
type: String
title: User Info Endpoint URL
hint: User Info Endpoint URL
order: 5
userIdClaim:
type: String
title: ID Claim
hint: Field containing the user ID
default: id
maxWidth: 500
order: 6
displayNameClaim:
type: String
title: Display Name Claim
hint: Field containing user display name
default: displayName
maxWidth: 500
order: 7
emailClaim:
type: String
title: Email Claim
hint: Field containing the user email address
default: email
maxWidth: 500
order: 8
logoutURL:
type: String
title: Logout URL
hint: (optional) Logout URL on the OAuth2 provider where the user will be redirected to complete the logout process.
order: 9
scope:
type: String
title: Scope
hint: (optional) Application Client permission scopes.
order: 10
useQueryStringForAccessToken:
type: Boolean
default: false
title: Pass access token via GET query string to User Info Endpoint
hint: (optional) Pass the access token in an `access_token` parameter attached to the GET query string of the User Info Endpoint URL. Otherwise the access token will be passed in the Authorization header.
order: 11
enableCSRFProtection:
type: Boolean
default: true
title: Enable CSRF protection
hint: Pass a nonce state parameter during authentication to protect against CSRF attacks.
order: 12