GitHub 社群登入 (githubLogin)

GitHub 社群登入的配置。

名稱	類型	預設值	說明
authFilterRef	最上層 authFilter 元素的參照（字串）。		指定鑑別過濾器參照。
authorizationEndpoint	string	https://github.com/login/oauth/authorize	指定授權端點 URL。
clientId	string 必要		應用程式或用戶端 ID。
clientSecret	可逆的編碼密碼（字串）必要		應用程式或用戶端的密碼。
displayName	string	GitHub	顯示用的社群登入配置名稱。
isClientSideRedirectSupported	boolean	true	指定是否支援用戶端重新導向。用戶端的範例包括瀏覽器或獨立式 JavaScript 應用程式。如果設為 true，用戶端必須支援 JavaScript。
mapToUserRegistry	boolean	false	指定是否將 userIdentifier 對映至登錄使用者。
redirectToRPHostAndPort	string		指定回呼通訊協定、主機和埠號。例如，https://myhost:8020。
responseType	code	code	指定 OAuth 回應類型。 code 授權碼
scope	string	user	指定必要範圍。
sslRef	最上層 ssl 元素的參照（字串）。		指定用來連接至社群媒體之 SSL 配置的 ID。
tokenEndpoint	string	https://github.com/login/oauth/access_token	指定記號端點 URL。
tokenEndpointAuthMethod	client_secret_basic client_secret_post	client_secret_post	指定必要鑑別方法。 client_secret_basic 使用 HTTP Basic 驗證方案，以 OpenID Connect 提供者的令牌端點驗證用戶端。 client_secret_post 在請求體中包含用戶端憑證，以便使用 OpenID Connect 提供者的令牌端點驗證用戶端。
useSystemPropertiesForHttpClientConnections	boolean	false	指定當 OpenID Connect 或 OAuth 用戶端建立 HTTP 用戶端連線時，是否使用 Java 系統內容。如果您希望連線使用 http* 或 javax* 系統內容，請將這個內容設為 true。
userApi	string	https://api.github.com/user/emails	用來擷取使用者資訊的 URL。
userNameAttribute	string	email	聲明的值是已鑑別使用者的主體身分。
website	字串（已關閉空格修整）	https://github.com	網站位址。

名稱

類型

預設值

說明

authFilterRef

最上層 authFilter 元素的參照（字串）。

指定鑑別過濾器參照。

authorizationEndpoint

string

https://github.com/login/oauth/authorize

指定授權端點 URL。

clientId

string
必要

應用程式或用戶端 ID。

clientSecret

可逆的編碼密碼（字串）
必要

應用程式或用戶端的密碼。

displayName

string

GitHub

顯示用的社群登入配置名稱。

isClientSideRedirectSupported

boolean

true

指定是否支援用戶端重新導向。用戶端的範例包括瀏覽器或獨立式 JavaScript 應用程式。如果設為 true，用戶端必須支援 JavaScript。

mapToUserRegistry

boolean

false

指定是否將 userIdentifier 對映至登錄使用者。

redirectToRPHostAndPort

string

指定回呼通訊協定、主機和埠號。例如，https://myhost:8020。

responseType

code

code

指定 OAuth 回應類型。
code
授權碼

scope

string

user

指定必要範圍。

sslRef

最上層 ssl 元素的參照（字串）。

指定用來連接至社群媒體之 SSL 配置的 ID。

tokenEndpoint

string

https://github.com/login/oauth/access_token

指定記號端點 URL。

tokenEndpointAuthMethod

client_secret_basic
client_secret_post

client_secret_post

指定必要鑑別方法。
client_secret_basic
使用 HTTP Basic 驗證方案，以 OpenID Connect 提供者的令牌端點驗證用戶端。
client_secret_post
在請求體中包含用戶端憑證，以便使用 OpenID Connect 提供者的令牌端點驗證用戶端。

useSystemPropertiesForHttpClientConnections

boolean

false

指定當 OpenID Connect 或 OAuth 用戶端建立 HTTP 用戶端連線時，是否使用 Java 系統內容。如果您希望連線使用 http* 或 javax* 系統內容，請將這個內容設為 true。

userApi

string

https://api.github.com/user/emails

用來擷取使用者資訊的 URL。

userNameAttribute

string

聲明的值是已鑑別使用者的主體身分。

website

字串（已關閉空格修整）

https://github.com

網站位址。

authFilter

指定鑑別過濾器參照。

authFilter > cookie

唯一的配置 ID。

名稱	類型	預設值	說明
id	字串		唯一的配置 ID。
matchType	contains equals notContain	contains	指定相符類型。 contains 包含 equals 等於 notContain 不包含
name	string 必要		指定名稱。

