openidConnectClient - OpenID Connect クライアント (openidConnectClient)

OpenID Connect クライアント。

NameTypeDefaultDescription
idstring固有の構成 ID。
scopetokenTypeopenid profileプロバイダーに許可されている (OpenID Connect 仕様で詳述されている) OpenID Connect 有効範囲。
userIdentityToCreateSubjectstringsubユーザー・サブジェクトの作成に使用されるユーザー ID を ID トークンに指定します。
httpsRequiredbooleantrueOpenID リライング・パーティーとプロバイダー・サービスの間には SSL 通信が必要です。
grantType
  • implicit
  • authorization_code
authorization_codeこのクライアントに対して使用する認可タイプを指定します。
implicit
暗黙の認可タイプ
authorization_code
許可コード認可タイプ
clientIdstringクライアントの ID。
clientSecretリバース・エンコードされたパスワード (ストリング)クライアントの秘密鍵。
redirectToRPHostAndPortstringリダイレクト OpenID リライング・パーティーのホストとポート番号を指定します。
redirectJunctionPathstringパス・フラグメントが、リダイレクト URL のホスト名とポートの後に挿入されるように指定します。 デフォルトは空ストリングです。
isClientSideRedirectSupportedbooleantrueクライアントがクライアント・サイドでリダイレクトをサポートするかどうかを指定します。
issuerIdentifierstring発行者 ID は、スキーム、ホスト、およびオプションのポート番号とパスのコンポーネントを含む、HTTPS スキームを使用した大/小文字の区別がある URL です。
mapIdentityToRegistryUserbooleanfalseID をレジストリー・ユーザーにマップするかどうかを指定します。 これを false に設定すると、ユーザー・サブジェクトを作成するためにユーザー・レジストリーは使用されません。
trustStoreRef最上位の keyStore エレメント (ストリング) の参照。ID トークンの署名を検証するために必要な公開鍵が含まれている鍵ストア。
trustAliasNamestring非対称アルゴリズムを使用して署名妥当性検査を行うための公開鍵を見つける際に使用される鍵別名。
nonceEnabledbooleanfalse許可コード・フロー内で nonce パラメーターを有効にします。
realmNamestringmapIdentityToRegistryUser が false に設定されている時にユーザー・サブジェクトを作成するために使用されるレルム名を指定します。
sslRef最上位の ssl エレメント (ストリング) の参照。OpenID Connect プロバイダーに接続するために使用される SSL 構成の ID を指定します。
signatureAlgorithm
  • HS256
  • RS256
  • none
HS256ID トークンの署名を検証するために使用される署名アルゴリズムを指定します。
HS256
HS256 署名アルゴリズムを使用してトークンの署名および検証を行う
RS256
RS256 署名アルゴリズムを使用してトークンの署名および検証を行う
none
トークンは署名されている必要はない
includeIdTokenInSubjectbooleantrueクライアント・サブジェクトに ID トークンを含めるかどうかを指定します。
accessTokenInLtpaCookiebooleanfalseLTPA トークンがアクセス・トークンを含むかどうかを指定します。
initialStateCacheCapacityint
Min: 0
3000状態キャッシュの最初の容量を指定します。 容量は必要に応じて自動的に大きくなります。
hostNameVerificationEnabledbooleanfalseホスト名の検証を有効にするかどうかを指定します。
authorizationEndpointUrlstring許可エンドポイント URL を指定します。
tokenEndpointUrlstringトークン・エンドポイント URL を指定します。
jwkEndpointUrlstringJWK エンドポイント URL を指定します。
jwkClientIdstringJWK 要求の基本認証スキームに組み込むクライアント ID を指定します。
jwkClientSecretリバース・エンコードされたパスワード (ストリング)JWK 要求の基本認証スキームに組み込むクライアント・パスワードを指定します。
responseType
  • id_token token
  • code
  • id_token
  • token
