db2Credentials data structure

The db2Credentials structure is used for specifying various types of credentials required for connections or attachments. Not all parameters should be used at the same time, only those required. All other values should be NULL.

Table 1. Fields in the db2Credentials structure
Field Name	Data Type	Description
pUsername	char	A string containing the username. Can be NULL.
pPassword	char	A string containing the password. Can be NULL.
pNewPassword	char	A string containing the new password. Can be NULL. Not all interfaces using the db2Credentials structure may support changing passwords.
pAccessToken	char	A string containing the access token. Can be NULL.
pAccessTokenType	char	A string containing the access token type. Can be NULL.
pApiKey	char	A string containing the API key. Can be NULL.
pDelegatedCredentialHandle	pointer	A pointer to the GSSAPI delegated credential. Can be NULL.
pReserved1	pointer	Reserved for future use. Must be NULL.
pReserved2	pointer	Reserved for future use. Must be NULL.
pReserved3	pointer	Reserved for future use. Must be NULL.
pReserved4	pointer	Reserved for future use. Must be NULL.

API and data structure syntax

Stypedef SQL_STRUCTURE db2Credentials
{
             char          *pUsername;       /* Username                      */
             char          *pPassword;       /* Password                      */
             char          *pNewPassword;    /* New Password                  */
             char          *pAccessToken;    /* Access Token                  */
             char          *pAccessTokenType; /* Access Token Type            */
             char          *pApiKey;         /* API Key                       */
             void          *pDelegatedCredentialHandle; /* GSSAPI Delegated   */
                                             /* Credential Handle             */
             void          *pReserved1;      /* Reserved.                     */
             void          *pReserved2;      /* Reserved.                     */
             void          *pReserved3;      /* Reserved.                     */
             void          *pReserved4;      /* Reserved.                     */
} db2Credentials;