名稱

類型

預設值

說明

字串

唯一的配置 ID。

matchType

contains
equals
notContain

contains

指定相符類型。
contains
包含
equals
等於
notContain
不包含

name

string
必要

指定名稱。

authFilter > host

唯一的配置 ID。

名稱	類型	預設值	說明
id	字串		唯一的配置 ID。
matchType	contains equals notContain	contains	指定相符類型。 contains 包含 equals 等於 notContain 不包含
name	string 必要		指定名稱。

名稱

類型

預設值

說明

字串

唯一的配置 ID。

matchType

contains
equals
notContain

contains

指定相符類型。
contains
包含
equals
等於
notContain
不包含

name

string
必要

指定名稱。

authFilter > remoteAddress

唯一的配置 ID。

名稱	類型	預設值	說明
id	字串		唯一的配置 ID。
ip	string		指定遠端主機 TCP/IP 位址。
matchType	contains equals greaterThan lessThan notContain	contains	指定相符類型。 contains 包含 equals 等於 greaterThan 大於 lessThan 小於 notContain 不包含

名稱

類型

預設值

說明

字串

唯一的配置 ID。

string

指定遠端主機 TCP/IP 位址。

matchType

contains
equals
greaterThan
lessThan
notContain

contains

指定相符類型。
contains
包含
equals
等於
greaterThan
大於
lessThan
小於
notContain
不包含

authFilter > requestHeader

唯一的配置 ID。

名稱	類型	預設值	說明
id	字串		唯一的配置 ID。
matchType	contains equals notContain	contains	指定相符類型。 contains 包含 equals 等於 notContain 不包含
name	string 必要		指定名稱。
value	string		值屬性會指定要求標頭的值。如果未指定值，則會使用 name 屬性來進行比對，例如 requestHeader id="sample "name="email" matchType = "contains"。

名稱

類型

預設值

說明

字串

唯一的配置 ID。

matchType

contains
equals
notContain

contains

指定相符類型。
contains
包含
equals
等於
notContain
不包含

name

string
必要

指定名稱。

value

string

值屬性會指定要求標頭的值。如果未指定值，則會使用 name 屬性來進行比對，例如 requestHeader id="sample "name="email" matchType = "contains"。

authFilter > requestUrl

唯一的配置 ID。

名稱	類型	預設值	說明
id	字串		唯一的配置 ID。
matchType	contains equals notContain	contains	指定相符類型。 contains 包含 equals 等於 notContain 不包含
urlPattern	string 必要		指定 URL 型樣。不支援將 * 字元用作萬用字元。

名稱

類型

預設值

說明

字串

唯一的配置 ID。

matchType

contains
equals
notContain

contains

指定相符類型。
contains
包含
equals
等於
notContain
不包含

urlPattern

string
必要

指定 URL 型樣。不支援將 * 字元用作萬用字元。

authFilter > userAgent

唯一的配置 ID。

名稱	類型	預設值	說明
agent	string 必要		指定瀏覽器的使用者代理程式，以幫助識別正在使用的瀏覽器。
id	字串		唯一的配置 ID。
matchType	contains equals notContain	contains	指定相符類型。 contains 包含 equals 等於 notContain 不包含

名稱

類型

預設值

說明

agent

string
必要

指定瀏覽器的使用者代理程式，以幫助識別正在使用的瀏覽器。

字串

唯一的配置 ID。

matchType

contains
equals
notContain

contains

指定相符類型。
contains
包含
equals
等於
notContain
不包含

authFilter > webApp

唯一的配置 ID。

名稱	類型	預設值	說明
id	字串		唯一的配置 ID。
matchType	contains equals notContain	contains	指定相符類型。 contains 包含 equals 等於 notContain 不包含
name	string 必要		指定名稱。

名稱

類型

預設值

說明

字串

唯一的配置 ID。

matchType

contains
equals
notContain

contains

指定相符類型。
contains
包含
equals
等於
notContain
不包含

name

string
必要

指定名稱。

jwt

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

名稱	類型	預設值	說明
builder	字串（已關閉空格修整）		參照的 JWT 建置器會建立 JWT 記號，記號會新增到已鑑別的主體。
claims	string 這指定為子元素，而不是指定為 XML 屬性 (出現次數上限 400).		指定要從使用者資訊或 ID 記號複製的聲明清單（以逗點區隔）。

名稱

類型

預設值

說明

builder

字串（已關閉空格修整）

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

claims

string
這指定為子元素，而不是指定為 XML 屬性 (出現次數上限 400).

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