QsySetDigitalIDConfig()--Set Digital ID Configuration Information


Syntax for QsySetDigitalIDConfig:
 #include <qsydigid.h>

 void QsySetDigitalIDConfig
        (char           *Configuration_information,
         int             Length_of_configuration_information,
         char           *Format_name,
         void           *Error_code);
  Service Program: QSYDIGID

  Default Public Authority: *USE

  Threadsafe: Yes

The Set Digital ID Configuration Information (QsySetDigitalIDConfig) API will set digital ID configuration information. This is the information that defines the Lightweight Directory Access Protocol (LDAP) server for where to store digital certificates, and connection information for the server.


Authorities and Locks

QSYDIGID Validation List Object
*CHANGE
QUSRSYS Library
*EXECUTE


Required Parameter Group

Configuration information
INPUT; CHAR(*)

The configuration information that is being set. See SDCI0100 Format for the definition of the fields for this parameter.

Length of configuration information
INPUT; BINARY(4)

The length of the configuration information. This area must be as large as the format specified.

Format name
INPUT; CHAR(8)

The format of the configuration information.

The following format name may be used:

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.


SDCI0100 Format

The following table shows the information that must be specified in the configuration information parameter when format SDCI0100 is specified. For a detailed description of each field, see Field Descriptions.



Field Descriptions

Bind DN. The Distinguished Name (DN) used when binding to the LDAP server. The DN that is specified must have sufficient LDAP authorization to create objects and modify objects in the specified directory DN.

Bind password. The password to use in association with the bind DN.

Directory DN. The DN for where in the LDAP server the user certificates are to be stored.

Enabled indicator. Specifies whether or not the configuration information is enabled for use.

Length of bind DN. The length of the field that contains the bind distinguished name (DN).

Length of bind password. The length of the field that contains the bind password.

Length of directory DN. The length of the field that contains the directory distinguished name (DN).

Length of server name. The length of the field that contains the server name.

Port number. The port number to use when connecting to the LDAP server. The suggested port number for non-secure access is 389. The suggested port number for secure access is 636. A value of -1 indicates that the port number does not change.

Offset to bind DN. The offset to the field that contains the bind distinguished name (DN). If the Length of bind DN is -1 or 0, then this value must be 0.

Offset to bind password. The offset to the field that contains the bind password. If the Length of bind password is -1 or 0, then this value must be 0.

Offset to directory DN. The offset to the field that contains the directory distinguished name (DN). If the Length of directory DN is -1 or 0, then this value must be 0.

Offset to server name. The offset to the field that contains the server name. If the Length of server name is -1 or 0, then this value must be 0.

Reserved. Reserved data. This value must be hexadecimal zero.

Server name. The domain name of the LDAP server on which to store user certificates.

Use SSL indicator. Specifies whether or not Secure Sockets Layer (SSL) is used for secure access when connecting to the LDAP server.

Error Messages


API introduced: V5R3

[ Back to top | Security APIs | APIs by category ]