XSFL gate, UNFLATTEN_USER_SECURITY function
The UNFLATTEN_USER_SECURITY function of the XSFL gate is used to unflatten the user security state data in the FLATTENED_SECURITY buffer, and add the userid to the security domain.
Input Parameters
- FLATTENED_SECURITY
- is the buffer into which the flattened security state is placed.
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
- ABEND
- ESM_ABENDED
- LOOP
- The following values are returned when RESPONSE is EXCEPTION:
- APPLID_NOTAUTH
- ENTRY_PORT_NOTAUTH
- ESM_INACTIVE
- ESM_TRANQUIL
- GETMAIN_FAILED
- GROUP_ACCESS_REVOKED
- SECLABEL_CHECK_FAILED
- SECURITY_INACTIVE
- UNKNOWN_ESM_RESPONSE
- USERID_NOT_DEFINED
- USERID_NOT_IN_GROUP
- USERID_REVOKED
- The following values are returned when RESPONSE is INVALID:
- INVALID_FLATTENED_BUFFER
- INVALID_FORMAT
- INVALID_FUNCTION
- ACEE_PTR
- is a pointer to the access control environment element, the control block that is generated by an external security manager (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
- 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
- is the 8-bit length of the GROUPID value.
- ENTRY_PORT_NAME
- is the name of an entry port, 1 through 8 alphanumeric characters, for the userid.
- ENTRY_PORT_TYPE
- is the type of the entry port for the userid.
- Values for the parameter are:
- CONSOLE
- NULL
- TERMINAL
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- SECURITY_TOKEN
- is the token identifying the userid.
- USERID
- is the identifier of the user (a userid of 1 through 10 alphanumeric characters). the userid (specified by the SECURITY_TOKEN value) is assigned.
- USERID_LENGTH
- is the length of the USERID value.
- ESM_RESPONSE
- Optional Parameter
- is the optional 32-bit ESM response code to the call.
- SAF_RESPONSE
- Optional Parameter
- is the optional 32-bit SAF response code to the call.