List Authorized Users (QSYLAUTU) API
Required Parameter Group:
| 1 | Qualified user space name | Input | Char(20) |
| 2 | Format name | Input | Char(8) |
| 3 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: Yes
The List Authorized Users (QSYLAUTU) API puts a list of authorized system users into a user space.
This API provides information similar to the Display Authorized Users (DSPAUTUSR) command.
Authorities and Locks
- User Space Authority
- *CHANGE
- Authority to Library Containing User Space
- *EXECUTE
- Authority to User Profiles in List of Authorized Users
- *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. 
Note:
If you are not authorized to the Database Administrator function of the IBM i, only those profiles to which you have *READ authority are returned.
Required Parameter Group
- Qualified user space name
- INPUT; CHAR(20)
The name of the existing user space that the list of authorized users is returned to. The first 10 characters specify the user space name, and the second 10 characters specify the library.
You can use these special values for the library name:
*CURLIB The current library is searched for the user space. If there is no current library, QGPL (general purpose library) is used. *LIBL The library list is searched for the user space.
- Format name
- INPUT; CHAR(8)
The name of the format used to list the authorized users.
You can specify these formats:
AUTU0100 Each entry contains the user name, group names, an indicator that specifies whether the user is a user profile or a group profile, and an indicator that specifies whether the user is a group that has members. AUTU0200 Each entry contains the same information as AUTU0100 plus the text description for the user.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
User Space Variables
The following tables describe the order and format of the data returned in the user space. For detailed descriptions of the fields in the tables, see Field Descriptions.
Input Parameter Section
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User space name |
| 10 | 0A | CHAR(10) | User space library name |
| 20 | 14 | CHAR(8) | Format name |
AUTU0100 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User profile name |
| 10 | 0A | CHAR(10) | Group name |
| 20 | 14 | BINARY(4) | Number of supplemental groups |
| 24 | 18 | ARRAY(15) OF CHAR(10) | Supplemental groups |
| 174 | AE | CHAR(1) | User or group indicator |
| 175 | AF | CHAR(1) | Group member indicator |
AUTU0200 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User profile name |
| 10 | 0A | CHAR(10) | Group name |
| 20 | 14 | CHAR(50) | Text name |
| 70 | 46 | CHAR(2) | Reserved |
| 72 | 48 | BINARY(4) | Number of supplemental groups |
| 76 | 4C | ARRAY(15) OF CHAR(10) | Supplemental groups |
| 226 | E2 | CHAR(1) | User or group indicator |
| 227 | E3 | CHAR(1) | Group member indicator |
Field Descriptions
Format name. The name of the format used to list authorized users.
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. This value is returned if the user or group indicator field is 0. |
| 1 | The user is a group that has members. |
Group name. The name of the user's group profile. If the user does not have a group profile, this field contains *NONE.
Number of supplemental groups. The number of supplemental groups returned in the supplemental groups field. The number of supplemental groups will be zero if the user does not have any supplemental groups.
Reserved. An ignored field.
Supplemental groups. The array of supplemental groups for the user profile. The number of supplemental groups field will indicate how many entries there are in the array.
Text name. The text description for the authorized user.
User profile name. The name of the authorized user.
User space name. The name of the user space used to return the list of authorized users on the system.
User space library name. The name of the library containing the user space.
User or group indicator. Whether this user is a user profile or a group profile.
Possible values follow:
| 0 | User profile (profile does not have a GID) |
| 1 | Group profile (profile has a GID) |
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF2225 E | Not able to allocate internal system object. |
| CPF3CAA E | List is too large for user space &1. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C21 E | Format name &1 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. |
| CPF9807 E | One or more libraries in library list deleted. |
| CPF9808 E | Cannot allocate one or more libraries on library list. |
| CPF9810 E | Library &1 not found. |
| CPF9820 E | Not authorized to use library &1. |
| CPF9830 E | Cannot assign library &1. |
| CPF9838 E | User profile storage limit exceeded. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V4R4
[ Back to top | Security APIs | APIs by category ]