0日目構成の作成
post
/radius-config/v1/init
管理者は、グローバルまたはアプリケーション・スコープの構成、およびRADIUS管理者ユーザーまたはグループを作成して、最初の0日目構成をOracle RADIUS Agentに初めてシードできます。グローバル構成は複数のRADIUSクライアント間で共有され、アプリケーション・スコープの構成は特定のRADIUSクライアント・アプリケーションに制限されます。このAPIは保護されておらず、必要なOAA構成が指定されている場合は、OAAで初期関連付けを行う初期構成をシードするために1回のみ使用されます。0日目の後のREST APIコールには、RADIUS管理者資格証明が必要です。
リクエスト
この操作にはリクエスト・パラメータはありません。
サポートされているメディア・タイプ
- application/json
0日目構成の詳細
ルート・スキーマ: schema
型:
ソースを表示
object
-
application: object application
RADIUSクライアント構成詳細
-
authentication: object authentication
グローバル・プライマリ認証構成詳細
-
logging: object logging
ロギングの詳細
-
mfa: object mfa
グローバル・マルチファクタ認証構成詳細
-
preferences: object preferences
グローバル・プリファレンス構成詳細
-
radiusAdminGroup(必須): array radiusAdminGroup
Oracle RADIUS Agentの構成およびRADIUSクライアントを管理するためのディレクトリに存在する管理グループのリスト。これは0日目では必須、それ以外ではオプションです
-
radiusAdminUser(必須): array radiusAdminUser
Oracle RADIUS Agentの構成およびRADIUSクライアントを管理するためのディレクトリに存在する管理ユーザーのリスト。これは0日目では必須、それ以外ではオプションです
-
radiusListener: object radiusListener
グローバルRADIUSリスナー構成詳細
-
server: object server
サーバー構成詳細
ネストされたスキーマ: application
型:
object
RADIUSクライアント構成詳細
ネストされたスキーマ: authentication
型:
object
グローバル・プライマリ認証構成詳細
ソースを表示
-
custom: object custom
カスタム・オーセンティケータ構成の詳細
-
ldap: object ldap
LDAP構成の詳細
-
provider(必須): string
デフォルト値:
LDAP
構成された認証プロバイダ・タイプ -
userCacheCleanupInitialDelay: integer (int64)
デフォルト値:
0L
ユーザー・キャッシュ・クリーンアップ・スレッドが起動するまでのクリーンアップの初期遅延 -
userCacheCleanupInterval: integer (int64)
デフォルト値:
300000L
ユーザー・キャッシュ・クリーンアップ間隔 -
userCacheCleanupPoolSize: integer (int32)
デフォルト値:
1
ユーザー・キャッシュ・クリーンアップ・スレッドのプール・サイズ -
userCacheConcurrencyLevel: integer (int32)
デフォルト値:
4
ユーザー・キャッシュの同時実行レベル -
userCacheEntryTimeout: integer (int64)
デフォルト値:
300000L
ユーザー・キャッシュのエントリ・タイムアウト値(ミリ秒)
ネストされたスキーマ: logging
型:
object
ロギングの詳細
ネストされたスキーマ: mfa
型:
object
グローバル・マルチファクタ認証構成詳細
ソースを表示
-
oaa(必須): object oaa
OAA構成詳細
-
provider(必須): string
デフォルト値:
OAA
プロバイダ名
ネストされたスキーマ: preferences
型:
object
グローバル・プリファレンス構成詳細
ソースを表示
-
allowSpecificFactorInPassword: boolean
デフォルト値:
false
エンドユーザーによる特定のファクタの直接起動が有効かどうかを示します -
allowTokenInPassword: boolean
デフォルト値:
true
同期ログイン・モード(パスワード、デリミタ、トークン連結)が有効/無効かどうかを示します -
appendDelimiter: string
デフォルト値:
;
同期モードに使用されるデリミタ(パスワード+デリミタ+トークン)例:password;123456
-
defaultSecondFactor: string
デフォルト値:
ChallengeOMATOTP
デフォルトの第2ファクタ。このファクタは、ユーザーがOAAのユーザー・プリファレンスから使用できる優先ファクタがなく、RADIUSリクエストで同期モードが使用されている場合に使用されます -
defaultTokenLength: integer (int32)
デフォルト値:
6
同期ログイン・モードのトークンの長さ。これは、構成されたDefaultSecondFactorのトークンの長さを表します -
factorToTokenLengthMap: object factorToTokenLengthMap
RADIUSファクタからファクタ・トークンの長さへのマッピング
-
groupAsSingleString: boolean
デフォルト値:
false
trueの場合は、レスポンスで、グループの詳細を構成されているデリミタで区切られた単一の文字列として返します -
groupAsSingleStringDelimiter: string
デフォルト値:
,
グループが単一文字列として返されるときに使用されるデリミタ -
groupAttrID: integer (int32)
デフォルト値:
1 (ORACLEの場合)
グループ・マッピングのRADIUS属性ID。グループはこのRADIUS属性の一部として返されます -
groupAttrVendorID: integer (int32)
デフォルト値:
111 (ORACLE_ROLE属性の場合)
グループ・マッピングのRADIUSベンダーID。グループはこのRADIUS属性の一部として返されます。RADIUSベンダーID 111はOracleを表し、標準のRADIUS属性を使用するには、値-1を使用する必要があります -
groupNameMapping: object groupNameMapping
プライマリ・オーセンティケータのグループ名を別の値にマップするためのマッピング
-
mfaOptions: object mfaOptions
"assuranceLevel"、"factorChoices" (ORAおよびOAAの自動関連付け用)、"defaultGroup" (OAAに渡されるデフォルト・グループ名の設定用)など、OAAプロバイダ固有の追加オプション
-
radiusFactorToMFAFactorMap: object radiusFactorToMFAFactorMap
RadiusAgentのファクタからMFAプロバイダのファクタへのマッピング。これらのキーワードを使用して、MFAの特定のファクタを起動できます
-
returnGroups: boolean
デフォルト値:
false
認証中にグループを返す必要があるかどうかを示します例:true/false
-
userAttrMap: array userAttrMap
プライマリ・オーセンティケータから、認証時に返される指定されたRADIUS属性へのユーザー属性のマッピングを表します
ネストされたスキーマ: radiusAdminGroup
型:
array
Oracle RADIUS Agentの構成およびRADIUSクライアントを管理するためのディレクトリに存在する管理グループのリスト。これは0日目では必須、それ以外ではオプションです
ソースを表示
例:
[ "cn=group1,ou=groups,dc=example,dc=com","cn=group2,ou=groups,dc=example,dc=com" ]
OR
[ "group1"," + "group2" ]
ネストされたスキーマ: radiusAdminUser
型:
array
Oracle RADIUS Agentの構成およびRADIUSクライアントを管理するためのディレクトリに存在する管理ユーザーのリスト。これは0日目では必須、それ以外ではオプションです
ソースを表示
例:
[ "cn=radiusAdminUser,ou=people,dc=example,dc=com","cn=adminUser,ou=people,dc=example,dc=com" ]
OR
[ "radiusAdminUser"," + "adminUser" ]
ネストされたスキーマ: radiusListener
型:
object
グローバルRADIUSリスナー構成詳細
ソースを表示
-
channelSelectTimeout: integer (int64)
デフォルト値:
120000
UDP NIOチャネル選択タイムアウト(ミリ秒) -
coreThreadPoolSize: integer (int32)
デフォルト値:
10
ワーカー・スレッドの基礎となるThreadPoolExecutorのCorePoolSize値 -
numberOfWorkerThreads: integer (int32)
デフォルト値:
20
構成されたワーカー・スレッドの数、ワーカー・スレッドの基礎となるThreadPoolExecutorの最大PoolSize値 -
requestCacheCleanupInitialDelay: integer (int64)
デフォルト値:
0
リクエスト・キャッシュ・クリーンアップ・スレッドの初期遅延 -
requestCacheCleanupInterval: integer (int64)
デフォルト値:
60000
リクエスト・キャッシュ・クリーンアップ・スレッドの間隔 -
requestCacheCleanupPoolSize: integer (int32)
デフォルト値:
0
リクエスト・キャッシュ・クリーンアップ・スレッドのプール・サイズ -
requestCacheConcurrencyLevel: integer (int32)
デフォルト値:
6
リクエスト・キャッシュの同時実行レベル -
requestCacheEntryTimeout: integer (int64)
デフォルト値:
30000
リクエスト・キャッシュのエントリ・タイムアウト値(ミリ秒) -
socketSOTimeout: integer (int32)
デフォルト値:
1800000
基礎となるソケットSOタイムアウト(ミリ秒) -
threadPoolKeepAliveTime: integer (int64)
デフォルト値:
10000
ワーカー・スレッドの基礎となるThreadPoolExecutorのスレッド・プールのキープ・アライブ時間 -
threadPoolMaxQueueSize: integer (int32)
デフォルト値:
0
ワーカー・スレッドのThreadPoolExecutorで使用される基礎となるキューの最大許容キュー・サイズ値
ネストされたスキーマ: server
型:
object
サーバー構成詳細
ソースを表示
-
customDictionary: string
ベンダー固有属性の定義を含むカスタムRADIUS辞書ファイル
-
customDictionaryAsStream: array customDictionaryAsStream
ストリームとしてのカスタム辞書ファイル
-
customDictionaryFileAsStream: array customDictionaryFileAsStream
-
enableDynamicClients: boolean
デフォルト値:
false
動的クライアントが許可されているかどうかを示します -
enableMetrics: boolean
デフォルト値:
true
メトリックが有効かどうかを示します -
heartBeatInterval: integer (int32)
デフォルト値:
120000
LDAPのようなオーセンティケータの可用性をチェックするために構成されたハートビート・スレッドの起動間隔(ミリ秒) -
stateCacheConcurrencyLevel: integer (int32)
デフォルト値:
6
状態属性キャッシュの同時実行レベル -
stateCacheEntryTimeout: integer (int64)
デフォルト値:
120000
状態属性キャッシュのエントリ・タイムアウト -
validatedTokenCacheConcurrencyLevel: integer (int32)
デフォルト値:
6
検証されたMFAトークン・キャッシュの同時実行レベル -
validatedTokenCacheEntryTimeout: integer (int64)
デフォルト値:
60000
検証されたMFAトークン・キャッシュのエントリ・タイムアウト
ネストされたスキーマ: custom
型:
object
カスタム・オーセンティケータ構成の詳細
ソースを表示
-
className: string
カスタム認証プロバイダ・クラス名
-
enabled(必須): boolean
デフォルト値:
true
これが有効かどうかを示すフラグ -
jarsLocation: string
カスタム・プロバイダのjarsディレクトリを取得します
-
name(必須): string
構成の名前例:
<プロバイダの名前>
-
properties: object properties
定義済プロパティ
-
retryCount: integer (int32)
デフォルト値:
1
構成されていて、値が0より大きい場合は、接続に失敗した場合に、構成された回数だけ操作が再試行されることを示します。値が0の場合は、再試行をオフにできます -
retryInterval: integer (int64)
デフォルト値:
0
再試行回数が1を超える場合は、2回の再試行の間隔(ミリ秒) -
unrecognizedFields: object unrecognizedFields
読取り専用:
true
ネストされたスキーマ: ldap
型:
object
LDAP構成の詳細
ソースを表示
-
authWithoutMFACriteria: string
このフィルタに基づき、ユーザー・フットプリントがMFAに存在しない場合のみ、一致するユーザーはプライマリ・ファクタを使用してログインできます
-
baseDN(必須): string
RADIUSエージェントがユーザーおよびグループを検索するために使用するLDAPドメインのベースDN例:
dc=example,dc=com
-
cipherSuites: array cipherSuites
即時利用可能なデフォルトの暗号スイート
-
connectTimeout: integer (int64)
デフォルト値:
5000
その時間内にLDAP接続を確立する必要がある時間制限(ミリ秒) -
dn(必須): string
RADIUSエージェントがLDAPサーバーへの接続に使用するユーザーのDN例:
cn=Directory Manager
-
enabled(必須): boolean
デフォルト値:
true
これが有効かどうかを示すフラグ -
enableMemberOfQuery: boolean
デフォルト値:
false
バックエンドLDAPサーバーによって解決されるグループ・メンバーシップに依存するmemberof検索を有効にします。OID/OUDではネストされたグループ/動的グループが直接メンバーシップとともに返されますが、ADではユーザーの直接メンバーシップのみが返されます -
groupNamingAttribute: string
デフォルト値:
cn
LDAP内のグループのネーミング属性 -
initSize: integer (int32)
デフォルト値:
5
このプロパティは、接続プールの初期化時に作成される接続の数を示します -
keyFactorAlgorithm: string
デフォルト値:
RSA
証明書の署名に使用されているアルゴリズム -
keystore: string
SSL相互認証に使用されるキーストア・ファイルの場所
-
keystoreCertificateAliasName: string
キーストアJKSの証明書を参照するために使用される別名
-
keystorePassword: string
キーストア・ファイルのパスワード
-
keystoreTruststoreType: string
ファイル・ベースのトラストストア/キーストアを使用する場合のファイル・タイプ(JKS/PKCS12)。nullの場合は、証明書自体が指定されていることを意味します
-
ldapUrl(必須): string
LDAPサーバーのURL例:
ldaps://<hostname>:<port>
-
loginAttr: string
デフォルト値:
uid
ユーザーのLDAPでのログイン属性名。これは、ログイン時にユーザーを検索するためのフィルタを作成するために使用されます -
maxGroupsToFetch: integer (int32)
デフォルト値:
0
検索の結果として返されるエントリの最大数を設定します。0の値は、制限がないことを示します。(ノート: これは、グループ・メンバーシップ問合せがORAによって構築された場合のみに適用され、memberof問合せには適用されません) -
maxNestedLevels: integer (int32)
デフォルト値:
10
ネストされたグループが構成されている場合、特定のユーザーがメンバーとなっているグループを検索するには最大深度検索を実行する必要があります。(ノート: これは、グループ・メンバーシップ問合せがORAによって構築された場合のみに適用され、memberof問合せには適用されません) -
maxSize: integer (int32)
デフォルト値:
100
プールが保持する接続の最大数。minSizeがmaxSizeより大きい場合、minSizeはmaxSizeに設定されます -
memberAttr: string
グループ関連問合せに使用されるLDAP属性名。指定しない場合は、uniquememberおよびmemberが使用されます。ADの場合、ネストされたグループ検索が機能するためには、値として'member'を指定する必要があります例:
member
-
memberFilteringCriteria: string
グループ検索の追加のフィルタリング条件。この条件は、グループ・メンバーシップ問合せフィルタとAND処理されます。例: ADの場合、ネストされたグループ検索が機能するためには(objectclass=group)を指定する必要があります例:
objectclass=group
-
memberOfAttribute: string
デフォルト値:
memberof
ユーザーがメンバーになっているグループを返す属性。OUDはismemberof、ADはMemberofと連携し、OIDはmemberofとismemberofの両方をサポートします -
minSize: integer (int32)
デフォルト値:
5
プールが保持する接続の最小数。initSizeがminSizeより小さい場合、接続プールはminSize接続で初期化されます -
name(必須): string
構成の名前例:
<プロバイダの名前>
-
password(必須): string
RADIUSエージェントがLDAPサーバーへの接続に使用するユーザーのパスワード例:
<パスワード>
-
poolIncrementSize: integer (int32)
デフォルト値:
5
すべての既存の接続が使用中であり、接続数がmaxSize未満であるときに確立される接続の数 -
poolMaintenanceInterval: integer (int64)
デフォルト値:
600000
メンテナンス・スレッドが実行される時間間隔(ミリ秒) -
poolMaxConnectionIdleTime: integer (int64)
デフォルト値:
1500000
アイドル接続が失効するまでの時間(ミリ秒) -
poolMaxConnectionReuseTime: integer (int64)
デフォルト値:
-1 (時間の制限なし)
接続が失効するまでの時間(ミリ秒) -
poolMaxWaitTime: integer (int64)
デフォルト値:
20000
LDAP接続が使用可能になるまでクライアントが待機する時間の制限(ミリ秒) -
properties: object properties
読取り専用:
true
-
readTimeout: integer (int64)
デフォルト値:
30000
RADIUSエージェントがLDAPサーバーの応答を待機する時間の制限(ミリ秒) -
referral: string
デフォルト値:
follow
LDAPサーバーによって参照が返されるときの動作を指定します。使用可能な値については、JNDI java.naming.referralを確認してください。 -
retryCount: integer (int32)
デフォルト値:
1
構成されていて、値が0より大きい場合は、接続に失敗した場合に、構成された回数だけ操作が再試行されることを示します。値が0の場合は、再試行をオフにできます -
retryInterval: integer (int64)
デフォルト値:
0
再試行回数が1を超える場合は、2回の再試行の間隔(ミリ秒) -
reuseAddress: boolean
デフォルト値:
true
TIME_WAIT状態の場合でもポートを再利用します -
searchTimeout: integer (int32)
デフォルト値:
30000
LDAP検索の時間制限(ミリ秒) -
searchUserBeforeBind: boolean
デフォルト値:
true
ユーザー・ログインを開始する前に、LDAPサーバーのユーザーを参照してそのDNを取得します。これは、LDAPサーバーがマップされたIDを使用した直接バインド(たとえば、OUDのIDマッパー、Active DirectoryのUPNバインドなど)をサポートする場合は無効にできます -
soKeepAlive: boolean
デフォルト値:
true
ソケット接続のキープ・アライブ・プローブを有効にします -
soTimeout: integer (int32)
デフォルト値:
0
データ待機中のソケット・タイムアウトをミリ秒単位で定義します。値が0の場合、タイムアウトはありません -
sslProtocol: string
デフォルト値:
TLSv1.3, TLSv1.2
RADIUSエージェントがLDAPサーバーに接続してセキュアな接続を行うために使用する暗号プロトコル。複数のプロトコルをカンマで区切って指定できます -
tcpNoDelay: boolean
デフォルト値:
false
可能であればすぐにデータを送信します -
trustedCertificate: string
Base 64形式の信頼できる証明書例:
BASE 64 FORMAT
-
trustedCertificateAliasName: string
デフォルト値:
ldap-server-trusted-cert
JKSで信頼できる証明書を参照するために使用する別名例:ldap-server-cert
-
truststore: string
証明書にJKSファイルを使用する場合のトラストストア・ファイルの場所
-
truststorePassword: string
トラストストアのパスワード。これはオプションであり、trustedCertificateのかわりにトラストストアを使用する場合に指定する必要があります例:
<パスワード>
-
userFilteringCriteria: string
ユーザーを検索するための追加のフィルタリング条件。指定すると、このフィルタにloginAttrが追加されます(AND条件を使用)
ネストされたスキーマ: properties
型:
object
定義済プロパティ
ネストされたスキーマ: unrecognizedFields
型:
object
読取り専用:
true
ネストされたスキーマ: properties
型:
object
読取り専用:
true
ネストされたスキーマ: oaa
型:
object
OAA構成詳細
ソースを表示
-
agentgid: string
登録済RADIUS AgentのOAAでのエージェントID例:
agent1
-
clientId(必須): string
RADIUSエージェントの登録済エージェントのOAAでのクライアントID例:
clientId1
-
clientSecret(必須): string
RADIUS Agentの登録済エージェントのOAAでのクライアント・シークレット例:
secret1
-
clientType(必須): string
デフォルト値:
radius
RADIUSエージェントのOAAで使用されるクライアント・タイプ -
connectTimeout: integer (int32)
デフォルト値:
2000
OAA API接続タイムアウト(ミリ秒) -
enabled(必須): boolean
デフォルト値:
true
これが有効かどうかを示すフラグ -
name(必須): string
構成の名前例:
<プロバイダの名前>
-
oaaPolicyUrl: string
OAAポリシーURL例:
https://100.102.48.163:31223/oaa-policy
-
oaaUrl(必須): string
OAAサービス・ベースURI例:
https://127.0.0.1:37001/oaa/runtime
-
policyUserName: string
OAAポリシー・ユーザー名例:
oaa20210128t000000-oaa-policy
-
policyUserPassword: string
OAAポリシー・パスワード例:
oaaPolicyPassword1
-
properties: object properties
読取り専用:
true
-
readTimeout: integer (int32)
デフォルト値:
10000
OAA API読取りタイムアウト(ミリ秒) -
retryCount: integer (int32)
デフォルト値:
1
構成されていて、値が0より大きい場合は、接続に失敗した場合に、構成された回数だけ操作が再試行されることを示します。値が0の場合は、再試行をオフにできます -
retryInterval: integer (int64)
デフォルト値:
0
再試行回数が1を超える場合は、2回の再試行の間隔(ミリ秒) -
timeToLiveInMs: integer (int64)
デフォルト値:
300000
ファクタ・トークンの存続時間(ミリ秒)
ネストされたスキーマ: properties
型:
object
読取り専用:
true
ネストされたスキーマ: factorToTokenLengthMap
型:
object
RADIUSファクタからファクタ・トークンの長さへのマッピング
デフォルト値:
{"ChallengeOMATOTP": 6, "ChallengeYubicoOTP": 44}
ネストされたスキーマ: groupNameMapping
型:
object
プライマリ・オーセンティケータのグループ名を別の値にマップするためのマッピング
例:
{"group1":"ORA_GRP_1", "group2":"ORA_GRP_2"}
ネストされたスキーマ: mfaOptions
型:
object
"assuranceLevel"、"factorChoices" (ORAおよびOAAの自動関連付け用)、"defaultGroup" (OAAに渡されるデフォルト・グループ名の設定用)など、OAAプロバイダ固有の追加オプション
デフォルト値:
"defaultGroup": "Default"
例:
"assuranceLevel": "Rad_CP0_%RNDM1%"
ネストされたスキーマ: radiusFactorToMFAFactorMap
型:
object
RadiusAgentのファクタからMFAプロバイダのファクタへのマッピング。これらのキーワードを使用して、MFAの特定のファクタを起動できます
デフォルト値:
{"totp": "ChallengeOMATOTP", "yubikey": "ChallengeYubicoOTP", "sms": "ChallengeSMS", "mail": "ChallengeEmail"}
ネストされたスキーマ: userAttrMap
型:
array
プライマリ・オーセンティケータから、認証時に返される指定されたRADIUS属性へのユーザー属性のマッピングを表します
ソースを表示
例:
{"userAttrVendorID": 111, "userAttrName": "cn"}
ネストされたスキーマ: UserAttrMapping
型:
ソースを表示
object
-
attrId: integer (int32)
マップされたRADIUSユーザー属性の属性ID例:
2
-
attrName: string
プライマリ・オーセンティケータのユーザー属性名例:
cn
-
vendorId: integer (int32)
マップされたRADIUSユーザー属性に関連付けられたベンダーID例:
111
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
初期構成は正常に追加されました。
400レスポンス
不正なリクエストです
ルート・スキーマ: ResponseMessage
型:
ソースを表示
object
-
details: string
発生したエラーの詳細例:
エラーの原因に関する詳細なメッセージ。
-
errorCode: string
発生したエラーのエラー・コード例:
IRA-00001
-
message: string
成功/エラーのメッセージ例:
構成は正常に更新されました。
-
timestamp: string (date)
成功/エラーが発生したタイムスタンプ例:
2021-03-01T15:08:40.933Z[UTC]
409レスポンス
初期構成はOracle RADIUS Agentにすでに存在します。
ルート・スキーマ: ResponseMessage
型:
ソースを表示
object
-
details: string
発生したエラーの詳細例:
エラーの原因に関する詳細なメッセージ。
-
errorCode: string
発生したエラーのエラー・コード例:
IRA-00001
-
message: string
成功/エラーのメッセージ例:
構成は正常に更新されました。
-
timestamp: string (date)
成功/エラーが発生したタイムスタンプ例:
2021-03-01T15:08:40.933Z[UTC]