Installable services interface reference information

Installable services interface reference information

This collection of topics provides reference information for the installable services.

The functions and data types are listed in alphabetical order within the group for each service type.

How the functions are shown
How the installable services functions are documented.
MQZ_AUTHENTICATE_USER - Authenticate user
This function is provided by an MQZAS_VERSION_5 authorization service component, and is invoked by the queue manager to authenticate a user, or to set identity context fields. It is invoked when the IBM MQ user application context is established.
MQZ_CHECK_AUTHORITY - Check authority
This function is provided by a MQZAS_VERSION_1 authorization service component, and is started by the queue manager to check whether an entity has authority to perform a particular action, or actions, on a specified object.
MQZ_CHECK_AUTHORITY_2 - Check authority (extended)
This function is provided by a MQZAS_VERSION_2 authorization service component, and is started by the queue manager to check whether an entity has authority to perform a particular action, or actions, on a specified object.
MQZ_CHECK_PRIVILEGED - Check if user is privileged
This function is provided by an MQZAS_VERSION_6 authorization service component, and is invoked by the queue manager to determine whether a specified user is a privileged user.
MQZ_COPY_ALL_AUTHORITY - Copy all authority
This function is provided by an authorization service component. It is started by the queue manager to copy all of the authorizations that are currently in force for a reference object to another object.
MQZ_DELETE_AUTHORITY - Delete authority
This function is provided by an authorization service component, and is started by the queue manager to delete all of the authorizations associated with the specified object.
MQZ_ENUMERATE_AUTHORITY_DATA - Enumerate authority data
This function is provided by an MQZAS_VERSION_4 authorization service component, and is started repeatedly by the queue manager to retrieve all of the authority data that matches the selection criteria specified on the first invocation.
MQZ_FREE_USER - Free user
This function is provided by a MQZAS_VERSION_5 authorization service component, and is started by the queue manager to free associated allocated resource.
MQZ_GET_AUTHORITY - Get authority
This function is provided by a MQZAS_VERSION_1 authorization service component, and is started by the queue manager to retrieve the authority that an entity has to access the specified object, including (if the entity is a principal) authorities possessed by the groups in which the principal is a member. Authorities from generic profiles are included in the returned authority set.
MQZ_GET_AUTHORITY_2 - Get authority (extended)
This function is provided by a MQZAS_VERSION_2 authorization service component, and is started by the queue manager to retrieve the authority that an entity has to access the specified object.
MQZ_GET_EXPLICIT_AUTHORITY - Get explicit authority
This function is provided by a MQZAS_VERSION_1 authorization service component, and is started by the queue manager to retrieve the authority that an entity has to access the specified object, including (if the entity is a principal) authorities possessed by the groups in which the principal is a member. Authorities from generic profiles are included in the returned authority set.
MQZ_GET_EXPLICIT_AUTHORITY_2 - Get explicit authority (extended)
This function is provided by a MQZAS_VERSION_2 authorization service component, and is started by the queue manager to retrieve the authority that a named group has to access a specified object (but without the additional authority of the nobody group), or the authority that the primary group of the named principal has to access a specified object.
MQZ_INIT_AUTHORITY - Initialize authorization service
This function is provided by an authorization service component, and is started by the queue manager during configuration of the component. It is expected to call MQZEP in order to provide information to the queue manager.
MQZ_INQUIRE - Inquire authorization service
This function is provided by a MQZAS_VERSION_5 authorization service component, and is started by the queue manager to query the supported functionality.
MQZ_REFRESH_CACHE - Refresh all authorizations
This function is provided by an MQZAS_VERSION_3 authorization service component, and is invoked by the queue manager to refresh the list of authorizations held internally by the component.
MQZ_SET_AUTHORITY - Set authority
This function is provided by a MQZAS_VERSION_1 authorization service component, and is started by the queue manager to set the authority that an entity has to access the specified object.
MQZ_SET_AUTHORITY_2 - Set authority (extended)
This function is provided by a MQZAS_VERSION_2 authorization service component, and is started by the queue manager to set the authority that an entity has to access the specified object.
MQZ_TERM_AUTHORITY - Terminate authorization service
This function is provided by an authorization service component, and is started by the queue manager when it no longer requires the services of this component. The function must perform any cleanup required by the component.
MQZ_DELETE_NAME - Delete name
This function is provided by a name service component, and is started by the queue manager to delete an entry for the specified queue.
MQZ_INIT_NAME - Initialize name service
This function is provided by a name service component, and is started by the queue manager during configuration of the component. It is expected to call MQZEP in order to provide information to the queue manager.
MQZ_INSERT_NAME - Insert name
This function is provided by a name service component, and is started by the queue manager to insert an entry for the specified queue, containing the name of the queue manager that owns the queue. If the queue is already defined in the service, the call fails.
MQZ_LOOKUP_NAME - Lookup name
This function is provided by a name service component, and is started by the queue manager to retrieve the name of the owning queue manager, for a specified queue.
MQZ_TERM_NAME - Terminate name service
This function is provided by a name service component, and is started by the queue manager when it no longer requires the services of this component. The function must perform any cleanup required by the component.
MQZAC - Application context
The MQZAC structure is used on the MQZ_AUTHENTICATE_USER call for the ApplicationContext parameter. This parameter specifies data related to the calling application.
MQZAD - Authority data
The MQZAD structure is used on the MQZ_ENUMERATE_AUTHORITY_DATA call for two parameters, one input and one output.
MQZED - Entity descriptor
The MQZED structure is used in a number of authorization service calls to specify the entity for which authorization is to be checked.
MQZEP - Add component entry point
A service component starts this function, during initialization, to add an entry point to the entry point vector for that service component.
MQZFP - Free parameters
The MQZFP structure is used on the MQZ_FREE_USER call for the FreeParms parameter. This parameter specifies data related to resource to be freed.
MQZIC - Identity context
The MQZIC structure is used on the MQZ_AUTHENTICATE_USER call for the IdentityContext parameter.
Parent topic: User exits, API exits, and installable services reference

Related information

Installable services and components for UNIX, Linux and Windows
Configure installable services
Installable services and components for IBM i
Installable services interface reference information for IBMi