REST API for Oracle Unified Directory Administration

Find Password Policy Import Plugin by DN

get

/rest/v1/admin/{dn}

Returns an Password Policy Import Plugin by DN

Request

Supported Media Types

application/json

Path Parameters

dn: string

LDAP DN of the entry to be fetched.

Query Parameters

attributes: array

Collection Format: multi

List of attributes to be fetched for the entry.

[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

Collection Format: multi

LDAP controls to be sent to server for search operation.

[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

Search filter for the LDAP search operation. Should follow LDAP search filter syntax.
scope: string

Scope for the LDAP search operation.

Allowed Values: [ "base", "sub", "one" ]

Response

Supported Media Types

application/json

200 Response

Root Schema : Password Policy Import Plugin GetSuccessResponse

Type: object

Show Source

msgType: string

Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse

The REST message type
searchResultEntries: array searchResultEntries

Number of search result entries returned after the LDAP operation.
totalResults: integer(int32)

Specifies the number of entries created, and returned.

{
    "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/Password Policy Import Plugin SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object Password Policy Import Plugin SearchResultEntry

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

Nested Schema : Password Policy Import Plugin SearchResultEntry

Type: object

Show Source

attributes: object Password Policy Import Plugin Properties
dn: string

LDAP DN of the entry to be created

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

Nested Schema : Password Policy Import Plugin Properties

Type: object

Show Source

cn(optional): string

CN (common name) of the entry
ds-cfg-default-auth-password-storage-scheme(optional): array ds-cfg-default-auth-password-storage-scheme

Specifies the names of password storage schemes that to be used for encoding passwords contained in attributes with the auth password syntax for entries that do not include the ds-pwp-password-policy-dn attribute specifying which password policy should be used to govern them.
ds-cfg-default-user-password-storage-scheme(optional): array ds-cfg-default-user-password-storage-scheme

Specifies the names of the password storage schemes to be used for encoding passwords contained in attributes with the user password syntax for entries that do not include the ds-pwp-password-policy-dn attribute specifying which password policy is to be used to govern them.
ds-cfg-enabled: boolean

Indicates whether the plug-in is enabled for use.
ds-cfg-invoke-for-internal-operations(optional): boolean

Default Value: false

Indicates whether the plug-in should be invoked for internal operations.
ds-cfg-java-class: string

Default Value: org.opends.server.plugins.PasswordPolicyImportPlugin

Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
ds-cfg-plugin-type: array ds-cfg-plugin-type

Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
objectclass: array objectclass

Objectclass(es) which this entry belongs to.

{
    "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":"org.opends.server.plugins.PasswordPolicyImportPlugin",
            "type":"string"
        },
        "ds-cfg-invoke-for-internal-operations":{
            "description":"Indicates whether the plug-in should be invoked for internal operations. ",
            "readOnly":false,
            "default":false,
            "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":[
                "ldifimport"
            ],
            "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-default-user-password-storage-scheme":{
            "description":"Specifies the names of the password storage schemes to be used for encoding passwords contained in attributes with the user password syntax for entries that do not include the ds-pwp-password-policy-dn attribute specifying which password policy is to be used to govern them. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the plug-in is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-default-auth-password-storage-scheme":{
            "description":"Specifies the names of password storage schemes that to be used for encoding passwords contained in attributes with the auth password syntax for entries that do not include the ds-pwp-password-policy-dn attribute specifying which password policy should be used to govern them. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ds-cfg-default-auth-password-storage-scheme

Type: array

Specifies the names of password storage schemes that to be used for encoding passwords contained in attributes with the auth password syntax for entries that do not include the ds-pwp-password-policy-dn attribute specifying which password policy should be used to govern them.

Show Source

Array of: string

{
    "description":"Specifies the names of password storage schemes that to be used for encoding passwords contained in attributes with the auth password syntax for entries that do not include the ds-pwp-password-policy-dn attribute specifying which password policy should be used to govern them. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-default-user-password-storage-scheme

Type: array

Specifies the names of the password storage schemes to be used for encoding passwords contained in attributes with the user password syntax for entries that do not include the ds-pwp-password-policy-dn attribute specifying which password policy is to be used to govern them.

Show Source

Array of: string

{
    "description":"Specifies the names of the password storage schemes to be used for encoding passwords contained in attributes with the user password syntax for entries that do not include the ds-pwp-password-policy-dn attribute specifying which password policy is to be used to govern them. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-plugin-type

Type: array

Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.

Default Value:

[
    "ldifimport"
]

Allowed Values:

[
    "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"
]

Show Source

Array of: 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":[
        "ldifimport"
    ],
    "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"
    ]
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

Array of: string

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

406 Response

Not Acceptable

Root Schema : ErrorResponse

Type: object

Show Source

ldapErrorCode(optional): integer(int32)

Specifies the LDAP error code returned for the operation.
message: string

Error message returned returned for the operation.
msgType: string

Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse

The REST message type

{
    "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."
        }
    }
}