USAD gate, INQUIRE_DEFAULT_USER function

The INQUIRE_DEFAULT_USER function of the USAD gate is used to inquire about the attributes of the default user (specified on the DFLTUSER system initialization parameter).

Output Parameters

REASON
The following values are returned when RESPONSE is DISASTER:
  • ABEND
  • ADD_TIMEOUT_ENTRY_FAILED
  • DEL_EXPIRED_ENTRY_FAILED
  • DEL_TIMEOUT_ENTRY_FAILED
  • DIR_MANAGER_ADD_FAILED
  • DIR_MANAGER_DELETE_FAILED
  • DIR_MANAGER_LOCATE_FAILED
  • EXTRACT_FAILED
  • FREEMAIN_FAILED
  • GETMAIN_FAILED
  • INQUIRE_PW_DATA_FAILED
  • LOOP
  • SEC_DOMAIN_ADD_FAILED
  • SEC_DOMAIN_DELETE_FAILED
The following values are returned when RESPONSE is EXCEPTION:
  • ACCOUNT_INVALID
  • ALREADY_SIGNED_ON
  • APPLICATION_NOTAUTH
  • DEFAULT_USER_TOKEN
  • ENQ_LIMIT_EXCEEDED
  • ENTRY_PORT_NOTAUTH
  • ESM_INACTIVE
  • ESM_TRANQUIL
  • GROUP_ACCESS_REVOKED
  • INVALID_GROUPID
  • INVALID_NEW_PASSWORD
  • INVALID_OIDCARD
  • INVALID_PARAMETERS
  • INVALID_PASSWORD
  • INVALID_USER_TOKEN
  • INVALID_USERID
  • NEW_PASSWORD_REQUIRED
  • OIDCARD_REQUIRED
  • PASSWORD_REQUIRED
  • SECLABEL_CHECK_FAILED
  • SECURITY_INACTIVE
  • UNKNOWN_ESM_RESPONSE
  • USER_NOT_LOCATED
  • USERID_NOT_DEFINED
  • USERID_NOT_DETERMINED
  • USERID_NOT_FOUND
  • USERID_NOT_IN_GROUP
  • USERID_REVOKED
The following values are returned when RESPONSE is INVALID:
  • INVALID_FORMAT
  • INVALID_FUNCTION
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.
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:
  1. CICS rounds values up to the nearest multiple of 5.
  2. 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


dfhs3_USADinquire_default_user.html | Timestamp icon Last updated: Monday, 5 June 2017