tibemsConnectionFactory_SetOAuth2Params

Function

Purpose

Set the connection factory’s default OAuth 2.0 parameters.

C Declaration

tibems_status tibemsConnectionFactory_SetOAuth2Params(
    tibemsConnectionFactory factory,
    tibemsOAuth2Params oauth2params );

IBM Systems

This function is not supported in COBOL, and on z/OS and IBM i systems.

Parameters

Parameter Description
factory Set the default OAuth 2.0 parameters of this connection factory.
oauth2params The connection uses the parameters configured in this object to obtain OAuth 2.0 access tokens.

Remarks

If OAuth 2.0 parameters are set in a connection factory via this function, all connections created using that factory will attempt to obtain OAuth 2.0 access tokens and include them in the connection requests to the EMS server.

Connections will determine how to obtain OAuth 2.0 access tokens by checking the configured OAuth 2.0 parameters. If the parameters contain a configured access token, that token is directly used. Otherwise, if the parameters contain a user-defined callback, the connections will invoke that callback whenever they require an access token. If neither of these are present, the connections will use the parameters to obtain access tokens from an OAuth 2.0 authorization server via an OAuth 2.0 grant.

See Also

tibemsOAuth2Params and Environment Variables