パス・スルー認証ワークフロー要素の追加、検索、比較または削除
POST
/rest/v1/admin
パス・スルー認証ワークフロー要素の追加、検索、比較または削除
リクエスト
サポートされているメディア・タイプ
- application/json
作成する必要があるパス・スルー認証ワークフロー要素
ルート・スキーマ: パス・スルー認証ワークフロー要素のPOSTRequest
型:
ソースを表示
object
- assertion(optional): string
LDAP比較操作用のアサーション文字列。注意: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
- attributes(optional): object パス・スルー認証ワークフロー要素のプロパティ
- base(optional): string
LDAP検索操作に使用する検索ベースDN。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。このような操作の場合も必須です
- controls(optional): array controls
LDAP操作のためにサーバーに送信するLDAP制御。
- dn(optional): string
作成、削除または比較するエントリのLDAP DN。注意: LDAPの追加、削除または比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest、urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequestまたはurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。このような操作の場合に必須です。
- filter(optional): string
LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。注意: POSTリクエストを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
- msgType: string
指定可能な値:
[ "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest" ]
RESTメッセージ・タイプ - requiredAttributes(optional): array requiredAttributes
エントリに対してフェッチする属性のリスト。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
- scope(optional): string
指定可能な値:
[ "base", "sub", "one" ]
LDAP検索操作の範囲。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ネストされたスキーマ: パス・スルー認証ワークフロー要素のプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-auth-provider-workflow-element: string
パス・スルー認証ワークフロー要素が取得するユーザー・エントリの認証サービスを提供するワークフロー要素を識別します。
- ds-cfg-enabled: boolean
サーバーでワークフロー要素が使用可能かどうかを示します。
- ds-cfg-java-class: string
デフォルト値:
org.opends.server.workflowelement.pta.PassThroughAuthenticationWorkflowElement
パス・スルー認証ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-password-attribute(optional): string
デフォルト値:
userPassword
ローカルにパスワードを含む属性の名前を指定します。 - ds-cfg-pta-auth-suffix(optional): string
認証プロバイダ・ワークフロー要素により公開される実際のベースDN
- ds-cfg-pta-join-rule(optional): string
ユーザー・プロバイダ・ワークフロー要素と認証プロバイダ・ワークフロー要素の間に定義された結合ルール。これは各コンポーネントの形式がauth.[attributeName]=user.[attributeName]で、AND/OR/NOTと組み合せられた複数のコンポーネントを含むLDAPFilter構文の一部です。このパラメータが設定されていない場合、PTAワークフロー要素によって、ユーザー・エントリと認証エントリのDNが同じであるとみなされます。
- ds-cfg-pta-suffix(optional): string
PTAワークフロー要素によって公開される仮想DN
- ds-cfg-pta-user-suffix(optional): string
ユーザー・プロバイダ・ワークフロー要素により公開される実際のベースDN
- ds-cfg-save-password-on-successful-bind(optional): boolean
デフォルト値:
false
認証が成功したときにパスワードをユーザー・エントリに保存するかどうかを示します。 - ds-cfg-user-provider-workflow-element: string
リクエストされたユーザー・エントリを提供するワークフロー要素を識別します。
- objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: requiredAttributes
型:
array
エントリに対してフェッチする属性のリスト。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ソースを表示
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK
ルート・スキーマ: パス・スルー認証ワークフロー要素のSuccessResponse
型:
ソースを表示
object
- compareResult(optional): boolean
LDAP比較操作の結果を示します。
- msgType: string
指定可能な値:
[ "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse" ]
RESTメッセージ・タイプ - searchResultEntries: array searchResultEntries
LDAP操作後に返される検索結果エントリの数。
- totalResults: integer(int32)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: パス・スルー認証ワークフロー要素のSearchResultEntry
型:
ソースを表示
object
- attributes: object パス・スルー認証ワークフロー要素のプロパティ
- dn: string
作成するエントリのLDAP DN。
ネストされたスキーマ: パス・スルー認証ワークフロー要素のプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-auth-provider-workflow-element: string
パス・スルー認証ワークフロー要素が取得するユーザー・エントリの認証サービスを提供するワークフロー要素を識別します。
- ds-cfg-enabled: boolean
サーバーでワークフロー要素が使用可能かどうかを示します。
- ds-cfg-java-class: string
デフォルト値:
org.opends.server.workflowelement.pta.PassThroughAuthenticationWorkflowElement
パス・スルー認証ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-password-attribute(optional): string
デフォルト値:
userPassword
ローカルにパスワードを含む属性の名前を指定します。 - ds-cfg-pta-auth-suffix(optional): string
認証プロバイダ・ワークフロー要素により公開される実際のベースDN
- ds-cfg-pta-join-rule(optional): string
ユーザー・プロバイダ・ワークフロー要素と認証プロバイダ・ワークフロー要素の間に定義された結合ルール。これは各コンポーネントの形式がauth.[attributeName]=user.[attributeName]で、AND/OR/NOTと組み合せられた複数のコンポーネントを含むLDAPFilter構文の一部です。このパラメータが設定されていない場合、PTAワークフロー要素によって、ユーザー・エントリと認証エントリのDNが同じであるとみなされます。
- ds-cfg-pta-suffix(optional): string
PTAワークフロー要素によって公開される仮想DN
- ds-cfg-pta-user-suffix(optional): string
ユーザー・プロバイダ・ワークフロー要素により公開される実際のベースDN
- ds-cfg-save-password-on-successful-bind(optional): boolean
デフォルト値:
false
認証が成功したときにパスワードをユーザー・エントリに保存するかどうかを示します。 - ds-cfg-user-provider-workflow-element: string
リクエストされたユーザー・エントリを提供するワークフロー要素を識別します。
- objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
201レスポンス
作成済
ルート・スキーマ: パス・スルー認証ワークフロー要素のADDResponse
型:
ソースを表示
object
- msgType: string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse
RESTメッセージ・タイプ - searchResultEntries: array searchResultEntries
- totalResults: integer(int32)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: パス・スルー認証ワークフロー要素のSearchResultEntry
型:
ソースを表示
object
- attributes: object パス・スルー認証ワークフロー要素のプロパティ
- dn: string
作成するエントリのLDAP DN。
ネストされたスキーマ: パス・スルー認証ワークフロー要素のプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-auth-provider-workflow-element: string
パス・スルー認証ワークフロー要素が取得するユーザー・エントリの認証サービスを提供するワークフロー要素を識別します。
- ds-cfg-enabled: boolean
サーバーでワークフロー要素が使用可能かどうかを示します。
- ds-cfg-java-class: string
デフォルト値:
org.opends.server.workflowelement.pta.PassThroughAuthenticationWorkflowElement
パス・スルー認証ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-password-attribute(optional): string
デフォルト値:
userPassword
ローカルにパスワードを含む属性の名前を指定します。 - ds-cfg-pta-auth-suffix(optional): string
認証プロバイダ・ワークフロー要素により公開される実際のベースDN
- ds-cfg-pta-join-rule(optional): string
ユーザー・プロバイダ・ワークフロー要素と認証プロバイダ・ワークフロー要素の間に定義された結合ルール。これは各コンポーネントの形式がauth.[attributeName]=user.[attributeName]で、AND/OR/NOTと組み合せられた複数のコンポーネントを含むLDAPFilter構文の一部です。このパラメータが設定されていない場合、PTAワークフロー要素によって、ユーザー・エントリと認証エントリのDNが同じであるとみなされます。
- ds-cfg-pta-suffix(optional): string
PTAワークフロー要素によって公開される仮想DN
- ds-cfg-pta-user-suffix(optional): string
ユーザー・プロバイダ・ワークフロー要素により公開される実際のベースDN
- ds-cfg-save-password-on-successful-bind(optional): boolean
デフォルト値:
false
認証が成功したときにパスワードをユーザー・エントリに保存するかどうかを示します。 - ds-cfg-user-provider-workflow-element: string
リクエストされたユーザー・エントリを提供するワークフロー要素を識別します。
- objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
204レスポンス
コンテンツがありません
406レスポンス
受入れできません
ルート・スキーマ: ErrorResponse
型:
ソースを表示
object
- ldapErrorCode(optional): integer(int32)
操作に対して返されるLDAPエラー・コードを指定します。
- message: string
操作に対して返されるエラー・メッセージ。
- msgType: string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse
RESTメッセージ・タイプ