githubLogin - GitHub 社群登入 (githubLogin)

GitHub 社群登入的配置。

NameTypeDefaultDescription
idstring唯一的配置 ID。
clientIdstring應用程式或用戶端 ID。
clientSecret可逆的編碼密碼(字串)應用程式或用戶端的密碼。
authorizationEndpointstringhttps://github.com/login/oauth/authorize指定授權端點 URL。
tokenEndpointstringhttps://github.com/login/oauth/access_token指定記號端點 URL。
userApistringhttps://api.github.com/user/emails用來擷取使用者資訊的 URL。
scopestringuser指定必要範圍。
userNameAttributestringemail聲明的值是已鑑別使用者的主體身分。
mapToUserRegistrybooleanfalse指定是否將 userIdentifier 對映至登錄使用者。
sslRef最上層 ssl 元素的參照(字串)。指定用來連接至社群媒體之 SSL 配置的 ID。
authFilterRef最上層 authFilter 元素的參照(字串)。指定鑑別過濾器參照。
isClientSideRedirectSupportedbooleantrue指定是否支援用戶端重新導向。用戶端的範例包括瀏覽器或獨立式 JavaScript 應用程式。如果設為 true,用戶端必須支援 JavaScript。
displayNamestringGitHub顯示用的社群登入配置名稱。
websitetokenTypehttps://github.com網站位址。
redirectToRPHostAndPortstring指定回呼主機和埠號。

authFilter

指定鑑別過濾器參照。

authFilter > webApp

唯一的配置 ID。

NameTypeDefaultDescription
idstring唯一的配置 ID。
namestring指定名稱。
matchType
  • contains
  • notContain
  • equals
contains指定相符類型。
contains
包含
notContain
不包含
equals
等於

authFilter > requestUrl

唯一的配置 ID。

NameTypeDefaultDescription
idstring唯一的配置 ID。
urlPatternstring指定 URL 型樣。
matchType
  • contains
  • notContain
  • equals
contains指定相符類型。
contains
包含
notContain
不包含
equals
等於

authFilter > remoteAddress

唯一的配置 ID。

NameTypeDefaultDescription
idstring唯一的配置 ID。
matchType
  • contains
  • notContain
  • equals
  • lessThan
  • greaterThan
contains指定相符類型。
contains
包含
notContain
不包含
equals
等於
lessThan
小於
greaterThan
大於
ipstring指定 IP 位址。

authFilter > host

唯一的配置 ID。

NameTypeDefaultDescription
idstring唯一的配置 ID。
namestring指定名稱。
matchType
  • contains
  • notContain
  • equals
contains指定相符類型。
contains
包含
notContain
不包含
equals
等於

authFilter > userAgent

唯一的配置 ID。

NameTypeDefaultDescription
idstring唯一的配置 ID。
agentstring指定使用者代理程式
matchType
  • contains
  • notContain
  • equals
contains指定相符類型。
contains
包含
notContain
不包含
equals
等於

jwt

指定用來建置 JWT 記號的資訊。此資訊包含 JWT 建置器參照和來自 ID 記號的聲明。

NameTypeDefaultDescription
buildertokenType參照的 JWT 建置器會建立 JWT 記號,記號會新增到已鑑別的主體。

jwt > claims

指定要從使用者資訊或 ID 記號複製的聲明清單(以逗點區隔)。