ジャンプ先

• リクエスト
• レスポンス

DNによるDseeゲートウェイ・プラグインの検索

GET

/rest/v1/admin/{dn}

DNによってDseeゲートウェイ・プラグインを返します

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• dn: string
  フェッチするエントリのLDAP DN。

問合せパラメータ

• attributes: array
  コレクション形式: multi

  エントリに対してフェッチする属性のリスト。

  • [0]: string

  {
      "name":"attributes",
      "in":"query",
      "description":"List of attributes to be fetched for the entry.",
      "type":"array",
      "collectionFormat":"multi",
      "items":{
          "type":"string"
      }
  }

• controls: array
  コレクション形式: multi

  検索操作のためにサーバーに送信するLDAP制御。

  • [0]: string

  {
      "name":"controls",
      "in":"query",
      "description":"LDAP controls to be sent to server for search operation.",
      "type":"array",
      "collectionFormat":"multi",
      "items":{
          "type":"string"
      }
  }

• filter: string
  LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。
• scope: string
  LDAP検索操作の範囲。

  指定可能な値: [ "base", "sub", "one" ]

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: Dseeゲートウェイ・プラグインのGetSuccessResponse

型: object

ソースを表示

• msgType: string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse

  RESTメッセージ・タイプ
• searchResultEntries: array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• totalResults: integer(int32)
  作成され、返されるエントリの数を指定します。

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "description":"Number of search result entries returned after the LDAP operation.",
            "items":{
                "$ref":"#/definitions/Dsee Gateway Plugin SearchResultEntry"
            }
        }
    }
}

ネストされたスキーマ: searchResultEntries

型: array

LDAP操作後に返される検索結果エントリの数。

ソースを表示

• [0]: object Dseeゲートウェイ・プラグインのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Dsee Gateway Plugin SearchResultEntry"
    }
}

ネストされたスキーマ: Dseeゲートウェイ・プラグインのSearchResultEntry

型: object

ソースを表示

• attributes: object Dseeゲートウェイ・プラグインのプロパティ
• dn: string
  作成するエントリのLDAP DN。

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Dsee Gateway Plugin Properties"
        }
    }
}

ネストされたスキーマ: Dseeゲートウェイ・プラグインのプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-dsee-specific-attribute-types(optional): array ds-cfg-dsee-specific-attribute-types
  ODSEEサーバー固有であり、Oracle Unified Directoryサーバーに伝播しない属性。
• ds-cfg-dsee-specific-filtering-enabled(optional): boolean
  デフォルト値: true

  DSEE固有のオブジェクト・クラスや属性タイプがフィルタリングされるかどうかを示します
• ds-cfg-dsee-specific-object-classes(optional): array ds-cfg-dsee-specific-object-classes
  ODSEEサーバー固有であり、Oracle Unified Directoryサーバーに伝播しないオブジェクト・クラス。
• ds-cfg-enabled: boolean
  このプラグインが使用可能かどうかを示します。
• ds-cfg-invoke-for-internal-operations(optional): boolean
  デフォルト値: true

  プラグインを内部操作のために呼び出す必要があるかどうかを示します。
