Retrieve User Information (QSYRUSRI) API

The Retrieve User Information (QSYRUSRI) API provides information about a user profile. This API provides information similar to the Retrieve User Profile (RTVUSRPRF) command or the Display User Profile (DSPUSRPRF) command when *BASIC is specified for the type parameter.

Authorities and Locks

User Profile Authority

*READ

Required Parameter Group

Receiver variable

OUTPUT; CHAR(*)

The variable used to return the information about the user. This variable must be at least 8 bytes long.

Receiver variable length

INPUT; BINARY(4)

The length of the receiver variable. The variable must be 8 bytes long.

Format name

INPUT; CHAR(8)

The name of the format used to return information about the user.

You can specify these formats:

USRI0100	Sign-on and password information is returned. The password itself is not returned.
USRI0200	Authority information is returned.
USRI0300	All user information is returned.

User profile name

INPUT; CHAR(10)

The user name for which information is returned. You can specify the following special value:

*CURRENT

The information for the user currently running is returned.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.

Receiver Variable Description

The following tables describe the order and format of the data returned in the receiver variable. For detailed descriptions of the fields in the tables, see Field Descriptions.

USRI0100 Format

USRI0200 Format

USRI0300 Format

Offset		Type	Field
Dec	Hex
0	0	BINARY(4)	Bytes returned
4	4	BINARY(4)	Bytes available
8	8	CHAR(10)	User profile name
18	12	CHAR(13)	Previous sign-on date and time
31	1F	CHAR(1)	Reserved
32	20	BINARY(4)	Sign-on attempts not valid
36	24	CHAR(10)	Status
46	2E	CHAR(8)	Password change date
54	36	CHAR(1)	No password indicator
55	37	CHAR(1)	Reserved
56	38	BINARY(4)	Password expiration interval
60	3C	CHAR(8)	Date password expires
68	44	BINARY(4)	Days until password expires
72	48	CHAR(1)	Set password to expire
73	49	CHAR(10)	User class name
83	53	CHAR(15)	Special authorities
98	62	CHAR(10)	Group profile name
108	6C	CHAR(10)	Owner
118	76	CHAR(10)	Group authority
128	80	CHAR(10)	Assistance level
138	8A	CHAR(10)	Current library name
148	94	CHAR(10)	Initial menu name
158	9E	CHAR(10)	Initial menu library name
168	A8	CHAR(10)	Initial program name
178	B2	CHAR(10)	Initial program library name
188	BC	CHAR(10)	Limit capabilities
198	C6	CHAR(50)	Text description
248	F8	CHAR(10)	Display sign-on information
258	102	CHAR(10)	Limit device sessions
268	10C	CHAR(10)	Keyboard buffering
278	116	CHAR(2)	Reserved
280	118	BINARY(4)	Maximum allowed storage
284	11C	BINARY(4)	Storage used
288	120	CHAR(1)	Highest scheduling priority
289	121	CHAR(10)	Job description name
299	12B	CHAR(10)	Job description library name
309	134	CHAR(15)	Accounting code
324	144	CHAR(10)	Message queue name
334	14E	CHAR(10)	Message queue library name
344	158	CHAR(10)	Message queue delivery method
354	162	CHAR(2)	Reserved
356	164	BINARY(4)	Message queue severity
360	168	CHAR(10)	Output queue name
370	172	CHAR(10)	Output queue library name
380	17C	CHAR(10)	Print device
390	186	CHAR(10)	Special environment
400	190	CHAR(10)	Attention-key-handling program name
410	19A	CHAR(10)	Attention-key-handling program library name
420	1A4	CHAR(10)	Language ID
430	1AE	CHAR(10)	Country or region ID
440	1B8	BINARY(4)	Character code set ID
444	1BC	CHAR(36)	User options
480	1E0	CHAR(10)	Sort sequence table name
490	1EA	CHAR(10)	Sort sequence table library name
500	1F4	CHAR(10)	Object auditing value
510	1FE	CHAR(64)	User action audit level
574	23E	CHAR(10)	Group authority type
584	248	BINARY(4)	Offset to array of supplemental groups
588	24C	BINARY(4)	Number of supplemental groups
592	250	BINARY(4)	User ID number
596	254	BINARY(4)	Group ID number
600	258	BINARY(4)	Offset to home directory
604	25C	BINARY(4)	Length of home directory
608	260	CHAR(16)	Locale job attributes
624	270	BINARY(4)	Offset to locale path name
628	274	BINARY(4)	Length of locale path name
632	278	CHAR(1)	Group member indicator
633	279	CHAR(1)	Digital certificate indicator
634	27A	CHAR(10)	Character identifier control
644	284	BINARY(4)	Offset to array of independent ASP storage usage descriptors
648	288	BINARY(4)	Number of independent ASP storage usage descriptors
652	28C	BINARY(4)	Number of independent ASP storage usage descriptors returned
656	290	BINARY(4)	Length of an independent ASP storage usage descriptor
660	294	CHAR(1)	Local password management
661	295	CHAR(10)	Block password change
671	29F	CHAR(1)	User entitlement required
672	2A0	BINARY(4)	User expiration interval
676	2A4	CHAR(8)	User expiration date
684	2AC	CHAR(10)	User expiration action
		ARRAY(*) CHAR(10)	Supplemental groups
		CHAR(*)	Home directory
		CHAR(*)	Locale path name
		ARRAY(*) CHAR(*)	Independent ASP storage usage descriptors

