DDAP gate, BIND_LDAP function

The BIND_LDAP function of the DDAP gate establishes a session with an LDAP server.

Input Parameters

CACHE_SIZE
Optional parameter
a fullword that specifies the number of bytes available for caching LDAP search results. A value of zero indicates an unlimited cache size. If CACHE_SIZE is specified, CACHE_TIME_LIMIT must also be specified. If neither parameter is specified, results will not be cached.
CACHE_TIME_LIMIT
Optional parameter
a fullword that specifies the amount of time (in seconds) that LDAP search results are cached. A value of zero indicates an unlimited cache time limit.
DISTINGUISHED_NAME
specifies the location of the LDAP distinguished name, of the user permitted to bind to the chosen server. The block-descriptor is two fullwords of data, in which the first word contains the address of the data, and the second word contains the length in bytes of the data.
LDAP_BIND_PROFILE
specifies the location of the name of a RACF profile in the LDAPBIND class that contains the URL and credentials for the LDAP server being accessed. The block-descriptor is two fullwords of data, in which the first word contains the address of the data, and the second word contains the length in bytes of the data.
LDAP_SERVER_URL
specifies the location of the LDAP URL (in the format ldap://server:port) of the LDAP server being accessed. If the colon and port number are omitted, the port defaults to 389. The block-descriptor is two fullwords of data, in which the first word contains the address of the data, and the second word contains the length in bytes of the data.
PASSWORD
specifies the location of the password for the user identified in the DISTINGUISHED_NAME input. The block-descriptor is two fullwords of data, in which the first word contains the address of the data, and the second word contains the length in bytes of the data.

Output Parameters

REASON
The following values are returned when RESPONSE is EXCEPTION:
  • NOTAUTH
  • NOTFOUND
  • LDAP_INACTIVE
  • INVALID_LDAP_URL
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
LDAP_RESPONSE
Optional parameter
specifies the return code that is sent by the LDAP API, in response to receiving URL and user credentials.
LDAP_SESSION_TOKEN
the name of the fullword token that specifies the LDAP connection.


dfhs3_DDAPbind_ldap.html | Timestamp icon Last updated: Monday, 5 June 2017