Add NetWare Authentication Entry (QfpzAddNtwAutE) API


  Required Parameter Group:

1 Entry identifier data Input Char(*)
2 Length of entry identifier Input Binary(4)
3 Entry identifier format name Input Char(8)
4 Authentication entry data Input Char(*)
5 Length of authentication entry Input Binary(4)
6 Entry data format name Input Char(8)
7 Error code I/O Char(*)

  Default Public Authority: *USE

  Library Name/Service Program: QFPNTWE/QFPZAAPI

  Threadsafe: No

The Add NetWare Authentication Entry (QfpzAddNtwAutE) API stores user authentication information that is used to access the specified server. This information can be used at a later time to start an authenticated connection to the server without requiring the user to enter the data.


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.

Required Parameter Group

Entry identifier data
INPUT; CHAR(*)

The authentication entry to be added. 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 entry identifier data structure.

Entry identifier format name
INPUT; CHAR(8)

The content and format of the authentication entry identifier data.

The possible format names follow:

AUTE0100 NetWare Version 3.x server authentication entry identifier
AUTE0200 NetWare Directory Services tree authentication entry identifier

See Format of Authentication Entry Identifier for a description of these formats.

Authentication entry data
INPUT; CHAR(*)

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

Length of authentication entry
INPUT; BINARY(4)

The length of the authentication entry data structure.

Entry data format name
INPUT; CHAR(8)

The content and format of the authentication entry input data. Each format corresponds to a type of authentication entry.

The possible format names follow:

AUTD0100 NetWare Version 3.x server authentication entry data
AUTD0200 NetWare Directory Services tree authentication entry data

See Format of Authentication Entry Data for a description of these formats.

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 authentication entries, see the following sections. For details about the fields in each format, see Field Descriptions.

AUTE0100 Format

This format is used to identify a NetWare Version 3.x server authentication entry.


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


AUTE0200 Format

This format is used to identify a NetWare Directory Services tree authentication entry.

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


Format of Authentication Entry Data

For details about the format of the authentication entries, see the following sections. For details about the fields in each format, see Field Descriptions.

AUTD0100 Format

This format is used to specify the authentication entry data for a NetWare Version 3.x server authentication entry. This format must be used when entry identifier format AUTE0100 is used.

Offset Type Field
Dec Hex
0 0 BINARY(4) Offset to NetWare user name
4 4 BINARY(4) Length of NetWare user name
8 8 BINARY(4) Offset to password
12 C BINARY(4) Length of password
16 10 BINARY(4) Reserved
CHAR(*) NetWare user name
CHAR(*) Password


AUTD0200 Format

This format is used to specify the authentication entry data for a NetWare Directory Services tree authentication entry. This format must be used when entry identifier format AUTE0200 is used.

Offset Type Field
Dec Hex
0 0 BINARY(4) Offset to NDS context
4 4 BINARY(4) Length of NDS context
8 8 BINARY(4) Offset to NetWare user name
12 C BINARY(4) Length of NetWare user name
16 10 BINARY(4) Offset to password
20 14 BINARY(4) Length of password
24 18 BINARY(4) Reserved
CHAR(*) NDS context
CHAR(*) NetWare user name
CHAR(*) Password


Field Descriptions

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 password. The length, in bytes, of the password.

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

NDS context. The directory context in which the user is defined.

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

NetWare user name. The NetWare user name that is used to authenticate the user to the server.

The following special value may be used:

*USRPRF The NetWare user name is the same as the user profile name.

Offset to NDS context. The offset, in bytes, from the start of the input data area to the NDS context.

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

Offset to NetWare user name. The offset, in bytes, from the start of the input data area to the user name.

Offset to password. The offset, in bytes, from the start of the input data area to the password.

Offset to server name. The offset, in bytes, from the start of the input data area to the server name.

Password. The password that is used to authenticate the user to the server.

The following special values may be used:

*NONE The system does not need password information to authenticate the user.
*STRNTWCNN The system does not store password information in the authentication entry. Use the Start NetWare Connection (STRNTWCNN) command, with the correct password, to start a connection to a server.

Reserved. Set this field to binary zeros.

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

User profile name. The name of the user profile to which the authentication entry is to be added.

You can use the following special values for the user profile name:

*CURRENT The current user profile.


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.
CPF3CF1 E Error code parameter not valid.
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.
FPE0216 E Authentication entry already exists for &2.
FPE021F E Data format &1 not valid with identifier format &2.
FPE0255 E PASSWORD(*STRNTWCNN) required when QRETSVRSEC is 0.


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