Oracle | DBMS_LDAP_API

Oracle DBMS_LDAP_API_FFI Version 26ai

General Information

Library Note

Morgan's Library Page Header

The best Oracle News for FY2026

Oracle Database 26ai will be available on generic Linux platforms in January and soon on AIX and Windows

Purpose TBD

AUTHID CURRENT_USER

Dependencies

DBMS_LDAP

DBMS_LDAP_API_LIB

DBMS_LDAP_UTL

Documented No

First Available Not known

Security Model Owned by SYS with no privileges granted

Source {ORACLE_HOME}/rdbms/admin/prvtldap.plb
{ORACLE_HOME}/rdbms/admin/prvtldap.plb

Subprograms

BER_FREE	LDAP_NEXT_ATTRIBUTE	ORA_LDAP_GET_GRP_PROPS
CREATE_MOD_ARRAY	LDAP_NEXT_ENTRY	ORA_LDAP_GET_PROP_NAMES
FREE_MOD_ARRAY	LDAP_OPEN_SSL	ORA_LDAP_GET_PROP_VALUES
LDAP_ADD_S	LDAP_RENAME_S	ORA_LDAP_GET_PROP_VALUES_BLOB
LDAP_BIND_S	LDAP_SEARCH_S	ORA_LDAP_GET_PROP_VALUES_LEN
LDAP_COMPARE_S	LDAP_SEARCH_ST	ORA_LDAP_GET_SCRIBED_SRVS
LDAP_COUNT_ENTRIES	LDAP_SET_TRACE_LEVEL	ORA_LDAP_GET_SCRIBED_USERS
LDAP_DELETE_S	LDAP_SIMPLE_BIND_S	ORA_LDAP_GET_SUB_DN
LDAP_ERR2STRING	LDAP_UNBIND_S	ORA_LDAP_GET_SUB_EXT_PROPS
LDAP_EXPLODE_DN	ORA_LDAP_AUTHENTICATE_USER	ORA_LDAP_GET_SUB_PROPS
LDAP_FIRST_ATTRIBUTE	ORA_LDAP_AUTHENTICATE_USER_EXT	ORA_LDAP_GET_USER_DN
LDAP_FIRST_ENTRY	ORA_LDAP_CHECK_GRP_MEMBERSHIP	ORA_LDAP_GET_USER_EXT_PROPS
LDAP_GET_DBCHARSET_NAME	ORA_LDAP_CHECK_USER_SCRIPTION	ORA_LDAP_GET_USER_PROPS
LDAP_GET_DN	ORA_LDAP_CREATE_GRP_HANDLE	ORA_LDAP_GET_USER_PROPS_AUTH
LDAP_GET_SESSION_INFO	ORA_LDAP_CREATE_MOD_PSET	ORA_LDAP_LOCATE_SUB_FOR_USER
LDAP_GET_TRACE_LEVEL	ORA_LDAP_CREATE_SRV_HANDLE	ORA_LDAP_NORM_DN_WITH_CASE
LDAP_GET_VALUES	ORA_LDAP_CREATE_SUB_HANDLE	ORA_LDAP_POPULATE_MOD_PSET
LDAP_GET_VALUES_BLOB	ORA_LDAP_CREATE_USER_HANDLE	ORA_LDAP_SCRIBE_USER
LDAP_GET_VALUES_LEN	ORA_LDAP_FREE_HANDLE	ORA_LDAP_SET_GRP_HANDLE_PROPS
LDAP_INIT	ORA_LDAP_FREE_MOD_PSET	ORA_LDAP_SET_USER_HANDLE_PROPS
LDAP_MEMFREE	ORA_LDAP_FREE_PSET_COLL	ORA_LDAP_SET_USER_PROPS
LDAP_MODIFY_S	ORA_LDAP_GET_AVAIL_SRVS	ORA_LDAP_UNSCRIBE_USER
LDAP_MODRDN2_S	ORA_LDAP_GET_GRP_DN	POPULATE_MOD_ARRAY
LDAP_MSGFREE	ORA_LDAP_GET_GRP_MEMBERSHIP	VALUE_FREE_BLOB

BER_FREE

Undocumented dbms_ldap_api_ffi.ber_free( ber IN RAW, freebuf IN BINARY_INTEGER);

TBD

CREATE_MOD_ARRAY

Undocumented dbms_ldap_api_ffi.create_mod_array(num IN BINARY_INTEGER) RETURN RAW;

TBD

FREE_MOD_ARRAY

Undocumented dbms_ldap_api_ffi.free_mod_array(modptr IN RAW);

