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

key: oidc
title: Generic OpenID Connect / OAuth2
description: OpenID Connect 1.0 is a simple identity layer on top of the OAuth 2.0 protocol.
author: requarks.io
logo: https://static.requarks.io/logo/oidc.svg
color: blue-grey darken-2
website: http://openid.net/connect/
isAvailable: true
useForm: false
scopes:
  - openid
  - profile
  - email
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
  issuer:
    type: String
    title: Issuer
    hint: Issuer URL
    order: 6
  emailClaim:
    type: String
    title: Email Claim
    hint: Field containing the email address
    default: email
    maxWidth: 500
    order: 7
feat: authentication improvements 2018-08-04 21:27:55 +00:00			`key: oidc`
fix: handle removed auth strategies 2020-08-30 20:33:52 +00:00			`title: Generic OpenID Connect / OAuth2`
feat: authentication improvements 2018-08-04 21:27:55 +00:00			`description: OpenID Connect 1.0 is a simple identity layer on top of the OAuth 2.0 protocol.`
			`author: requarks.io`
			`logo: https://static.requarks.io/logo/oidc.svg`
feat: auth jwt, permissions, login ui (wip) 2018-10-08 04:17:31 +00:00			`color: blue-grey darken-2`
feat: authentication improvements 2018-08-04 21:27:55 +00:00			`website: http://openid.net/connect/`
feat: fix + enable OIDC auth method (#2282) * fix: pass userinfo URL in oidc strategy The userinfo URL from the definition was not being provided to the passport strategy, which resulted in a type error trying to resolve the user's profile. Furthermore, the name of the defined URL was inconsistent with all other authentication method URLs. * fix: pass all necessary scopes to oidc auth method When no scopes are provided, passport-openidconnect uses only `openid`, which does not contain the username or email address. Include `profile` and `email` to ensure the necessary claims are included. * fix: update oidc method to call processProfile correctly Now the profile object and providerKey are passed to processProfile. The usernameClaim no longer has any use as the email address is the username. * fix: mark oidc authentication method as available 2020-08-15 17:32:58 +00:00			`isAvailable: true`
feat: authentication improvements 2018-08-04 21:27:55 +00:00			`useForm: false`
feat: fix + enable OIDC auth method (#2282) * fix: pass userinfo URL in oidc strategy The userinfo URL from the definition was not being provided to the passport strategy, which resulted in a type error trying to resolve the user's profile. Furthermore, the name of the defined URL was inconsistent with all other authentication method URLs. * fix: pass all necessary scopes to oidc auth method When no scopes are provided, passport-openidconnect uses only `openid`, which does not contain the username or email address. Include `profile` and `email` to ensure the necessary claims are included. * fix: update oidc method to call processProfile correctly Now the profile object and providerKey are passed to processProfile. The usernameClaim no longer has any use as the email address is the username. * fix: mark oidc authentication method as available 2020-08-15 17:32:58 +00:00			`scopes:`
			`- openid`
			`- profile`
			`- email`
feat: authentication improvements 2018-08-04 21:27:55 +00:00			`props:`
fix: handle removed auth strategies 2020-08-30 20:33:52 +00:00			`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`
			`issuer:`
			`type: String`
			`title: Issuer`
			`hint: Issuer URL`
			`order: 6`
			`emailClaim:`
			`type: String`
			`title: Email Claim`
			`hint: Field containing the email address`
			`default: email`
			`maxWidth: 500`
			`order: 7`