List NetWare Authentication Entries (QfpzListNtwAutE) API


  Required Parameter Group:

1 Qualified user space name Input Char(20)
2 Entry identifier data Input Char(*)
3 Length of entry qualifier Input Binary(4)
4 Entry identifier format name Input Char(8)
5 Error code I/O Char(*)

  Default Public Authority: *USE

  Library Name/Service Program: QFPNTWE/QFPZAAPI

  Threadsafe: No

The List NetWare Authentication Entries (QfpzListNtwAutE) API returns a list of authentication entries in a user profile. All entries may be returned, or only those entries that match specified criteria can be requested.

Authorities and Locks

User Profile Authority
The user profile must be the current user profile, or the caller must have *USE and *OBJMGT authority to the user profile and *SECADM special authority.
User Space Authority
*CHANGE
User Space Library Authority
*USE
User Space Lock
*EXCLRD


Required Parameter Group

Qualified user space name
INPUT; CHAR(20)

The user space that receives the information, and the library in which it is located. The first 10 characters contain the user space name, and the second 10 characters contain the library name.

You can use these special values for the library name:

*CURLIB The job's current library
*LIBL The library list

Entry identifier data
INPUT; CHAR(*)

The authentication entries to be retrieved. The content and format of this structure are determined by the format name. See Format of Authentication Entry Identifier for a description of these formats.

Length of entry identifier
INPUT; BINARY(4)

The length of the authentication entry identifier structure.

Entry identifier format name
INPUT; CHAR(8)

The content and format of the authentication entry identifier data. Each format corresponds to a method of identifying an authentication entry.

The possible format names follow:

AUTE0100 The NetWare Version 3.x server entry is identified by the server name.
AUTE0200 The NetWare Directory Services tree entry is identified by the NDS tree name.
AUTE0900 All authentication entries in a user profile are retrieved.

Error code
I/O; CHAR(*)

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


Format of Authentication Entry Identifier

For details about the format of the entry identifier data, see the following sections. For details about the fields in each format, see Field Descriptions.


AUTE0100 Format

Offset Type Field
Dec Hex
0 0 BINARY(4) Offset to selected server name
4 4 BINARY(4) Length of selected server name
8 8 CHAR(10) User profile name
18 12 CHAR(6) Reserved
    CHAR(*) Selected server name


AUTE0200 Format

Offset Type Field
Dec Hex
0 0 BINARY(4) Offset to selected NDS tree name
4 4 BINARY(4) Length of selected NDS tree name
8 8 CHAR(10) User profile name
18 12 CHAR(6) Reserved
    CHAR(*) Selected NDS tree name


AUTE0900 Format

Offset Type Field
Dec Hex
0 0 BINARY(4) User profile name
10 A CHAR(6) Reserved


Format of Authentication Entry Lists

The authentication entry list consists of:


For details about the user area and generic header, see User Space Format for List APIs. For details about the remaining items, see the following sections. For detailed descriptions of the fields in the list that is returned, see Field Descriptions.

When you retrieve list entry information from a user space, do not use the entry size that is returned in the generic header. Instead, use the displacement to next entry field that is returned in each list entry. If you do not use the displacement to next entry field, the results may not be valid. For examples of how to process lists, see Examples.



Input Parameter Section

Offset Type Field
Dec Hex
0 0 BINARY(4) User space name specified
10 A CHAR(10) User space library name specified
20 14 CHAR(8) Format name specified
28 1C BINARY(4) Offset to identifier data specified
32 20 BINARY(4) Length of identifier data specified
    CHAR(*) Identifier data specified


Header Section

Offset Type Field
Dec Hex
0 0 BINARY(4) User space name used
10 A CHAR(10) User space library name used
20 14 CHAR(10) User profile name used


Server Authentication Entry

Offset Type Field
Dec Hex
0 0 BINARY(4) Displacement to next entry
4 4 BINARY(4) Displacement to server specific data
8 8 CHAR(10) Server type
18 12 CHAR(2) Reserved
    CHAR(*) Server-type specific data


NetWare 3.x Server Specific Data

If the server type is *NETWARE3, the format of the server-type specific data is as follows:

Offset Type Field
Dec Hex
0 0 BINARY(4) Displacement to server name
4 4 BINARY(4) Length of server name
8 8 BINARY(4) Displacement to NetWare user name
12 C BINARY(4) Length of NetWare user name
    CHAR(*) Server name
    CHAR(*) NetWare user name


