RESTサーバー拡張機能の追加、検索、比較または削除
POST
/rest/v1/admin
RESTサーバー拡張機能の追加、検索、比較または削除
リクエスト
サポートされているメディア・タイプ
- application/json
作成する必要があるRESTサーバー拡張機能
ルート・スキーマ: RESTサーバー拡張機能のPOSTRequest
型:
ソースを表示
object
- assertion(optional): string
LDAP比較操作用のアサーション文字列。注意: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
- attributes(optional): object RESTサーバー拡張機能のプロパティ
- 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である場合)にのみ使用します。
ネストされたスキーマ: RESTサーバー拡張機能のプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-allow-entry-return(optional): boolean
デフォルト値:
true
ADD、ModifyおよびModifyDN操作の成功後にエントリを返せるようにします。 - ds-cfg-context-path(optional): string
すべてのRESTfulサービスに使用されるHTTPコンテキストを指定します
- ds-cfg-enabled: boolean
拡張機能が使用可能かどうかを示します。
- ds-cfg-end-point(optional): array ds-cfg-end-point
RESTサーバー拡張機能を通じて使用可能になるHTTPエンド・ポイント。
- ds-cfg-http-authentication-scheme(optional): array ds-cfg-http-authentication-scheme
HTTPを介してRESTクライアントからのリクエストを受け入れるときに使用される認証スキームのタイプ。
- ds-cfg-java-class: string
デフォルト値:
com.oracle.rest.RESTServerExtension
RESTサーバー拡張機能の実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-lock-timeout(optional): string
デフォルト値:
60000.0ms
LDAPサーバー・ワーカー・スレッドからのレスポンスを待機している間の待機時間を指定します。 - ds-cfg-skip-auth-context-path(optional): array ds-cfg-skip-auth-context-path
認証をスキップできるコンテキスト・パスを1つ以上指定します。
- ds-cfg-token-validity-period(optional): string
デフォルト値:
1d
生成されたJWTベアラー・トークンが無効になった後の時間間隔を指定します。 - ds-cfg-trust-manager-provider(optional): string
デフォルト値:
JKS
RESTサーバー拡張機能でOAuth 2.0ベアラー・トークンを生成または検証するために使用する信頼マネージャ・プロバイダを指定します。 - objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: requiredAttributes
型:
array
エントリに対してフェッチする属性のリスト。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ソースを表示
ネストされたスキーマ: ds-cfg-http-authentication-scheme
型:
array
HTTPを介してRESTクライアントからのリクエストを受け入れるときに使用される認証スキームのタイプ。
デフォルト値:
[ "basic", "bearer" ]
指定可能な値:
ソースを表示
[ "anonymous", "basic", "bearer", "client-cert" ]
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK
ルート・スキーマ: RESTサーバー拡張機能の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)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: RESTサーバー拡張機能のSearchResultEntry
型:
ソースを表示
object
- attributes: object RESTサーバー拡張機能のプロパティ
- dn: string
作成するエントリのLDAP DN。
ネストされたスキーマ: RESTサーバー拡張機能のプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-allow-entry-return(optional): boolean
デフォルト値:
true
ADD、ModifyおよびModifyDN操作の成功後にエントリを返せるようにします。 - ds-cfg-context-path(optional): string
すべてのRESTfulサービスに使用されるHTTPコンテキストを指定します
- ds-cfg-enabled: boolean
拡張機能が使用可能かどうかを示します。
- ds-cfg-end-point(optional): array ds-cfg-end-point
RESTサーバー拡張機能を通じて使用可能になるHTTPエンド・ポイント。
- ds-cfg-http-authentication-scheme(optional): array ds-cfg-http-authentication-scheme
HTTPを介してRESTクライアントからのリクエストを受け入れるときに使用される認証スキームのタイプ。
- ds-cfg-java-class: string
デフォルト値:
com.oracle.rest.RESTServerExtension
RESTサーバー拡張機能の実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-lock-timeout(optional): string
デフォルト値:
60000.0ms
LDAPサーバー・ワーカー・スレッドからのレスポンスを待機している間の待機時間を指定します。 - ds-cfg-skip-auth-context-path(optional): array ds-cfg-skip-auth-context-path
認証をスキップできるコンテキスト・パスを1つ以上指定します。
- ds-cfg-token-validity-period(optional): string
デフォルト値:
1d
生成されたJWTベアラー・トークンが無効になった後の時間間隔を指定します。 - ds-cfg-trust-manager-provider(optional): string
デフォルト値:
JKS
RESTサーバー拡張機能でOAuth 2.0ベアラー・トークンを生成または検証するために使用する信頼マネージャ・プロバイダを指定します。 - objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: ds-cfg-http-authentication-scheme
型:
array
HTTPを介してRESTクライアントからのリクエストを受け入れるときに使用される認証スキームのタイプ。
デフォルト値:
[ "basic", "bearer" ]
指定可能な値:
ソースを表示
[ "anonymous", "basic", "bearer", "client-cert" ]
201レスポンス
作成済
ルート・スキーマ: RESTサーバー拡張機能のADDResponse
型:
ソースを表示
object
- msgType: string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse
RESTメッセージ・タイプ - searchResultEntries: array searchResultEntries
- totalResults: integer(int32)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: RESTサーバー拡張機能のSearchResultEntry
型:
ソースを表示
object
- attributes: object RESTサーバー拡張機能のプロパティ
- dn: string
作成するエントリのLDAP DN。
ネストされたスキーマ: RESTサーバー拡張機能のプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-allow-entry-return(optional): boolean
デフォルト値:
true
ADD、ModifyおよびModifyDN操作の成功後にエントリを返せるようにします。 - ds-cfg-context-path(optional): string
すべてのRESTfulサービスに使用されるHTTPコンテキストを指定します
- ds-cfg-enabled: boolean
拡張機能が使用可能かどうかを示します。
- ds-cfg-end-point(optional): array ds-cfg-end-point
RESTサーバー拡張機能を通じて使用可能になるHTTPエンド・ポイント。
- ds-cfg-http-authentication-scheme(optional): array ds-cfg-http-authentication-scheme
HTTPを介してRESTクライアントからのリクエストを受け入れるときに使用される認証スキームのタイプ。
- ds-cfg-java-class: string
デフォルト値:
com.oracle.rest.RESTServerExtension
RESTサーバー拡張機能の実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-lock-timeout(optional): string
デフォルト値:
60000.0ms
LDAPサーバー・ワーカー・スレッドからのレスポンスを待機している間の待機時間を指定します。 - ds-cfg-skip-auth-context-path(optional): array ds-cfg-skip-auth-context-path
認証をスキップできるコンテキスト・パスを1つ以上指定します。
- ds-cfg-token-validity-period(optional): string
デフォルト値:
1d
生成されたJWTベアラー・トークンが無効になった後の時間間隔を指定します。 - ds-cfg-trust-manager-provider(optional): string
デフォルト値:
JKS
RESTサーバー拡張機能でOAuth 2.0ベアラー・トークンを生成または検証するために使用する信頼マネージャ・プロバイダを指定します。 - objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: ds-cfg-http-authentication-scheme
型:
array
HTTPを介してRESTクライアントからのリクエストを受け入れるときに使用される認証スキームのタイプ。
デフォルト値:
[ "basic", "bearer" ]
指定可能な値:
ソースを表示
[ "anonymous", "basic", "bearer", "client-cert" ]
204レスポンス
コンテンツがありません
406レスポンス
受入れできません
ルート・スキーマ: ErrorResponse
型:
ソースを表示
object
- ldapErrorCode(optional): integer(int32)
操作に対して返されるLDAPエラー・コードを指定します。
- message: string
操作に対して返されるエラー・メッセージ。
- msgType: string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse
RESTメッセージ・タイプ