• ds-cfg-java-class: string
  デフォルト値: com.sun.gateway.server.DseeGatewayPlugin

  プラグインの実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-plugin-type: array ds-cfg-plugin-type
  プラグインが呼び出される回数を指定する、プラグインの一連のプラグイン・タイプを指定します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-plugin-type",
        "ds-cfg-enabled"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-java-class":{
            "description":"Specifies the fully-qualified name of the Java class that provides the plug-in implementation. ",
            "readOnly":false,
            "default":"com.sun.gateway.server.DseeGatewayPlugin",
            "type":"string"
        },
        "ds-cfg-invoke-for-internal-operations":{
            "description":"Indicates whether the plug-in should be invoked for internal operations. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-dsee-specific-filtering-enabled":{
            "description":"Indicates whether the dsee specific object classes and/or attribute types are filtered ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-plugin-type":{
            "description":"Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked. ",
            "readOnly":false,
            "default":[
                "startup"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "intermediateresponse",
                "ldifexport",
                "ldifimport",
                "ldifimportbegin",
                "ldifimportend",
                "postconnect",
                "postdisconnect",
                "postoperationabandon",
                "postoperationadd",
                "postoperationbind",
                "postoperationcompare",
                "postoperationdelete",
                "postoperationextended",
                "postoperationmodify",
                "postoperationmodifydn",
                "postoperationsearch",
                "postoperationunbind",
                "postresponseadd",
                "postresponsebind",
                "postresponsecompare",
                "postresponsedelete",
                "postresponseextended",
                "postresponsemodify",
                "postresponsemodifydn",
                "postresponsesearch",
                "postsynchronizationadd",
                "postsynchronizationdelete",
                "postsynchronizationmodify",
                "postsynchronizationmodifydn",
                "preoperationadd",
                "preoperationbind",
                "preoperationcompare",
                "preoperationdelete",
                "preoperationextended",
                "preoperationmodify",
                "preoperationmodifydn",
                "preoperationsearch",
                "preparseabandon",
                "preparseadd",
                "preparsebind",
                "preparsecompare",
                "preparsedelete",
                "preparseextended",
                "preparsemodify",
                "preparsemodifydn",
                "preparsesearch",
                "preparseunbind",
                "searchresultentry",
                "searchresultreference",
                "shutdown",
                "startup",
                "subordinatedelete",
                "subordinatemodifydn"
            ]
        },
        "ds-cfg-dsee-specific-attribute-types":{
            "description":"The attributes that are specific to ODSEE servers and should not be propagated to Oracle Unified Directory servers. ",
            "readOnly":false,
            "default":[
                "costargettree",
                "costemplatedn",
                "cosspecifier",
                "cosattribute",
                "cosindirectspecifier",
                "cospriority",
                "nsrole",
                "nsrolescopedn",
                "nsroledn",
                "nsroleFilter",
                "nsaccountlock",
                "passwordRootdnMayBypassModsChecks",
                "passwordNonRootMayResetUserpwd",
                "passwordStorageScheme",
                "pwdIsLockoutPrioritized",
                "pwdKeepLastAuthTime",
                "pwdLastAuthTime",
                "nsds5ReplConflict",
                "passwordExpirationTime",
                "passwordExpWarned",
                "passwordRetryCount",
                "retryCountResetTime",
                "accountUnlockTime",
                "passwordHistory",
                "passwordAllowChangeTime",
                "nsTimeLimit",
                "nsSizeLimit",
                "nsLookThroughLimit",
                "nsIdleTimeout"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-dsee-specific-object-classes":{
            "description":"The object classes that are specific to ODSEE servers and should not be propagated to Oracle Unified Directory servers. ",
            "readOnly":false,
            "default":[
                "cosDefinition",
                "cosSuperDefinition",
                "cosClassicDefinition",
                "cosPointerDefinition",
                "cosIndirectDefinition",
                "costemplate",
                "nsRoleDefinition",
                "nsSimpleRoleDefinition",
                "nsComplexRoleDefinition",
                "nsManagedRoleDefinition",
                "nsFilteredRoleDefinition",
                "nsNestedRoleDefinition",
                "nsContainer",
                "sunPwdPolicy",
                "passwordObject"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the plug-in is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

ネストされたスキーマ: ds-cfg-dsee-specific-attribute-types

型: array

ODSEEサーバー固有であり、Oracle Unified Directoryサーバーに伝播しない属性。

デフォルト値: [ "costargettree", "costemplatedn", "cosspecifier", "cosattribute", "cosindirectspecifier", "cospriority", "nsrole", "nsrolescopedn", "nsroledn", "nsroleFilter", "nsaccountlock", "passwordRootdnMayBypassModsChecks", "passwordNonRootMayResetUserpwd", "passwordStorageScheme", "pwdIsLockoutPrioritized", "pwdKeepLastAuthTime", "pwdLastAuthTime", "nsds5ReplConflict", "passwordExpirationTime", "passwordExpWarned", "passwordRetryCount", "retryCountResetTime", "accountUnlockTime", "passwordHistory", "passwordAllowChangeTime", "nsTimeLimit", "nsSizeLimit", "nsLookThroughLimit", "nsIdleTimeout" ]

ソースを表示

• [0]: string

{
    "description":"The attributes that are specific to ODSEE servers and should not be propagated to Oracle Unified Directory servers. ",
    "readOnly":false,
    "default":[
        "costargettree",
        "costemplatedn",
        "cosspecifier",
        "cosattribute",
        "cosindirectspecifier",
        "cospriority",
        "nsrole",
        "nsrolescopedn",
        "nsroledn",
        "nsroleFilter",
        "nsaccountlock",
        "passwordRootdnMayBypassModsChecks",
        "passwordNonRootMayResetUserpwd",
        "passwordStorageScheme",
        "pwdIsLockoutPrioritized",
        "pwdKeepLastAuthTime",
        "pwdLastAuthTime",
        "nsds5ReplConflict",
        "passwordExpirationTime",
        "passwordExpWarned",
        "passwordRetryCount",
        "retryCountResetTime",
        "accountUnlockTime",
        "passwordHistory",
        "passwordAllowChangeTime",
        "nsTimeLimit",
        "nsSizeLimit",
        "nsLookThroughLimit",
        "nsIdleTimeout"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-dsee-specific-object-classes

型: array

ODSEEサーバー固有であり、Oracle Unified Directoryサーバーに伝播しないオブジェクト・クラス。

デフォルト値: [ "cosDefinition", "cosSuperDefinition", "cosClassicDefinition", "cosPointerDefinition", "cosIndirectDefinition", "costemplate", "nsRoleDefinition", "nsSimpleRoleDefinition", "nsComplexRoleDefinition", "nsManagedRoleDefinition", "nsFilteredRoleDefinition", "nsNestedRoleDefinition", "nsContainer", "sunPwdPolicy", "passwordObject" ]

ソースを表示

• [0]: string

{
    "description":"The object classes that are specific to ODSEE servers and should not be propagated to Oracle Unified Directory servers. ",
    "readOnly":false,
    "default":[
        "cosDefinition",
        "cosSuperDefinition",
        "cosClassicDefinition",
        "cosPointerDefinition",
        "cosIndirectDefinition",
        "costemplate",
        "nsRoleDefinition",
        "nsSimpleRoleDefinition",
        "nsComplexRoleDefinition",
        "nsManagedRoleDefinition",
        "nsFilteredRoleDefinition",
        "nsNestedRoleDefinition",
        "nsContainer",
        "sunPwdPolicy",
        "passwordObject"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-plugin-type

型: array

プラグインが呼び出される回数を指定する、プラグインの一連のプラグイン・タイプを指定します。

デフォルト値: [ "startup" ]

指定可能な値: [ "intermediateresponse", "ldifexport", "ldifimport", "ldifimportbegin", "ldifimportend", "postconnect", "postdisconnect", "postoperationabandon", "postoperationadd", "postoperationbind", "postoperationcompare", "postoperationdelete", "postoperationextended", "postoperationmodify", "postoperationmodifydn", "postoperationsearch", "postoperationunbind", "postresponseadd", "postresponsebind", "postresponsecompare", "postresponsedelete", "postresponseextended", "postresponsemodify", "postresponsemodifydn", "postresponsesearch", "postsynchronizationadd", "postsynchronizationdelete", "postsynchronizationmodify", "postsynchronizationmodifydn", "preoperationadd", "preoperationbind", "preoperationcompare", "preoperationdelete", "preoperationextended", "preoperationmodify", "preoperationmodifydn", "preoperationsearch", "preparseabandon", "preparseadd", "preparsebind", "preparsecompare", "preparsedelete", "preparseextended", "preparsemodify", "preparsemodifydn", "preparsesearch", "preparseunbind", "searchresultentry", "searchresultreference", "shutdown", "startup", "subordinatedelete", "subordinatemodifydn" ]

ソースを表示

• [0]: string

{
    "description":"Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked. ",
    "readOnly":false,
    "default":[
        "startup"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "intermediateresponse",
        "ldifexport",
        "ldifimport",
        "ldifimportbegin",
        "ldifimportend",
        "postconnect",
        "postdisconnect",
        "postoperationabandon",
        "postoperationadd",
        "postoperationbind",
        "postoperationcompare",
        "postoperationdelete",
        "postoperationextended",
        "postoperationmodify",
        "postoperationmodifydn",
        "postoperationsearch",
        "postoperationunbind",
        "postresponseadd",
        "postresponsebind",
        "postresponsecompare",
        "postresponsedelete",
        "postresponseextended",
        "postresponsemodify",
        "postresponsemodifydn",
        "postresponsesearch",
        "postsynchronizationadd",
        "postsynchronizationdelete",
        "postsynchronizationmodify",
        "postsynchronizationmodifydn",
        "preoperationadd",
        "preoperationbind",
        "preoperationcompare",
        "preoperationdelete",
        "preoperationextended",
        "preoperationmodify",
        "preoperationmodifydn",
        "preoperationsearch",
        "preparseabandon",
        "preparseadd",
        "preparsebind",
        "preparsecompare",
        "preparsedelete",
        "preparseextended",
        "preparsemodify",
        "preparsemodifydn",
        "preparsesearch",
        "preparseunbind",
        "searchresultentry",
        "searchresultreference",
        "shutdown",
        "startup",
        "subordinatedelete",
        "subordinatemodifydn"
    ]
}

ネストされたスキーマ: objectclass

型: array

このエントリが属するオブジェクト・クラス。

ソースを表示

• [0]: string

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

406レスポンス

受入れできません

本文 ()

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

• ldapErrorCode(optional): integer(int32)
  操作に対して返されるLDAPエラー・コードを指定します。
• message: string
  操作に対して返されるエラー・メッセージ。
• msgType: string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse

  RESTメッセージ・タイプ

{
    "type":"object",
    "required":[
        "msgType",
        "message"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse",
            "type":"string"
        },
        "message":{
            "description":"Error message returned returned for the operation.",
            "type":"string"
        },
        "ldapErrorCode":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the LDAP error code returned for the operation."
        }
    }
}

先頭に戻る