Retrieve User Information (QSYRUSRI) API
Required Parameter Group:
| 1 | Receiver variable | Output | Char(*) |
| 2 | Receiver variable length | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | User profile name | Input | Char(10) |
| 5 | Error Code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: Yes
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.
The QSYS2.USER_INFO, QSYS2.USER_INFO_BASIC, and QSYS2.USER_STORAGE views can be used as alternatives to this API. See USER_INFO view, USER_INFO_BASIC view, and USER_STORAGE view for more information.
Authorities and Locks
- User Profile Authority
- *READ or be authorized to the Database Administrator function of the IBM i through System i™ Navigator's Application Administration support. The Change Function Usage (CHGFCNUSG) command, with a function ID of QIBM_DB_SECADM, can also be used to change the list of users allowed to use the function.
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
| 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) | Display sign-on information |
| 83 | 53 | CHAR(1) | Local password management |
| 84 | 54 | CHAR(10) | Block password change |
USRI0200 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(10) | User class name |
| 28 | 1C | CHAR(15) | Special authorities |
| 43 | 2B | CHAR(10) | Group profile name |
| 53 | 35 | CHAR(10) | Owner |
| 63 | 3F | CHAR(10) | Group authority |
| 73 | 49 | CHAR(10) | Limit capabilities |
| 83 | 53 | CHAR(10) | Group authority type |
| 93 | 5D | CHAR(3) | Reserved |
| 96 | 60 | BINARY(4) | Offset to array of supplemental groups |
| 100 | 64 | BINARY(4) | Number of supplemental groups |
| ARRAY(*) OF CHAR(10) | Supplemental groups | ||
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 |
| 694 | 2B6 | CHAR(2) | Reserved |
| 696 | 2B8 | BINARY(8), UNSIGNED | Maximum allowed storage (long) |
| 704 | 2C0 | BINARY(8), UNSIGNED | Storage used (long) |
 712 |