NetWare Directory Services Tree Specific Data

If the server type is *NDS, the format of the server-type specific data is as follows:

Offset Type Field
Dec Hex
0 0 BINARY(4) Displacement to NDS tree name
4 4 BINARY(4) Length of NDS tree name
8 8 BINARY(4) Displacement to NDS context
12 C BINARY(4) Length of NDS context
16 10 BINARY(4) Displacement to NetWare user name
20 14 BINARY(4) Length of NetWare user name
    CHAR(*) NDS tree name
    CHAR(*) NDS context name
    CHAR(*) NetWare user name


Field Descriptions

Displacement to NDS context. The displacement, in bytes, from the start of the list entry to the NDS context.

Displacement to NDS tree name. The displacement, in bytes, from the start of the list entry to the NDS tree name.

Displacement to NetWare user name. The displacement, in bytes, from the start of the list entry to the NetWare user name.

Displacement to next entry. The displacement, in bytes, from the start of the current list entry to the start of the next entry in the list.

Displacement to server name. The displacement, in bytes, from the start of the list entry to the server name.

Displacement to server specific data. The displacement, in bytes, from the start of the list entry to the server specific data.

Format name specified. The entry identifier format name that the caller of this API specifies.

Identifier data specified. The authentication entry identifier data that is specified when this API is called.

Length of identifier data specified. The length, in bytes, of the identifier data that is specified on the call to this API.

Length of NDS context. The length, in bytes, of the NDS context.

Length of NDS tree name. The length, in bytes, of the NDS tree name.

Length of NetWare user name. The length, in bytes, of the NetWare user name.

Length of selected NDS tree name. The length, in bytes, of the selected NDS tree name.

Length of selected server name. The length, in bytes, of the selected server name.

Length of server name. The length, in bytes, of the server name.

NDS context name. For NDS trees, the directory context in which the user is defined.

NDS tree name. For NDS trees, the name of the directory tree to which the authentication entry applies.

NetWare user name. The user name for which requests are made to the server.

Offset to identifier data specified. The offset, in bytes, from the start of the input parameter header to the identifier data that is specified on the call to this API.

Offset to selected NDS tree name. The offset, in bytes, from the start of the identifier data to the selected NDS tree name.

Offset to selected server name. The offset, in bytes, from the start of the identifier data to the selected server name.

Reserved. Set this field to binary zeros.

Selected NDS tree name. The name of the NDS tree for which authentication entries are to be listed. A generic name can be used.

The following special value may be specified:

*ALL All NDS tree authentication entries.

Selected server name. The name of the server for which authentication entries are to be listed. A generic name can be used.

The following special value may be specified:

*ALL All NetWare 3.x server authentication entries.

Server name. The name of the server to which the authentication entry applies.

Server type. The kind of server. The content and format of the server-specific data areas are dependent on the server type.

The following values may be returned:

*NETWARE3 The entry is for a NetWare Version 3.x server.
*NDS The entry is for a NetWare Directory Services tree.

Server-type specific data. The name of the server and the user name that are used to start a connection to the server. The format and content of this data are dependent on the server type.

User profile name. The name of the user profile for which entries are to be listed.

The following special value may be specified:

*CURRENT The current job's user profile.

User profile name used. The actual user profile name that is used for the authentication entries listed.

User space library name specified. The name that is specified for the library that contains the user space to receive the generated list.

User space library name used. The actual name of the library that is used to contain the user space that received the list.

User space name specified. The name that is specified for the user space that is to receive the generated list.

User space name used. The actual name of the user space that received the list.

Error Messages

Message ID Error Message Text
CPF2204 E User profile &1 not found.
CPF2217 E Not authorized to user profile &1.
CPF24B4 E Severe error while addressing parameter list.
CPF3C1D E Length specified in parameter &1 not valid.
CPF3C21 E Format name &1 is not valid.
CPF3C90 E Literal value cannot be changed.
CPF3CAA E List is too large for user space &1.
CPF3CF1 E Error code parameter not valid.
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.
FPE0211 E Parameter length &1 not valid for field &2.
FPE0212 E Field offset and length not within data.
FPE0213 E Special value &1 not valid for field &2.

API introduced: V3R7
Top | Security APIs | APIs by category