このクライアントに必要な応答タイプを指定します。
id_token token
ID トークンおよびアクセス・トークン
code
許可コード
id_token
ID トークン
token
アクセス・トークン
userIdentifierstringサブジェクト内でユーザー・プリンシパル名として使用される、ID トークン内の JSON 属性を指定します。 値が指定されないと、JSON 属性 "sub" が使用されます。
groupIdentifierstringgroupIds認証済みプリンシパルをメンバーとして含むグループの名前として使用される、ID トークン内の JSON 属性を指定します。
realmIdentifierstringrealmNameレルム名として使用される、ID トークン内の JSON 属性を指定します。
uniqueUserIdentifierstringuniqueSecurityNameサブジェクト内の WSCredential に適用されたときに固有のユーザー名として使用される、ID トークン内の JSON 属性を指定します。
tokenEndpointAuthMethod
  • post
  • basic
postクライアントを認証するために資格情報を OpenID Connect プロバイダーのトークン・エンドポイントに送信するために使用する方式。
post
post
basic
basic
inboundPropagation
  • none
  • required
  • supported
noneOpenID リライング・パーティーのトークンのインバウンド伝搬の操作を制御します。
none
インバウンド・トークン伝搬をサポートしない
required
インバウンド・トークン伝搬を要求する
supported
インバウンド・トークン伝搬をサポートする
validationMethod
  • introspect
  • userinfo
introspectトークンのインバウンド伝搬での検証の方式。
introspect
トークン・イントロスペクションを使用してインバウンド・トークンを検証する
userinfo
userinfo エンドポイントを使用してインバウンド・トークンを検証する
headerNamestring要求にインバウンド・トークンを含むヘッダーの名前。
validationEndpointUrlstringトークンのインバウンド伝搬を検証するためのエンドポイント URL。 エンドポイントのタイプは、validationMethod によって決まります。
disableIssCheckingbooleanfalseインバウンド・トークン伝搬の json 応答を検証している時に、発行者についてチェックしません。
authnSessionDisabledbooleantrueインバウンド伝搬用の認証セッション Cookie は作成されません。 要求ごとにクライアントが有効な OAuth トークンを送信することが予期されます。
disableLtpaCookiebooleanfalseOAuth トークンの処理中に LTPA トークンを作成しません。 代わりに、特定のサービス・プロバイダーの Cookie を作成します。
reAuthnOnAccessTokenExpirebooleantrueユーザーの認証アクセス・トークンの有効期限が切れ、disableLtpaCookie が true に設定されている場合、再度ユーザーの認証を行います。
reAuthnCushion期間 (精度: ミリ秒)0sトークンの有効期限がもうすぐ切れるときにユーザーを再び認証する期間。 ID トークンの有効期限切れの時刻は、exp クレームによって指定されます。. 正整数の後に時間単位 (時間 (h)、分 (m)、秒 (s)、またはミリ秒 (ms)) を付けて指定してください。 例えば、500 ミリ秒は 500ms と指定します。 単一エントリーに複数の値を含めることができます。 例えば、1.5 秒の場合、1s500ms とすることができます。
authFilterRef最上位の authFilter エレメント (ストリング) の参照。認証フィルター参照を指定します。
createSessionbooleantrue現行 HttpSession が存在しない場合に HttpSession を作成するかどうかを指定します。
authenticationTimeLimit期間 (精度: ミリ秒)420s認証サーバーへのリダイレクトと、認証サーバーからのリターンの間の最大所要時間 (ミリ秒)。この時間が経過すると、Cookie の有効期限が切れます。. 正整数の後に時間単位 (時間 (h)、分 (m)、秒 (s)、またはミリ秒 (ms)) を付けて指定してください。 例えば、500 ミリ秒は 500ms と指定します。 単一エントリーに複数の値を含めることができます。 例えば、1.5 秒の場合、1s500ms とすることができます。

audiences

JSON Web トークン内の aud クレームに突き合わせて検証される、信頼できる対象者のリスト。

authFilter

認証フィルター参照を指定します。

authFilter > webApp

固有の構成 ID。

NameTypeDefaultDescription
idstring固有の構成 ID。
namestring名前を指定します。
matchType
  • contains
  • notContain
  • equals
containsマッチング・タイプを指定します。
contains
含む
notContain
含まない
equals
等しい

authFilter > requestUrl

固有の構成 ID。

NameTypeDefaultDescription
idstring固有の構成 ID。
urlPatternstringURL パターンを指定します。
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
より大
ipstringIP アドレスを指定します。

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
等しい

resource

リソース・パラメーターが要求に含まれます。