TBD

LDAP_ADD_S

Undocumented dbms_ldap_api_ffi.ldap_add_s( ld IN RAW, entrydn IN VARCHAR2, modptr IN RAW) RETURN BINARY_INTEGER;

TBD

LDAP_BIND_S

Undocumented dbms_ldap_api_ffi.ldap_bind_s( ld IN RAW, dn IN VARCHAR2, cred IN VARCHAR2, meth IN BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

LDAP_COMPARE_S

Undocumented dbms_ldap_api_ffi.ldap_compare_s( ld IN RAW, dn IN VARCHAR2, attr IN VARCHAR2, value IN VARCHAR2) RETURN BINARY_INTEGER;

TBD

LDAP_COUNT_ENTRIES

Undocumented dbms_ldap_api_ffi.ldap_count_entries( ld IN RAW, msg IN RAW) RETURN BINARY_INTEGER;

TBD

LDAP_DELETE_S

Undocumented dbms_ldap_api_ffi.ldap_delete_s( ld IN RAW, entrydn IN VARCHAR2) RETURN BINARY_INTEGER;

TBD

LDAP_ERR2STRING

Undocumented dbms_ldap_api_ffi.ldap_err2string( ldap_err IN BINARY_INTEGER, err_str OUT VARCHAR2);

TBD

LDAP_EXPLODE_DN

Undocumented dbms_ldap_api_ffi.ldap_explode_dn( dn IN VARCHAR2, notypes IN BINARY_INTEGER, comps OUT sys.dbms_ldap.string_collection);

TBD

LDAP_FIRST_ATTRIBUTE

Undocumented dbms_ldap_api_ffi.ldap_first_attribute( ld IN RAW, msg IN RAW, ber_elem OUT RAW, attr OUT VARCHAR2);

TBD

LDAP_FIRST_ENTRY

Undocumented dbms_ldap_api_ffi.ldap_first_entry( ld IN RAW, msg IN RAW) RETURN RAW;

TBD

LDAP_GET_DBCHARSET_NAME

Outputs the database character set dbms_ldap_api_ffi.ldap_get_dbcharset_name(name OUT VARCHAR2);

DECLARE

       outVal dbms_id;

      BEGIN

        dbms_ldap_api_ffi.ldap_get_dbcharset_name(outVal);

        dbms_output.put_line(outVal);

      END;

      /

      AL32UTF8

      

      PL/SQL procedure successfully completed.

LDAP_GET_DN

Undocumented dbms_ldap_api_ffi.ldap_get_dn( ld IN RAW, msg IN RAW, dn OUT VARCHAR2);

TBD

LDAP_GET_SESSION_INFO

Undocumented dbms_ldap_api_ffi.ldap_get_session_info( ld IN RAW, data_type IN BINARY_INTEGER, data OUT VARCHAR2) RETURN BINARY_INTEGER;

TBD

LDAP_GET_TRACE_LEVEL

Outputs the LDAP trace level dbms_ldap_api_ffi.ldap_get_trace_level(trace_level OUT BINARY_INTEGER);

DECLARE

       outVal PLS_INTEGER;

      BEGIN

        dbms_ldap_api_ffi.ldap_get_trace_level(outVal);

        dbms_output.put_line(outVal);

      END;

      /

      0

      

      PL/SQL procedure successfully completed.

LDAP_GET_VALUES

Undocumented dbms_ldap_api_ffi.ldap_get_values( ld IN RAW, msg IN RAW, attr IN VARCHAR2, vals OUT sys.dbms_ldap.string_collection);

TBD

LDAP_GET_VALUES_BLOB

Undocumented dbms_ldap_api_ffi.ldap_get_values_blob( ld IN RAW, msg IN RAW, attr IN VARCHAR2, vals OUT sys.dbms_ldap.blob_collection);

TBD

LDAP_GET_VALUES_LEN

Undocumented dbms_ldap_api_ffi.ldap_get_values_len( ld IN RAW, msg IN RAW, attr IN VARCHAR2, vals OUT sys.dbms_ldap.binval_collection);

TBD

LDAP_INIT

Undocumented dbms_ldap_api_ffi.ldap_init( hostname IN VARCHAR2, portnum IN BINARY_INTEGER) RETURN RAW;

TBD

LDAP_MEMFREE

Undocumented dbms_ldap_api_ffi.ldap_memfree(ptr IN RAW);

TBD

LDAP_MODIFY_S

Undocumented dbms_ldap_api_ffi.ldap_modify_s( ld IN RAW, entrydn IN VARCHAR2, modptr IN RAW) RETURN BINARY_INTEGER;

TBD

LDAP_MODRDN2_S

Undocumented dbms_ldap_api_ffi.ldap_modrdn2_s( ld IN RAW, entrydn IN VARCHAR2, newrdn IN VARCHAR2, deleteoldrdn IN BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

LDAP_MSGFREE

Undocumented dbms_ldap_api_ffi.ldap_msgfree(lm IN RAW) RETURN BINARY_INTEGER;

TBD

LDAP_NEXT_ATTRIBUTE

Undocumented dbms_ldap_api_ffi.ldap_next_attribute( ld IN RAW, msg IN RAW, ber_elem IN RAW, attr OUT VARCHAR2);

TBD

LDAP_NEXT_ENTRY

Undocumented dbms_ldap_api_ffi.ldap_next_entry( ld IN RAW, msg IN RAW) RETURN RAW;

TBD

LDAP_OPEN_SSL

Undocumented dbms_ldap_api_ffi.ldap_open_ssl( ld IN RAW, sslwrl IN VARCHAR2, sslwalletpasswd IN VARCHAR2, sslauth IN BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

LDAP_RENAME_S

Undocumented dbms_ldap_api_ffi.ldap_rename_s( ld IN RAW, dn IN VARCHAR2, newrdn IN VARCHAR2, newparent IN VARCHAR2, deleteoldrdn IN BINARY_INTEGER, sldctl_oid IN VARCHAR2, sldctl_value IN RAW, sldctl_iscritical IN VARCHAR2, cldctl_oid IN VARCHAR2, cldctl_value IN RAW, cldctl_iscritical IN VARCHAR2) RETURN BINARY_INTEGER;

TBD

LDAP_SEARCH_S

Undocumented dbms_ldap_api_ffi.ldap_search_s( ld IN RAW, base IN VARCHAR2, scope IN BINARY_INTEGER, filter IN VARCHAR2, attrs IN sys.dbms_ldap.string_collection, attronly IN BINARY_INTEGER, res OUT RAW) RETURN BINARY_INTEGER;

TBD

LDAP_SEARCH_ST

Undocumented dbms_ldap_api_ffi.ldap_search_st( ld IN RAW, base IN VARCHAR2, scope IN BINARY_INTEGER, filter IN VARCHAR2, attrs IN sys.dbms_ldap.string_collection, attronly IN BINARY_INTEGER, ts IN BINARY_INTEGER, tus IN BINARY_INTEGER, res OUT RAW) RETURN BINARY_INTEGER;

TBD

LDAP_SET_TRACE_LEVEL

Undocumented dbms_ldap_api_ffi.ldap_set_trace_level(trace_level IN BINARY_INTEGER);

exec dbms_ldap_api_ffi.ldap_set_trace_level(16);

      

      PL/SQL procedure successfully completed.

LDAP_SIMPLE_BIND_S

Undocumented

Security alert: This procedure appears to expect a clear text password as an input dbms_ldap_api_ffi.ldap_simple_bind_s( ld IN RAW, dn IN VARCHAR2, passwd IN VARCHAR2) RETURN BINARY_INTEGER;

TBD

LDAP_UNBIND_S

Undocumented dbms_ldap_api_ffi.ldap_unbind_s(ld IN RAW) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_AUTHENTICATE_USER

Undocumented

Security alert: This procedure appears to expect a clear text credential as an input dbms_ldap_api_ffi.ora_ldap_authenticate_user( ld IN RAW, user_handle IN RAW, auth_type IN BINARY_INTEGER, credentials IN VARCHAR2, binary_credentials IN RAW) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_AUTHENTICATE_USER_EXT

Undocumented

Security alert: This procedure appears to expect a clear text password as an input dbms_ldap_api_ffi.ora_ldap_authenticate_user_ext( ld IN RAW, user_handle IN RAW, auth_type IN BINARY_INTEGER, password_attr IN VARCHAR2, password IN VARCHAR2) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_CHECK_GRP_MEMBERSHIP

Undocumented dbms_ldap_api_ffi.ora_ldap_check_grp_membership( ld IN RAW, user_handle IN RAW, group_handle IN RAW, nested IN BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_CHECK_USER_SCRIPTION

Undocumented dbms_ldap_api_ffi.ora_ldap_check_user_scription( ld IN RAW, user_hd IN RAW, service_hd IN RAW) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_CREATE_GRP_HANDLE

Undocumented dbms_ldap_api_ffi.ora_ldap_create_grp_handle( group_hd OUT RAW, group_type IN BINARY_INTEGER, group_id IN VARCHAR2) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_CREATE_MOD_PSET

Undocumented dbms_ldap_api_ffi.ora_ldap_create_mod_pset( pset_type IN BINARY_INTEGER, pset_name IN VARCHAR2, mod_pset OUT RAW) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_CREATE_SRV_HANDLE

Undocumented dbms_ldap_api_ffi.ora_ldap_create_srv_handle( service_hd OUT RAW, service_type IN BINARY_INTEGER, service_id IN VARCHAR2) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_CREATE_SUB_HANDLE

Undocumented dbms_ldap_api_ffi.ora_ldap_create_sub_handle( subscriber_hd OUT RAW, subscriber_type IN BINARY_INTEGER, subscriber_id IN VARCHAR2) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_CREATE_USER_HANDLE

Undocumented dbms_ldap_api_ffi.ora_ldap_create_user_handle( user_hd OUT RAW, user_type IN BINARY_INTEGER, user_id IN VARCHAR2) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_FREE_HANDLE

Undocumented dbms_ldap_api_ffi.ora_ldap_free_handle(handle IN RAW);

TBD

ORA_LDAP_FREE_MOD_PSET

Undocumented dbms_ldap_api_ffi.ora_ldap_free_mod_pset(mod_pset IN RAW);

TBD

ORA_LDAP_FREE_PSET_COLL

Undocumented dbms_ldap_api_ffi.ora_ldap_free_pset_coll( pset_collection IN sys.dbms_ldap_utl.property_set_collection);

TBD

ORA_LDAP_GET_AVAIL_SRVS

Undocumented dbms_ldap_api_ffi.ora_ldap_get_avail_srvs( ld IN RAW, subscriber_hd IN RAW, services OUT sys.dbms_ldap.string_collection) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_GET_GRP_DN

Undocumented dbms_ldap_api_ffi.ora_ldap_get_grp_dn( ld IN RAW, group_handle IN RAW, dn OUT VARCHAR2) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_GET_GRP_MEMBERSHIP

Undocumented dbms_ldap_api_ffi.ora_ldap_get_grp_membership( ld IN RAW, user_handle IN RAW, nested IN BINARY_INTEGER, attr_list IN sys.dbms_ldap.stiring_collection, ret_groups OUT sys.dbms_ldap_utl.property_set_collection) RETURN BINARY_INTEGER

TBD

ORA_LDAP_GET_GRP_PROPS

Undocumented dbms_ldap_api_ffi.ora_ldap_get_grp_props( ld IN RAW, group_handle IN RAW, attrs IN sys.dbms_ldap.string_collection, ptype IN BINARY_INTEGER, ret_pset_coll IN sys.dbms_ldap_util.property_set_collection) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_GET_PROP_NAMES

Undocumented dbms_ldap_api_ffi.ora_ldap_get_prop_names( pset IN RAW, property_names OUT sys.dbms_ldap.string_collection) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_GET_PROP_VALUES

Undocumented dbms_ldap_api_ffi.ora_ldap_get_prop_values( pset IN RAW, property_name IN VARCHAR2, property_values OUT sys.dbms_ldap.string_collection) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_GET_PROP_VALUES_BLOB

Undocumented dbms_ldap_api_ffi.ora_ldap_get_prop_values_blob( pset IN RAW, property_name IN VARCHAR2, property_values OUT sys.dbms_ldap.blob_collection) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_GET_PROP_VALUES_LEN

Undocumented dbms_ldap_api_ffi.ora_ldap_get_prop_values_len( pset IN RAW, property_name IN VARCHAR2, property_values OUT sys.dbms_ldap.binval_collection) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_GET_SCRIBED_SRVS

Undocumented dbms_ldap_api_ffi.ora_ldap_get_scribed_srvs( ld IN RAW, user_hd IN RAW, services OUT sys.dbms_ldap.string_collection) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_GET_SCRIBED_USERS

Undocumented dbms_ldap_api_ffi.ora_ldap_get_scribed_users( ld IN RAW, service_hd IN RAW, users OUT sys.dbms_ldap.string_collection) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_GET_SUB_DN

Undocumented dbms_ldap_api_ffi.ora_ldap_get_sub_dn( ld IN RAW, subscriber_handle IN RAW, dn OUT VARCHAR2) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_GET_SUB_EXT_PROPS

Undocumented dbms_ldap_api_ffi.ora_ldap_get_sub_ext_props( ld IN RAW, subscriber_handle IN RAW, attrs IN sys.dbms_ldap.string_collection, ptype IN BINARY_INTEGER, filter IN VARCHAR2, ret_pset_coll OUT sys.dbms_ldap_utl.property_set_collection) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_GET_SUB_PROPS

Undocumented dbms_ldap_api_ffi.ora_ldap_get_sub_props( ld IN RAW, subscriber_handle IN RAW, attrs IN sys.dbms_ldap.string_collection, ptype IN BINARY_INTEGER, ret_pset_coll IN sys.dbms_ldap_util.property_set_collection) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_GET_USER_DN

Undocumented dbms_ldap_api_ffi.ora_ldap_get_user_dn( ld IN RAW, user_handle IN RAW, dn OUT VARCHAR2) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_GET_USER_EXT_PROPS

Undocumented dbms_ldap_api_ffi.ora_ldap_get_user_ext_props( ld IN RAW, user_handle IN RAW, attrs IN sys.dbms_ldap.string_collection, ptype IN BINARY_INTEGER, filter IN VARCHAR2, ret_pset_coll IN sys.dbms_ldap_util.property_set_collection) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_GET_USER_PROPS

Undocumented dbms_ldap_api_ffi.ora_ldap_get_user_props( ld IN RAW, user_handle IN RAW, attrs IN sys.dbms_ldap.string_collection, ptype IN BINARY_INTEGER, ret_pset_coll IN sys.dbms_ldap_util.property_set_collection) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_GET_USER_PROPS_AUTH

Undocumented dbms_ldap_api_ffi.ora_ldap_get_user_props_auth( ld IN RAW, user_handle IN RAW, auth_type IN BINARY_INTEGER, attrs IN sys.dbms_ldap.string_collection, credentials IN VARCHAR2, binary_credentials IN RAW, ret_pset_coll IN sys.dbms_ldap_util.property_set_collection) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_LOCATE_SUB_FOR_USER

Undocumented dbms_ldap_api_ffi.ora_ldap_locate_sub_for_user( ld IN RAW, user_handle IN RAW, subscriber_handle OUT RAW) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_NORM_DN_WITH_CASE

Undocumented dbms_ldap_api_ffi.ora_ldap_norm_dn_with_case( dn IN VARCHAR2, lower_case IN BINARY_INTEGER, norm_dn OUT VARCHAR2) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_POPULATE_MOD_PSET

Undocumented dbms_ldap_api_ffi.ora_ldap_populate_mod_pset( mod_pset IN RAW, property_mod_op IN BINARY_INTEGER, property_name IN VARCHAR2, property_values IN sys.dbms_ldap.string_collection) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_SCRIBE_USER

Undocumented dbms_ldap_api_ffi.ora_ldap_scribe_user( ld IN RAW, user_hd IN RAW, service_hd IN RAW) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_SET_GRP_HANDLE_PROPS

Undocumented dbms_ldap_api_ffi.ora_ldap_set_grp_handle_props( group_hd IN RAW, property_type IN BINARY_INTEGER, property IN RAW) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_SET_USER_HANDLE_PROPS

Undocumented dbms_ldap_api_ffi.ora_ldap_set_user_handle_props( user_hd IN RAW, property_type IN BINARY_INTEGER, property IN RAW) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_SET_USER_PROPS

Undocumented dbms_ldap_api_ffi.ora_ldap_set_user_props( ld IN RAW, user_handle IN RAW, pset_type IN BINARY_INTEGER, mod_pset IN RAW, mod_op IN BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

ORA_LDAP_UNSCRIBE_USER

Undocumented dbms_ldap_api_ffi.ora_ldap_unscribe_user( ld IN RAW, user_hd IN RAW, service_hd IN RAW) RETURN BINARY_INTEGER;

TBD

POPULATE_MOD_ARRAY

Undocumented

Overload 1 dbms_ldap_api_ffi.populate_mod_array( modptr IN RAW, mod_op IN BINARY_INTEGER, mod_type IN VARCHAR2, modval IN sys.dbms_ldap.string_collection);

TBD

Overload 2 dbms_ldap_api_ffi.populate_mod_array( modptr IN RAW, mod_op IN BINARY_INTEGER, mod_type IN VARCHAR2, modbval IN sys.dbms_ldap.berval_collection);

TBD

Overload 3 dbms_ldap_api_ffi.populate_mod_array( modptr IN RAW, mod_op IN BINARY_INTEGER, mod_type IN VARCHAR2, modbval IN sys.dbms_ldap.blob_collection);

TBD

VALUE_FREE_BLOB

Undocumented dbms_ldap_api_ffi.value_free_blob(vals IN OUT sys.dbms_ldap.blob_collection);

TBD