Change User Entitlement Attribute (QLZACUEA) API


  Required Parameter Group:

1 User entitlement information Input Char(*)
2 Length of user entitlement information Input Binary(4)
3 User entitlement information format name Input Char(8)
4 Error code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: No

The Change User Entitlement Attribute (QLZACUEA) API provides an interface to change the user entitlement attribute for a user profile. The API also allows setting additional user entitlement information for the user profile. Currently, the additional user entitlement information that can be set is the status attribute for the user profile. The user entitlement and status attributes determine if a user entitlement is held by a user profile.

You must have enough user entitlements for all user profiles that require a user entitlement and have a status of *ENABLED.


Authorities and Locks

Authority Required
The user of this API must have All Object (*ALLOBJ) and Security Administrator (*SECADM) special authorities.
Locks
The profile being changed will be locked exclusive, no read (*EXCL).

Required Parameter Group

User entitlement information
INPUT; CHAR(*)

The structure that contains information for which user profile is to have user entitlement attributes changed, and the attributes to be changed. The structure provided depends on which user entitlement information format is requested. For more information, see User Entitlement Information Format.

Length of user entitlement information
INPUT; BINARY(4)

The length of the user entitlement information in bytes. The value specified must be at least 21.

User entitlement information format name
INPUT; CHAR(8)

The content and format of the user entitlement information parameter.

The possible format names follow:

CEAI0100 The user profile name, user entitlement attribute, and status attribute. For more information, see CEAI0100 Format.

Error code
I/O; CHAR(*)

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


User Entitlement Information Format

Information passed in the user entitlement information parameter can be in one of the following formats. For detailed descriptions of each field, see Field Descriptions.


CEAI0100 Format

Offset Type Field
Dec Hex
0 0 CHAR(10) User profile name
10 A CHAR(1) User entitlement attribute
11 B CHAR(10) Status attribute


Field Descriptions

Status attribute. The status attribute for the user profile.

This field must contain one of the following values:

*SAME The status attribute for the user profile is not changed from the current value.
*ENABLED The status attribute for the user profile is set to *ENABLED.
*DISABLED The status attribute for the user profile is set to *DISABLED.

User profile name. The name of the user profile whose attributes are to be changed. The following user profile names cannot be specified on this API:

QANZAGENT   QAUTPROF    QBRMS       QCLUMGT     QCLUSTER    QCOLSRV     QDBSHR
QDBSHRDO    QDFTOWN     QDIRSRV     QDLFM       QDOC        QDSNX       QEJB
QEJBSVR     QFNC        QGATE       QIBMHELP    QIPP        QLPAUTO     QLPINSTALL
QMGTC       QMSF        QNETSPLF    QNFSANON    QNTP        QPEX        QPGMR
QPM400      QRJE        QSECOFR     QSNADS      QSPL        QSPLJOB     QSRV
QSRVAGT     QSRVBAS     QSYS        QSYSOPR     QTCM        QTCP        QTFTP
QTMHHTP1    QTMHHTTP    QTSTRQS     QUSER       QYCMCIMOM   QYPSJSVR 
           

User entitlement attribute. The user entitlement attribute for the user profile.

This field must contain one of the following values:

0 User entitlement is not required. Refer to your IBM® IBM® i License Agreement to determine if specifying this value would violate your authorized use of IBM i user entitlements.
1 User entitlement is required.


Error Messages

Message ID Error Message Text
CPF22FF E System user profile cannot be changed.
CPF2203 E User profile &1 not correct.
CPF2204 E User profile &1 not found.
CPF2213 E Not able to allocate user profile &1.
CPF222E E &1 special authority is required.
CPF2225 E Not able to allocate internal system object.
CPF3CF1 E Error code parameter not valid.
CPF3C21 E Format name &1 is not valid.
CPF3C3C E Value for parameter &1 not valid.
CPF3C90 E Literal value cannot be changed.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.



API introduced: V6R1

[ Back to top | Software Product APIs | APIs by category ]