User ID Security Exit Support › Add User ID Parameter List

Add User ID Parameter List

On entry to the security exit, Register 1 (R1) points to a list of ten full words, as shown in this diagram.

The contents of the parameter list are as follows:

Word 1

Is a fullword containing the address of function code F‘40’.

Word 2

Is the address of a subfunction code. The code defines the type of user to add and has values set as follows:

Word 3

Is the address of an eight-character field, padded with blanks, containing the user definition to add.

Word 4

Is the address of three full words containing the session correlator and the user token (UTOKEN) associated with the user issuing the request.

Word 5

Is the address of an eight-character field containing the user ID of the user issuing the ADD request.

Word 6

Is the address of an eight-character field containing the initial password of the user to add or set to zero if a password is not provided.

This field is optional on the &SECCALL ADD function when using a security exit. The site is responsible to take appropriate action on the requirement for this password.

Word 7

Is set to zero.

Word 8

Is the address of an 82-character message area into which the exit can place any error message text if the add request is denied or failed. Any text placed in this area is displayed to the user in response to the command that caused this request. If an error message is returned in this area, it must be formatted as follows:

Bytes 00 and 01

Specifies the hexadecimal length of the message text (excluding these two bytes).

Bytes 02 through nn

Specifies the error message text.

Limits: 80 characters

Message text is converted to uppercase.

Word 9

Is set to zero.

Word 10

Is set to the address of a list of full words, terminated by X‘FFFFFFFF’. Each fullword in this list in turn points to a structured field that defines an item of user ID information to add.

More information:

Structured Fields

Return Codes from the Add User ID Call

The exit must return a completion code in Register 15 (R15) on return. Completion codes are supported as described below. Causes for rejection of add calls are identified by error message text returned in the area addressed by word 8 of the add call parameter list.

The return codes listed below are the only codes that are accepted in response to an add call. Any other return codes are regarded as a rejection of the add call.

0

Indicates that ADD is complete.

4

Indicates that ADD is rejected. An error message might be available in the 80-character area addressed by word 8 of the parameter list.