wikijs-fork/server/modules/authentication/oauth2/definition.yml

key: oauth2
title: Generic OAuth2
description: OAuth 2 is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service.
author: requarks.io
logo: https://static.requarks.io/logo/oauth2.svg
color: grey darken-4
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: The full URL to the authorization endpoint, used to get an authorization code.
    order: 3
  tokenURL:
    type: String
    title: Token Endpoint URL
    hint: The full URL to the token endpoint, used to get an access token.
    order: 4
  mappingUID:
    title: Unique ID Field Mapping
    type: String
    default: 'id'
    hint: The field storing the user unique identifier, e.g. "id" or "_id".
    maxWidth: 500
    order: 20
  mappingEmail:
    title: Email Field Mapping
    type: String
    default: 'email'
    hint: The field storing the user email, e.g. "email" or "mail".
    maxWidth: 500
    order: 21
  mappingDisplayName:
    title: Display Name Field Mapping
    type: String
    default: 'name'
    hint: The field storing the user display name, e.g. "name", "displayName" or "username".
    maxWidth: 500
    order: 22
  mappingPicture:
    title: Avatar Picture Field Mapping
    type: String
    default: 'pictureUrl'
    hint: The field storing the user avatar picture, e.g. "pictureUrl" or "avatarUrl".
    maxWidth: 500
    order: 23