Field Descriptions

The accounting code that is associated with this user. If the user does not have an accounting code, this field is blank.

Assistance level. The user interface that the user will use.

The field contains one of the following values:

Attention-key-handling program library name. The name of the library where the program is located. This field can contain the special value of *LIBL. If the program name is a special value, this field is blank.

Attention-key-handling program name. The Attention-key-handling program for this user.

This field may contain one of the following special values:

Block password change. Specifies the time period, in hours, during which a password is blocked from being changed following the prior successful password change operation.

This field may contain one of the following special values:

Bytes available. The number of bytes of data available to be returned to the user. If all data is returned, this is the same as the number of bytes returned. If the receiver variable was not big enough to contain all of the data, this is the number of bytes that can be returned.

Bytes returned. The number of bytes of data returned to the user. This is the lesser of the number of bytes available to be returned or the length of the receiver variable.

Character code set ID. The character code set ID to be used by the system f or this user.

This field can contain the following special value:

Character identifier control. The character identifier control for the user.

This field can contain the following special values:

Country or region ID. The country or region ID used by the system for this user.

This field can contain the following special value:

Current library name. This field contains the name of the user's current library. If the user does not have a current library, this field is *CRTDFT.

Date password expires. The date the user's password expires, in *DTS (System time-stamp) format. If the user's password will not expire (password expiration interval of *NOMAX) or the user's password is set to expire, then this field is blank.

Days until password expires. The number of days until the password will expire.

This field contains one of the following values:

Digital certificate indicator. Whether there are digital certificates associated with this user.

Possible values follow:

Display sign-on information. Whether the sign-on information display is shown when the user signs on.

The field contains one of the following values:

Group authority. The authority the user's group profile has to objects the user creates.

The field contains one of the following values:

Group authority type. The type of authority the user's group profile has to objects the user creates.

The field contains one of the following values:

Group ID number. The group ID number for the user profile. The group ID number is used to identify the user when it is a group and a member of the group is using the integrated file system.

Possible values follow:

Group member indicator. Whether this user is a group that has members.

Possible values follow:

Group profile name. The name of the group profile. If the user does not have a group profile, this field is *NONE.

Highest scheduling priority. The highest scheduling priority the user is allowed to have for each job submitted to the system. The priority is a value from 0 through 9, with 0 being the highest priority.

Home directory. The home directory for this user profile. The home directory is the user's initial working directory. The working directory, associated with a process, is used in path name resolution in the directory file system for path names that do not begin with a slash (/).

The structure for the home directory name returned is:

Independent ASP storage usage descriptors An array of descriptors that contains the name of the independent ASP, the maximum amount of auxiliary storage (in kilobytes) that can be assigned to store permanent objects owned by the user on the independent ASP, and the amount of auxiliary storage (in kilobytes) occupied by this user's owned objects on the independent ASP. If the user does not have a maximum amount of allowed storage on an independent ASP, the maximum storage field in the descriptor will be set to -1 for *NOMAX.

