ユーザー定義の仮想属性の追加、検索、比較または削除
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-attribute-type: string
仮想属性によって値が動的に割り当てられる属性の属性タイプを指定します。
- ds-cfg-base-dn(optional): array ds-cfg-base-dn
この仮想属性の使用に適したエントリが含まれている分岐のベースDNを指定します。
- ds-cfg-conflict-behavior(optional): string
デフォルト値:
real-overrides-virtual
指定可能な値:[ "merge-real-and-virtual", "real-overrides-virtual", "virtual-overrides-real" ]
エントリに関連した属性の実値が1つまたは複数格納されている場合のサーバーの動作を指定します。 - ds-cfg-enabled: boolean
仮想属性が使用可能かどうかを示します。
- ds-cfg-filter(optional): array ds-cfg-filter
これらのエントリに対して仮想属性を生成するかどうかを決定するために、エントリに適用される検索フィルタを指定します。
- ds-cfg-group-dn(optional): array ds-cfg-group-dn
この仮想属性の使用に適したメンバーを持つグループのDNを入力します。
- ds-cfg-java-class: string
デフォルト値:
org.opends.server.extensions.UserDefinedVirtualAttributeProvider
属性値を生成する仮想属性プロバイダ・クラスの完全修飾名を指定します。 - ds-cfg-value: array ds-cfg-value
仮想属性に組み込む値を指定します。
- objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: requiredAttributes
型:
array
エントリに対してフェッチする属性のリスト。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ソースを表示
ネストされたスキーマ: ds-cfg-filter
型:
array
これらのエントリに対して仮想属性を生成するかどうかを決定するために、エントリに適用される検索フィルタを指定します。
デフォルト値:
ソースを表示
[ "(objectClass=*)" ]
レスポンス
サポートされているメディア・タイプ
- 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-attribute-type: string
仮想属性によって値が動的に割り当てられる属性の属性タイプを指定します。
- ds-cfg-base-dn(optional): array ds-cfg-base-dn
この仮想属性の使用に適したエントリが含まれている分岐のベースDNを指定します。
- ds-cfg-conflict-behavior(optional): string
デフォルト値:
real-overrides-virtual
指定可能な値:[ "merge-real-and-virtual", "real-overrides-virtual", "virtual-overrides-real" ]
エントリに関連した属性の実値が1つまたは複数格納されている場合のサーバーの動作を指定します。 - ds-cfg-enabled: boolean
仮想属性が使用可能かどうかを示します。
- ds-cfg-filter(optional): array ds-cfg-filter
これらのエントリに対して仮想属性を生成するかどうかを決定するために、エントリに適用される検索フィルタを指定します。
- ds-cfg-group-dn(optional): array ds-cfg-group-dn
この仮想属性の使用に適したメンバーを持つグループのDNを入力します。
- ds-cfg-java-class: string
デフォルト値:
org.opends.server.extensions.UserDefinedVirtualAttributeProvider
属性値を生成する仮想属性プロバイダ・クラスの完全修飾名を指定します。 - ds-cfg-value: array ds-cfg-value
仮想属性に組み込む値を指定します。
- objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: ds-cfg-filter
型:
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-attribute-type: string
仮想属性によって値が動的に割り当てられる属性の属性タイプを指定します。
- ds-cfg-base-dn(optional): array ds-cfg-base-dn
この仮想属性の使用に適したエントリが含まれている分岐のベースDNを指定します。
- ds-cfg-conflict-behavior(optional): string
デフォルト値:
real-overrides-virtual
指定可能な値:[ "merge-real-and-virtual", "real-overrides-virtual", "virtual-overrides-real" ]
エントリに関連した属性の実値が1つまたは複数格納されている場合のサーバーの動作を指定します。 - ds-cfg-enabled: boolean
仮想属性が使用可能かどうかを示します。
- ds-cfg-filter(optional): array ds-cfg-filter
これらのエントリに対して仮想属性を生成するかどうかを決定するために、エントリに適用される検索フィルタを指定します。
- ds-cfg-group-dn(optional): array ds-cfg-group-dn
この仮想属性の使用に適したメンバーを持つグループのDNを入力します。
- ds-cfg-java-class: string
デフォルト値:
org.opends.server.extensions.UserDefinedVirtualAttributeProvider
属性値を生成する仮想属性プロバイダ・クラスの完全修飾名を指定します。 - ds-cfg-value: array ds-cfg-value
仮想属性に組み込む値を指定します。
- objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: ds-cfg-filter
型:
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メッセージ・タイプ