Open List of Authorized Users (QGYOLAUS) API

  Required Parameter Group:

  Optional Parameter:

  Default Public Authority: *USE

  Threadsafe: No

The Open List of Authorized Users (QGYOLAUS) API provides information about the authorized users of the system. It returns a list of authorized user names that meet the selection criteria specified by the caller of the API and information about those users. This API provides information similar to the Display Authorized Users (DSPAUTUSR) command and the Retrieve Authorized Users (QSYRAUTU) API.

Differences between QSYRAUTU and QGYOLAUS

The QGYOLAUS API returns the same information that the Retrieve Authorized Users (QSYRAUTU) API provides, but takes a complete snapshot at once and allows subsequent records to be obtained through the Get List Entries (QGYGTLE) API.

Authorities and Locks

Authority to User Profiles in List of Authorized Users

Note: Only those profiles to which you have *READ authority are returned in the list.

Required Parameter Group

Receiver variable

The receiver variable that receives the information requested. You can specify the size of the area to be smaller than the format requested as long as you specify the length parameter correctly. As a result, the API returns only the data that the area can hold.

Length of receiver variable

The length of the receiver variable. If the length is larger than the size of the receiver variable, the results are not predictable.

List Information

Information about the list created by this program. For a description of the layout of this parameter, see Open list information format.

Number of records to return

The number of records in the list to put into the receiver variable after filtering and sorting has been done.

If -1 is specified for this parameter, the entire list is built synchronously.

If 0 is specified for this parameter, the entire list is built asynchronously in a server job.

If a positive number of records to return is specified, at least that many records will be built synchronously and the remainder will be built asynchronously in a server job.

Format name

The name of the format that is used to return information about the authorized users.

You can specify these formats:

Selection criteria

This parameter specifies which users are returned. Possible special values follow:

Group profile name

The group profile whose members are to be returned. The profile specified must exist and must be a group profile.

A group profile name or *NOGROUP is required if *MEMBER is specified for the selection criteria. The group profile name must be *NONE if the selection criteria is not *MEMBER.

Error code
I/O; CHAR(*)

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

Optional Parameter

Profile name

The profile names to include in the list. The selection criteria determines which users are included in the list. Specifying a profile name can further limit the names that are returned.

The profile name can be a simple name, a generic name, or the special value *ALL. If not provided, *ALL is used as a default. Possible values follow:

Receiver Variable Description

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

AUTU0100 Format

AUTU0150 Format

AUTU0200 Format

AUTU0250 Format

Field Descriptions

Group members indicator. Whether this user is a group that has members. Possible values follow:

Group profiles. The array of group profiles for the user. The number of group profiles field indicates how many entries are in the array.

Number of group profiles. The number of group profiles that are returned in the group profiles field. The number of group profiles will be zero if the user is not a member of any group.

Profile name. The name of an authorized user for whom information is returned.

Reserved. An ignored field.

Text description. The descriptive text for the user profile.

User or group indicator. Whether this user is a user profile or a group profile. Possible values follow:

Error Messages

API introduced: V4R1

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