The structure for the independent ASP storage usage descriptor is:

Initial menu name. The initial menu for the user. This field can contain the special value *SIGNOFF.

Initial menu library name. The name of the library that the initial menu is in. This field can contain the special value of *LIBL. If the menu name is *SIGNOFF, this field is blank.

Initial program name. The initial program for the user. If the user does not have an initial program, this field is *NONE.

Initial program library name. The name of the library that the initial program is in. This field can contain the special value of *LIBL. If the program name is *NONE, this field is blank.

Job description name. The name of the job description used for jobs that start through subsystem work station entries.

Job description library name. The name of the library that the job description is in. This field can contain the special value *LIBL.

Keyboard buffering. This field indicates the keyboard buffering value that is used when a job is initialized for this user.

The field contains one of the following values:

Language ID. The language ID used by the system for this user.

This field can contain the following special value:

Length of an independent ASP storage usage descriptor. The length (in bytes) of one independent ASP storage usage descriptor.

Length of home directory. The length (in bytes) of the home directory entry.

Length of locale path name. The length (in bytes) of the locale path name.

Limit capabilities. Whether the user has limited capabilities.

The field contains one of the following values:

Limit device sessions. Specifies if the number of device sessions allowed for a user is limited.

The field contains one of the following values:

Locale job attributes. The job attributes that are taken from the user's locale path name. If a particular job attribute is taken from the locale path name, the specific field is Y (yes). If not, the specific field is N (no).

The possible values follow:

Locale path name. The locale path name that is assigned to the user profile when a job is started. This field can contain a special value or a locale path name. If a special value is returned, the length of the value is 10 and the value returned is one of the following:

If the value returned in this field is not a special value, it is returned in the following format.

Local password management. If password is managed locally, this field contains a Y. If not, this field is N.

Maximum allowed storage. The maximum amount of auxiliary storage (in kilobytes) that can be assigned to store permanent objects owned by the user. If the user does not have a maximum amount of allowed storage, this field contains -1 for *NOMAX.

Message queue name. The name of the message queue that is used by this user.

Message queue library name. The name of the library the message queue is in. This field can contain the special value *LIBL.

Message queue delivery method. How the messages are delivered to the message queue used by the user. This field contains one of the following special values:

Message queue severity. The lowest severity that a message can have and still be delivered to a user in break or notify mode. The severity is a value from 0 through 99.

No password indicator. If *NONE is specified for the password in the user profile, this field contains a Y. If not, this field is N.

Number of independent ASP storage usage descriptors. The total number of independent ASP storage usage descriptors. The number of independent ASP storage usage descriptors will be 0 if the user does not own any objects on any independent ASPs.

Number of independent ASP storage usage descriptors returned. The number of independent ASP storage usage descriptors returned in the array. The number of independent ASP storage usage descriptors will be 0 if the user does not own any objects on any independent ASPs.

Number of supplemental groups. The number of supplemental groups. The number of supplemental groups will be zero if the user does not have any supplemental groups.

Object auditing value. The current user's object auditing value.

Note: The user must have either *ALLOBJ or *AUDIT special authority to retrieve the object auditing value.

The field contains one of the following values:

Offset to array of independent ASP storage usage descriptors. The offset from the beginning of the receiver variable to the start of the array of independent ASP storage usage descriptors.

Offset to array of supplemental groups. The offset from the beginning of the receiver variable to the start of the array of supplemental groups.

Offset to home directory. The offset from the beginning of the receiver variable to the start of the home directory entry.

Offset to locale path name. The offset from the beginning of the receiver variable to the start of the locale path name.

Output queue name. The output queue used by this user.

This field can contain one of the following special values:

Output queue library name. The name of the library where the output queue is located. This field can contain the special value *LIBL. If the output queue is *WRKSTN or *DEV, this field is blank.

Owner. This field indicates who is to own objects created by this user.

The field contains one of the following values:

Password change date. The date the user's password was last changed, in *DTS (System time-stamp) format.

Password expiration interval. The number of days (from 1 through 366) the user's password can remain active before it must be changed.

This field may contain one of the following special values:

Previous sign-on date and time. The date and time the user last signed on. The 13 characters are:

• CHAR(1): Century, where 0 indicates years 19xx and 1 indicates years 20xx.
• CHAR(6): Date, in YYMMDD (year, month, day) format.
• CHAR(6): Time, in HHMMSS (hours, minutes, seconds) format.

If the user has never signed on the system, this field is blank.

Print device. The printer used to print for this user.

This field can contain one of the following special values:

Reserved. An ignored field.

Set password to expire. Whether the user's password is set to expire, requiring the user to change the password when signing on.

This field contains one of the following values:

Sign-on attempts not valid. The number of sign-on attempts that were not valid since the last successful sign-on.

Sort sequence table name. The name of the sort sequence table used for string comparisons. The following possible special values can also be returned:

Sort sequence table library name. The name of the library that is used to locate the sort sequence table. This information is blank if the program does not contain any sort sequence information.

Special authorities. The special authorities the user has. If the user has the special authority, the field is Y. If not, the field is N.

This field contains the following fields:

Special environment. The special environment the user operates in after signing on.

This field contains one of the following special values:

Status. The status of the user profile.

This field contains one of the following values:

Storage used. The amount of auxiliary storage (in kilobytes) occupied by this user's owned objects.

Supplemental groups. The array of supplemental groups for the user profile.

Text description. The descriptive text for the user profile.

User action audit level. The action audit values for this user. If the user has a specific audit value, the field is Y. If not, the field is N. If the user is not allowed to retrieve the action audit level, the field is blank.

Note: The user must have either *ALLOBJ or *AUDIT special authority to retrieve the user action audit level.

This field contains the following:

User class name. This field contains one of the following special values:

User ID number. The user ID (UID) number for the user profile. The UID is used to identify the user when it is using the integrated file system.

User options. The options for users to customize their environment. This field contains the following fields:

• CHAR(1): Show keywords (*CLKWD). Whether the keywords are shown when a CL command is displayed. If the keywords are to be shown, this field is Y. If not, this field is N.
  
  
• CHAR(1): Show detailed information (*EXPERT). Whether more detailed information is shown when the user is defining or changing the system using edit or display object authority. This user option is independent of the ASTLVL parameter on the user profile and the ASTLVL parameter available on commands. If the details are to be shown, this field is Y. If not, this field is N.
  
  
• CHAR(1): Full screen help (*HLPFULL). Whether UIM online help is to be displayed on a full screen or in a window. If the full screen is to be shown, this field is Y. If not, this field is N.
  
  
• CHAR(1): Show status message (*STSMSG). Whether status messages sent to the user are shown. If the status messages are to be shown, this field is Y. If not, this field is N.
  
  
• CHAR(1): Do not show status message (*NOSTSMSG). Whether status messages sent to the user are not shown.
  
  
• CHAR(1): Roll key direction change (*ROLLKEY). Whether the opposite action from the system default for roll keys is taken or not. If the opposite action is to be taken, this field is Y. If not, this field is N.
  
  
• CHAR(1): Printing complete message (*PRTMSG). Whether a message is sent to the user when a spooled file is printed or not. If a message is to sent to the user, this field is Y. If not, this field is N.
  
  
• CHAR(29): Reserved.

User entitlement required. Whether a user entitlement is required for this user profile. This field should be ignored on systems that do not have feature 5052 installed.

Possible values follow:

User expiration action. The action that will occur when the user profile has expired.

This field may contain one of the following special values:

User expiration date. The date, in *DTS (System time-stamp) format when the user profile expires and is automatically disabled or deleted. If the User expiration interval field is not 0, the system generated the user expiration date using the specified interval. If the user profile will not expire, then this field is blank.

User expiration interval. The number of days (from 1 through 366) before the user profile is automatically disabled. If this field is not 0, the User expiration date field contains the date when the user profile expires and is automatically disabled. A user expiration date is generated by the system using the user expiration interval when a user profile is created or when an expired user profile is re-enabled. If the user profile does not have a user expiration interval, this field contains 0.

User profile name. The name of the user profile for which the information is returned.

Error Messages

[ Back to top | Security APIs | APIs by category ]