2C8 | BINARY(4) | Offset to Start Authority Collection (STRAUTCOL) command parameters |
| 716 |
2CC | BINARY(4) | Length of Start Authority Collection (STRAUTCOL) command parameters |
| 720 |
2D0 | CHAR(1) | Authority collection active indicator |
| 721 |
2D1 | CHAR(1) | Authority collection repository exists indicator |
| ARRAY(*) CHAR(10) |
Supplemental groups | ||
| CHAR(*) | Home directory | ||
| CHAR(*) | Locale path name | ||
| ARRAY(*) CHAR(*) |
Independent ASP storage usage descriptors | ||
| |
CHAR(*) | Start Authority Collection (STRAUTCOL) command parameters |
|
Field Descriptions
Accounting code.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:
| *SYSVAL | The system value QASTLVL determines which user interface the user is using. |
| *BASIC | The Operational Assistant user interface. |
| *INTERMED | The system user interface. |
| *ADVANCED | The expert system user interface. |
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:
| *SYSVAL | The system value QATNPGM determines the user's Attention-key-handling program. |
| *NONE | No Attention-key-handling program is used. |
Authority collection active indicator. Whether authority collection is active for this user.
Possible values follow:
| 0 | Authority collection is not active for this user. |
| 1 | Authority collection is active for this user. |
Authority collection repository exists indicator. Whether an authority collection repository exists for this user.
Possible values follow:
| 0 | Authority collection repository does not exist for this user. |
| 1 | Authority collection repository exists for this user. |
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:
| *SYSVAL | The system value QPWDCHGBLK is used to determine the password change limit. |
| *NONE | The password can be changed at any time. |
| 0-99 | Indicates the number of hours a user must wait after the prior successful password change operation before they are able to change the password again. |
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:
| -2 | The system value QCCSID is used to determine the user's character code set ID. |
Character identifier control. The character identifier control for the user.
This field can contain the following special values:
| *SYSVAL | The value QCHRIDCTL system value will be used to determine the CHRID control for this user. |
| *DEVD | The *DEVD special value performs the same function as on the CHRID command parameter for display files, printer files, and panel groups. |
| *JOBCCSID | The *JOBCCSID special value performs the same function as on the CHRID command parameter for display files, printer files, and panel groups. |
Country or region ID. The country or region ID used by the system for this user.
This field can contain the following special value:
| *SYSVAL | The system value QCNTRYID is used to determine the user's country or region ID. |
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:
| 0 | The password is expired. |
| 1-99 | The number of days until the password expires. |
| -1 | The password will not expire within the number of days specified by the password expiration warning (QPWDEXPWRN) system value. |
Delete collection. Whether the authority information previously collected for this user by the STRAUTCOL command is deleted before this authority collection begins.
This field contains one of the following values:
| *NO | The authority collection information for this user is not deleted before this authority collection begins. New authority information is to be added to the existing information. |
| *YES | The authority collection information for this user is deleted before this authority collection begins. |
Detail. The details that are used by the STRAUTCOL command to determine whether an authority check is for a unique instance. One unique instance is collected for each check.
This field contains one of the following values:
| *OBJINF | The authority checking information is collected for each unique instance of the object level information associated with the authority check. |
| *OBJJOB | The authority checking information is collected for each unique instance of the object level information associated with the authority check and each unique instance of the job information associated with the authority check. |
Digital certificate indicator. Whether there are digital certificates associated with this user.
Possible values follow:
| 0 | There are no digital certificates associated with this user. |
| 1 | There is at least one digital certificates associated with this user. |
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:
| *SYSVAL | The system value QDSPSGNINF determines if the sign-on information display is shown when the user signs on. |
| *YES | The sign-on information display is shown when the user signs on. |
| *NO | The sign-on information display is not shown when the user signs on. |
Document library object (DLO) object type. The array of DLO object types that will have authority information collected when an authority check is performed by the system.
The array element may contain one of the following special values:
| *NONE | Authority information will not be collected for document library objects. |
| *ALL | Authority information will be collected for document library objects. |
File system object type. The array of file system object types in the "root" (/), QOpenSys, and user-defined file systems that will have authority information collected when an authority check is performed by the system.
The array element may contain one of the following special values:
| *NONE | Authority information will not be collected for file system objects. |
| *ALL | Authority information will be collected for file system objects. |
Group authority. The authority the user's group profile has to objects the user creates.
The field contains one of the following values:
| *NONE | The group profile has no authority to the objects the user creates. If the user does not have a group profile, the field contains this value. |
| *ALL | The group profile has all authority to the objects the user creates. |
| *CHANGE | The group profile has change authority to the objects the user creates. |
| *USE | The group profile has use authority to the objects the user creates. |
| *EXCLUDE | The group profile has exclude authority to the objects the user creates. |
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:
| *PRIVATE | The group profile has a private authority to the objects the user creates. If the user does not have a group profile, the field contains this value. |
| *PGP | The group profile will be the primary group for objects the user creates. |
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:
| 0 | (*NONE) The user does not have a GID. |
| 1-4294967294 | A valid GID. |
Group member indicator. Whether this user is a group that has members.
Possible values follow:
| 0 | The user is not a group, or is a group but does not have any members. |
| 1 | The user is a group that has members. |
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:
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | CCSID of the returned home directory |
| 4 | 4 | CHAR(2) | Country or region ID |
| 6 | 6 | CHAR(3) | Language ID |
| 9 | 9 | CHAR(3) | Reserved |
| 12 | C | BINARY(4) | Flags |
| 16 | 10 | BINARY(4) | Number of bytes in the home directory name |
| 20 | 14 | CHAR(2) | Home directory delimiter |
| 22 | 16 | CHAR(10) | Reserved |
| 32 | 20 | CHAR(*) | Home directory name value |
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 (4-byte and 8-byte fields), and the amount of auxiliary storage (in kilobytes) occupied by this user's owned objects on the independent ASP (4-byte and 8-byte fields). If the user does not have a maximum amount of allowed storage on an independent ASP, the "Maximum allowed storage" field in the descriptor will be set to -1 for *NOMAX. The "Maximum allowed storage (long)" field in the descriptor will be set to 9,223,372,036,854,775,807 (0x7FFFFFFFFFFFFFFF) for *NOMAX.
If the maximum allowed storage value or the storage used value is larger than 2,147,483,647 kilobytes (the maximum amount a 4-byte field can hold), the corresponding 4-byte field will contain -2. The "Maximum allowed storage (long)" or the "Storage used (long)" field should be used to get the actual value.
The structure for the independent ASP storage usage descriptor is:
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Independent ASP name |
| 10 | A | CHAR(2) | Reserved |
| 12 | C | BINARY(4) | Maximum allowed storage |
| 16 | 10 | BINARY(4) | Storage used |
| 20 | 14 | CHAR(4) | Reserved |
| 24 | 18 | BINARY(8) | Maximum allowed storage (long) |
| 32 | 20 | BINARY(8) | Storage used (long) |
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:
| *SYSVAL | The system value QKBDBUF determines the keyboard buffering value for this user. |
| *YES | The type-ahead and attention-key buffering options are both on. |
| *NO | The type-ahead and attention-key buffering options are not on. |
| *TYPEAHEAD | The type-ahead option is on, but the attention-key buffering option is not. |
Language ID. The language ID used by the system for this user.
This field can contain the following special value:
| *SYSVAL | The system value QLANGID is used to determine the user's language ID. |
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.
Length of Start Authority Collection (STRAUTCOL) command parameters. The length (in bytes) of the STRAUTCOL command parameters. This value will be zero if an authority collection repository does not exist for this user. This value will also be zero if an authority collection repository exists for this user but the receiver variable is not large enough to contain the fixed portion of the STRAUTCOL parameter information structure.
Library name. The array of library and ASP device pairs that will be searched for objects. The first 10 characters of the array element will contain the library name, the second 10 characters will contain the ASP device name. The ASP device name may be *SYSBAS.
The array element may contain one of the following special values in the first 10 characters, the second 10 characters will be blanks:
| *NONE | Authority information for objects in libraries will not be collected. |
| *ALL | All libraries are searched for objects. |
Limit capabilities. Whether the user has limited capabilities.
The field contains one of the following values:
| *PARTIAL | The user cannot change his initial program or current library. |
| *YES | The user cannot change his initial menu, initial program, or current library. The user cannot run commands from the command line. |
| *NO | The user is not limited. |
Limit device sessions. Specifies if the number of device sessions allowed for a user is limited.
The field contains one of the following values:
| *SYSVAL | The system value QLMTDEVSSN determines if the user is limited to a specific number of device sessions. |
| *YES | The user is limited to one device session. |
| *NO | The user is not limited to a specific number of device sessions. |
| 0 | The user is not limited to a specific number of device sessions. This value has the same meaning as *NO. |
| 1 | The user is limited to a single device session. This value has the same meaning as *YES. |
| 2-9 | The user is limited to the specified number of device sessions. |
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:
| *NONE | CHAR(1)
No job attributes are used from the locale path name at the time a job is started for this user profile. |
| *SYSVAL | CHAR(1)
The job attributes assigned from the locale path name are determined by the system value QSETJOBATR at the time a job is started for this user profile. |
| *CCSID | CHAR(1)
The coded character set identifier is set from the locale path name at the time a job is started for this user profile. |
| *DATFMT | CHAR(1)
The date format is set from the locale path name at the time a job is started for this user profile. |
| *DATSEP | CHAR(1)
The date separator is set from the locale path name at the time a job is started for this user profile. |
| *SRTSEQ | CHAR(1)
The sort sequence is set from the locale path name at the time a job is started for this user profile. |
| *TIMSEP | CHAR(1)
The time separator is set from the locale path name at the time a job is started for this user profile. |
| *DECFMT | CHAR(1)
The decimal format is set from the locale path name at the time a job is started for this user profile. |
| Reserved | CHAR(8)
An ignored field. |
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:
| *C | The C locale path name is assigned. |
| *NONE | No locale path name is assigned. |
| *POSIX | The POSIX locale path name is assigned. |
| *SYSVAL | The QLOCALE system value is used to determine the locale path name. |
If the value returned in this field is not a special value, it is returned in the following format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | CCSID |
| 4 | 4 | CHAR(2) | Country or region ID |
| 6 | 6 | CHAR(3) | Language ID |
| 9 | 9 | CHAR(3) | Reserved |
| 12 | C | BINARY(4) | Flags |
| 16 | 10 | BINARY(4) | Locale path name length |
| 20 | 14 | CHAR(2) | Locale path name delimiter character |
| 22 | 16 | CHAR(10) | Reserved |
| 32 | 20 | CHAR(*) | Locale path name |
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. If the maximum allowed storage value is larger than 2,147,483,647 kilobytes (the maximum amount a 4-byte field can hold), this field will contain -2. The field "Maximum allowed storage (long)" should be used instead of this field to get the actual value.
Maximum allowed storage (long). 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 9,223,372,036,854,775,807 (0x7FFFFFFFFFFFFFFF) 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:
| *BREAK | The job to which the message queue is assigned is interrupted when a message arrives on the message queue. |
| *DFT | Messages requiring replies are answered with their default reply. |
| *HOLD | The messages are held in the message queue until they are requested by the user or program. |
| *NOTIFY | The job to which the message queue is assigned is notified when a message arrives on the message queue. |
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 Document library object (DLO) object types. The number of DLO object type array elements contained in the STRAUTCOL parameter information structure. This value will be zero if the receiver variable is not large enough to contain all of the DLO object type array elements and all of the STRAUTCOL variable length data that is put into the receiver variable before these values.
Number of file system object types. The number of file system object type array elements contained in the STRAUTCOL parameter information structure. This value will be zero if the receiver variable is not large enough to contain all of the file system object type array elements and all of the STRAUTCOL variable length data that is put into the receiver variable before these values.
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 library names. The number of library and ASP device name array elements contained in the STRAUTCOL parameter information structure. This value will be zero if the receiver variable is not large enough to contain all of the library and ASP device name array elements and all of the STRAUTCOL variable length data that is put into the receiver variable before these values.
Number of object names. The number of object name array elements contained in the STRAUTCOL parameter information structure. This value will be zero if the receiver variable is not large enough to contain all of the object name array elements and all of the STRAUTCOL variable length data that is put into the receiver variable before these values.
Number of object types. The number of object type array elements contained in the STRAUTCOL parameter information structure. This value will be zero if the receiver variable is not large enough to contain all of the object type array elements and all of the STRAUTCOL variable length data that is put into the receiver variable before these values.
Number of omit library names. The number of omit library and ASP device name array elements contained in the STRAUTCOL parameter information structure. This value will be zero if the receiver variable is not large enough to contain all of the omit library and ASP device name array elements and all of the STRAUTCOL variable length data that is put into the receiver variable before these values.
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:
| *NONE | No additional object auditing is done for the current user. |
| *CHANGE | Object changes are audited for the current user if the object's auditing value is *USRPRF. |
| *ALL | Object read and change operations are audited for the current user if the object's auditing value is *USRPRF. |
| *NOTAVL | The user is not allowed to retrieve the object auditing value. |
Object name. The array of objects for which authority information will be collected when an authority check is performed by the system.
The array element may contain one of the following special values:
| *NONE | Authority information will not be collected for objects. This value will be returned when the library name field is *NONE. |
| *ALL | Authority information will be collected for all objects. |
Object type. Objects of these object types will have authority information collected when an authority check is performed by the system.
The array element may contain one of the following special values:
| *NONE | Authority information will not be collected for object types. This value will be returned when the library name field is *NONE. |
| *ALL | Authority information will be collected for all supported object types in the QSYS file system. |
Offset to array of Document library object (DLO) object types. The offset from the beginning of the STRAUTCOL parameter information structure to the start of the array of DLO object types. This value will be zero if the receiver variable is not large enough to contain all of the DLO object type array elements and all of the STRAUTCOL variable length data that is put into the receiver variable before these values.
Offset to array of file system object types. The offset from the beginning of the STRAUTCOL parameter information structure to the start of the array of file system object types. This value will be zero if the receiver variable is not large enough to contain all of the file system object type array elements and all of the STRAUTCOL variable length data that is put into the receiver variable before these 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 library names. The offset from the beginning of the STRAUTCOL parameter information structure to the start of the array of library and ASP device names. This value will be zero if the receiver variable is not large enough to contain all of the library and ASP device name array elements and all of the STRAUTCOL variable length data that is put into the receiver variable before these values.
Offset to array of object names. The offset from the beginning of the STRAUTCOL parameter information structure to the start of the array of object names. This value will be zero if the receiver variable is not large enough to contain all of the object name array elements and all of the STRAUTCOL variable length data that is put into the receiver variable before these values.
Offset to array of object types. The offset from the beginning of the STRAUTCOL parameter information structure to the start of the array of object types. This value will be zero if the receiver variable is not large enough to contain all of the object type array elements and all of the STRAUTCOL variable length data that is put into the receiver variable before these values.
Offset to array of omit library names. The offset from the beginning of the STRAUTCOL parameter information structure to the start of the array of omit library and ASP device names. This value will be zero if the receiver variable is not large enough to contain all of the omit library and ASP device name array elements and all of the STRAUTCOL variable length data that is put into the receiver variable before these values.
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.
Offset to Start Authority Collection
(STRAUTCOL) command parameters.
The offset from the beginning of the receiver variable to the start of the
STRAUTCOL command parameters. This value will be zero if an authority collection repository does not exist for this user. This value will also be zero if an authority collection repository exists for this user but the receiver variable is not large enough to contain the fixed portion of the STRAUTCOL parameter information structure.
Omit library name. The array of omit library and ASP device pairs that will be excluded from the authority collection operation. The first 10 characters of the array element will contain the omit library name, the second 10 characters will contain the ASP device name. The ASP device name may be *SYSBAS.
The array element may contain the following special value in the first 10 characters, the second 10 characters will be blanks:
| *NONE | No libraries will be excluded from the authority collection operation. |
Output queue name. The output queue used by this user.
This field can contain one of the following special values:
| *WRKSTN | The output queue assigned to the user's work station is used. |
| *DEV | An output queue with the same name as the device specified in the printer device parameter is used by the user. |
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:
| *USRPRF | The user owns any objects the user creates. If the user does not have a group profile, the field contains this value. |
| *GRPPRF | The user's group profile owns any objects the user creates. |
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:
| 0 | The system value QPWDEXPITV is used to determine the user's password expiration interval. |
| -1 | The user's password does not expire (*NOMAX). |
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:
| *WRKSTN | The printer assigned to the user's work station is used. |
| *SYSVAL | The default system printer specified in the system value QPRTDEV is used. |
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:
| Y | The user's password is set to expire. |
| N | The user's password is not set to expire. |
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:
| *HEX | The hexadecimal values of the characters are used to determine the sort sequence. |
| *LANGIDUNQ | A unique-weight sort table associated with the language specified. |
| *LANGIDSHR | A shared-weight sort table associated with the language specified. |
| *SYSVAL | The system value QSRTSEQ. |
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:
| *ALLOBJ | CHAR(1)
All object. Whether the user has all object special authority. |
| *SECADM | CHAR(1)
Security administrator. Whether the user has security administrator special authority. |
| *JOBCTL | CHAR(1)
Job control. Whether the user has job control special authority. |
| *SPLCTL | CHAR(1)
Spool control. Whether the user has spool control special authority. |
| *SAVSYS | CHAR(1)
Save system. Whether the user has save system special authority. |
| *SERVICE | CHAR(1)
Service. Whether the user has service special authority. |
| *AUDIT | CHAR(1)
Audit. Whether the user has audit special authority. |
| *IOSYSCFG | CHAR(1)
Input/output system configuration. Whether the user has input/output system configuration special authority. |
| Reserved | CHAR(7)
An ignored field. |
Special environment. The special environment the user operates in after signing on.
This field contains one of the following special values:
| *SYSVAL | The system value QSPCENV is used to determine the user's special environment. |
| *NONE | The user operates in the IBM i environment. |
| *S36 | The user operates in the System/36™ environment. |
Start Authority Collection (STRAUTCOL)
command parameters. The authority collection information available for this user was
collected using these parameter values the last time the STRAUTCOL command was run.
The structure for the STRAUTCOL parameter information is:
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Offset to array of library names |
| 4 | 4 | BINARY(4) | Number of library names |
| 8 | 8 | BINARY(4) | Offset to array of object names |
| 12 | C | BINARY(4) | Number of object names |
| 16 | 10 | BINARY(4) | Offset to array of object types |
| 20 | 14 | BINARY(4) | Number of object types |
| 24 | 18 | BINARY(4) | Offset to array of Document library object (DLO) object types |
| 28 | 1C | BINARY(4) | Number of Document library object (DLO) object types |
| 32 | 20 | BINARY(4) | Offset to array of file system object types |
| 36 | 24 | BINARY(4) | Number of file system object types |
| 40 | 28 | BINARY(4) | Offset to array of omit library names |
| 44 | 2C | BINARY(4) | Number of omit library names |
| 48 | 30 | CHAR(4) | Delete collection |
| 52 | 48 | CHAR(10) | Detail |
| ARRAY(*) CHAR(20) |
Library name CHAR(10) Library ASP device name CHAR(10) |
||
| ARRAY(*) CHAR(10) |
Object name | ||
| ARRAY(*) CHAR(10) |
Object type | ||
| ARRAY(*) CHAR(10) |
Document library object (DLO) object type | ||
| ARRAY(*) CHAR(10) |
File system object type | ||
| ARRAY(*) CHAR(20) |
Omit library name CHAR(10) Omit library ASP device name CHAR(10) |
||
Status. The status of the user profile.
This field contains one of the following values:
| *ENABLED | The user profile is enabled; therefore, the user is able to sign on. |
| *DISABLED | The user profile is disabled; therefore, the user cannot sign on. |
Storage used. The amount of auxiliary storage (in kilobytes) occupied by this user's owned objects. If the storage used value is larger than 2,147,483,647 kilobytes (the maximum amount a 4-byte field can hold), this field will contain -2. The field "Storage used (long)" should be used instead of this field to get the actual value.
Storage used (long). 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:
| *CMD | CHAR(1)
The user has the *CMD audit value specified in the user profile. |
| *CREATE | CHAR(1)
The user has the *CREATE audit value specified in the user profile. |
| *DELETE | CHAR(1)
The user has the *DELETE audit value specified in the user profile. |
| *JOBDTA | CHAR(1)
The user has the *JOBDTA audit value specified in the user profile. |
| *OBJMGT | CHAR(1)
The user has the *OBJMGT audit value specified in the user profile. |
| *OFCSRV | CHAR(1)
The user has the *OFCSRV audit value specified in the user profile. |
| *PGMADP | CHAR(1)
The user has the *PGMADP audit value specified in the user profile. |
| *SAVRST | CHAR(1)
The user has the *SAVRST audit value specified in the user profile. |
| *SECURITY | CHAR(1)
The user has the *SECURITY audit value specified in the user profile. |
| *SERVICE | CHAR(1)
The user has the *SERVICE audit value specified in the user profile. |
| *SPLFDTA | CHAR(1)
The user has the *SPLFDTA audit value specified in the user profile. |
| *SYSMGT | CHAR(1)
The user has the *SYSMGT audit value specified in the user profile. |
| *OPTICAL | CHAR(1)
The user has the *OPTICAL audit value specified in the user profile. |
| *AUTFAIL | CHAR(1)
The user has the *AUTFAIL audit value specified in the user profile. |
| *JOBBAS | CHAR(1)
The user has the *JOBBAS audit value specified in the user profile. |
| *JOBCHGUSR | CHAR(1)
The user has the *JOBCHGUSR audit value specified in the user profile. |
| *NETBAS | CHAR(1)
The user has the *NETBAS audit value specified in the user profile. |
| *NETCLU | CHAR(1)
The user has the *NETCLU audit value specified in the user profile. |
| *NETCMN | CHAR(1)
The user has the *NETCMN audit value specified in the user profile. |
| *NETFAIL | CHAR(1)
The user has the *NETFAIL audit value specified in the user profile. |
| *NETSCK | CHAR(1)
The user has the *NETSCK audit value specified in the user profile. |
| *PGMFAIL | CHAR(1)
The user has the *PGMFAIL audit value specified in the user profile. |
| *PRTDTA | CHAR(1)
The user has the *PRTDTA audit value specified in the user profile. |
| *SECCFG | CHAR(1)
The user has the *SECCFG audit value specified in the user profile. |
| *SECDIRSRV | CHAR(1)
The user has the *SECDIRSRV audit value specified in the user profile. |
| *SECIPC | CHAR(1)
The user has the *SECIPC audit value specified in the user profile. |
| *SECNAS | CHAR(1)
The user has the *SECNAS audit value specified in the user profile. |
| *SECRUN | CHAR(1)
The user has the *SECRUN audit value specified in the user profile. |
| *SECSCKD | CHAR(1)
The user has the *SECSCKD audit value specified in the user profile. |
| *SECVFY | CHAR(1)
The user has the *SECVFY audit value specified in the user profile. |
| *SECVLDL | CHAR(1)
The user has the *SECVLDL audit value specified in the user profile. |
| *NETSECURE |
CHAR(1)
The user has the *NETSECURE audit value specified in the user profile. |
| *NETUDP |
CHAR(1)
The user has the *NETUDP audit value specified in the user profile. |
| Reserved |
CHAR(31)
An ignored field.
|
User class name. This field contains one of the following special values:
| *SECOFR | The user has a class of security officer. |
| *SECADM | The user has a class of security administrator. |
| *PGMR | The user has a class of programmer. |
| *SYSOPR | The user has a class of system operator. |
| *USER | The user has a class of end user. |
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:
| 0 | A user entitlement is not required for this user profile. |
| 1 | A user entitlement is required for this user profile. |
User expiration action. The action that will occur when the user profile has expired.
This field may contain one of the following special values:
| *NONE | The user profile will not expire. |
| *DISABLE | The user profile will be disabled. |
| *DELETE | The user profile will be deleted. If the user profile cannot be deleted, it will be disabled. Note this action was set using the Change Expiration Schedule Entry (CHGEXPSCDE) command. Use the Display Expiration Schedule (DSPEXPSCD) command to display the additional fields that will be used to delete the user profile. |
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
| Message ID | Error Message Text |
|---|---|
| CPF22DF E | Unable to process request for user profile &1. |
| CPF2203 E | User profile &1 not correct. |
| CPF2204 E | User profile &1 not found. |
| CPF2213 E | Not able to allocate user profile &1. |
| CPF2225 E | Not able to allocate internal system object. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF9801 E | Object &2 in library &3 not found. |
| CPF9802 E | Not authorized to object &2 in &3. |
| CPF9803 E | Cannot allocate object &2 in library &3. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPF9838 E | User profile storage limit exceeded. |
API introduced: V2R2
[ Back to top | Security APIs | APIs by category ]