USAD gate, INQUIRE_USER function
The INQUIRE_USER function of the USAD gate is used to inquire about the attributes of the user represented by the user token.
Input Parameters
- USER_TOKEN
- is the token identifying the userid in the user domain.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- INVALID_USER_TOKEN
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- ACEE_PTR
- Optional Parameter
- is a pointer to the access control environment element, the control block that is generated by an external user (ESM) when the user signs on. If the user is not signed on, the address of the CICS DFLTUSER's ACEEis returned. If an ACEE does not exist, CICS sets the pointer reference to the null value, X'FF000000'.
- CURRENT_GROUPID
- Optional Parameter
- is the identifier, 1 through 10 alphanumeric characters, of the current RACF user group to which the userid (specified by the SECURITY_TOKEN value) is assigned.
- CURRENT_GROUPID_LENGTH
- Optional Parameter
- is the 8-bit length of the GROUPID value.
- ENTRY_PORT_NAME
- Optional Parameter
- is the name of the entry port assigned to the userid.
- ENTRY_PORT_TYPE
- Optional Parameter
- is the type of the entry port assigned to the userid. This parameter is only valid if ENTRY_PORT_NAME is also specified.
- Values for the parameter are:
- TERMINAL
- CONSOLE
- NATIONAL_LANGUAGE
- Optional Parameter
- is a three-character code identifying the national language for the userid. It can have any of the values in National language codes (three-characters).
- OPERATOR_CLASSES
- Optional Parameter
- identifies the operator classes to which the user belongs. This is a 24-bit value, with each bit determining whether or not the user is a member of that class.
- OPERATOR_IDENT
- Optional Parameter
- is the operator identification code, 1 through 3 alphanumeric characters, for the userid.
- OPERATOR_PRIORITY
- Optional Parameter
- is the operator priority value, in the range 0 through 255 (where 255 is the highest priority), for the userid.
- TIMEOUT
- Optional Parameter
- is the number of minutes, in the range 0 through 60, that must
elapse since the user last used the terminal before CICS "times-out"
the terminal.
- CICS rounds values up to the nearest multiple of 5.
- A TIMEOUT value of 0 means that the terminal is not timed out.
- USERID
- Optional Parameter
- is the identifier of the user (a userid of 1 through 10 alphanumeric characters).
- USERID_LENGTH
- Optional Parameter
- is the length of the USERID value.
- USERNAME
- Optional Parameter
- is an optional buffer into which the attributes of the user are placed.
- XRF_REFLECTABLE
- Optional Parameter
- indicates whether or not you want CICS to sign off the userid following an XRF takeover.
- Values for the parameter are:
- NO
- YES