XSAD gate, INQUIRE_USER_ATTRIBUTES function

The INQUIRE_USER_ATTRIBUTES function of the XSAD gate is used to inquire about the attributes of the user represented by the security token.

Input Parameters

SECURITY_TOKEN
is the token identifying the userid.

Output Parameters

REASON
The following values are returned when RESPONSE is DISASTER:
  • ABEND
  • LOOP
The following values are returned when RESPONSE is EXCEPTION:
  • ESTAE_FAILURE
  • EXTRACT_FAILURE
  • INVALID_ACEE
  • INVALID_ESM_PARAMETER
  • INVALID_SECURITY_TOKEN
  • NOTAUTH
  • PROFILE_UNKNOWN
  • SECURITY_INACTIVE
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 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
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.
ESM_RESPONSE
Optional Parameter
is the optional 32-bit ESM response code to the call.
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).
OPCLASS
Optional Parameter
is the operator class, in the range 1 through 24, for the userid.
OPIDENT
Optional Parameter
is the operator identification code, 1 through 3 alphanumeric characters, for the userid.
OPPRTY
Optional Parameter
is the operator priority value, in the range 0 through 255 (where 255 is the highest priority), for the userid.
SAF_RESPONSE
Optional Parameter
is the optional 32-bit SAF response code to the call.
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). the userid (specified by the SECURITY_TOKEN value) is assigned.
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.
XRFSOFF
Optional Parameter
indicates whether or not you want CICS to sign off the userid following an XRF takeover.
Values for the parameter are:
  • FORCE
  • NOFORCE

National language codes (three-characters)

Code Language Name Original Name
AFR Afrikaans Afrikaans
ARA Arabic Arabi
BEL Byelorussian Belaruskaja (mova)
BGR Bulgarian Bulgarski
CAT Catalan Catala
CHT Traditional Chinese Zhongwen
CHS Simplified Chinese  
CSY Czech Cesky
DAN Danish Dansk
DEU German Deutsch
DES Swiss German Schweizer-Deutsch
ELL Greek Ellinika
ENA Australian English  
ENG UK English English
ENU US English  
ENP English Upper Case  
ESP Spanish Espanol
FAR Farsi Persian
FIN Finnish Suomi
FRA French Francais
FRB Belgian French  
FRC Canadian French  
FRS Swiss French Suisse-francais
GAE Irish Gaelic (Irish) Gaeilge
HEB Hebrew Ivrith
HRV Croatian Hrvatski
HUN Hungarian Magyar
ISL Icelandic Islenska
ITA Italian Italiano
ITS Swiss Italian Italiano svizzero
JPN Japanese Nihongo
KOR Korean Choson-o; Hanguk-o
MKD Macedonian Makedonski
NLD Dutch Nederlands
NLB Belgian Dutch  
NOR Norwegian - Bokmal Norsk - Bokmal
NON Norwegian - Nynorsk Norsk - Nynorsk
PLK Polish Polski
PTG Portuguese Portugues
PTB Brazilian Portuguese  
RMS Rhaeto-Romanic Romontsch
ROM Romanian Romana
RUS Russian Russkij
SHC Serbo-Croatian (Cyr) Srpsko-hrvatski
SHL Serbo-Croatian (Lat)  
SKY Slovakian Slovensky
SLO Slovenian Slovenski
SRL Serbian (Latin) Srpski (Latin)
SRB Serbian Srpski
SQI Albanian Shqip
SVE Swedish Svenska
THA Thai Thai
TRK Turkish Turkce
UKR Ukrainian Ukrainska (mova)
URD Urdu Urdu


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