Change Service Tools User ID (QSYCHGDS) API
Required Parameter Group:
| 1 | Requesting service tools user ID | Input | Char(*) |
| 2 | Requesting service tools user ID password | Input | Char(*) |
| 3 | Service tools user ID to be changed | Input | Char(10) |
| 4 | New service tools user ID | Input | Char(*) |
| 5 | New service tools user ID password | Input | Char(*) |
| 6 | Error code | I/O | Char(*) |
Optional Parameter Group:
| 7 | Length of requesting service tools user ID profile | Input | Bin(4) |
| 8 | Length of requesting service tools user ID password | Input | Bin(4) |
| 9 | CCSID of requesting service tools user ID password | Input | Bin(4) |
| 10 | Length of new service tools user ID | Input | Bin(4) |
| 11 | Length of new service tools user ID password | Input | Bin(4) |
| 12 | CCSID of new service tools user ID password | Input | Bin(4) |
Default Public Authority: *EXCLUDE
Threadsafe: No
The Change Service tools user ID (QSYCHGDS) API changes the ID name or the password (or both) for service tools user IDs.
Calling this API from a command line may result in a security exposure since the plain text service tools user ID and password may appear in the job log. Therefore, you should avoid calling this API from the command line.
Authorities and Locks
When the requesting service tools user ID is different than the service tools user ID to be changed, the requesting service tools user ID must have the Service Tool user function privilege "Service Tool Security".
When the requesting service tools user ID is the same as the service tools user ID to be changed and the service tools user ID name is to be changed, the requesting service tools user ID must have the Service Tool user function privilege "Service Tool Security".
Required Parameter Group
- Requesting service tools user ID
- INPUT; CHAR(*)
The requesting service tools user ID. This value is converted to uppercase. If the optional parameter group is not specified, a default of length 8 is used. The requesting service tools user ID parameter should be padded with trailing blank characters if necessary.
- Requesting service tools user ID password
- INPUT; CHAR(*)
The password for the requesting service tools user ID.
- Service tools user ID to be changed
- INPUT; CHAR(10)
The service tools user ID to be changed. This value is converted to uppercase. The service tools user ID to be changed parameter should be padded with trailing blank characters. You can use these special values for the service tools user ID to be changed:
*SECURITY Change the security capability profile. *FULL Change the full capability profile. *BASIC Change the basic capability profile. *SERVICE Change the service capability profile.
- New service tools user ID
- INPUT; CHAR(*)
The new service tools user ID or *SAME. This value is converted to uppercase. If the optional parameter group is not specified, a default length of 8 is used. The new service tools user ID parameter should be padded with trailing blank characters if necessary.
- New service tools user ID password
- INPUT; CHAR(*)
The new service tools user ID password or *SAME.
If 128 character, case sensitive passwords are enabled for the service tools user IDs, then *SAME is not allowed.
- 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 Group
- Length of requesting service tools user ID
- INPUT; BINARY(4)
The length, in bytes, of the ID contained in the requesting service tools ID parameter. If the optional parameter group is not specified, a default of 8 is used. The requesting service tools user ID parameter should be padded with trailing blank characters, if necessary, to the size specified by this parameter.
This parameter accepts values from 1 to 10.
- Length of requesting service tools user ID password
- INPUT; BINARY(4)
The length, in bytes, of the password contained in the requesting service tools user ID password parameter. If the optional parameter group is not specified, a default of 8 is used. The requesting service tools user ID password parameter should be padded with trailing blank characters, if necessary, to the size specified by this parameter.
This parameter accepts values from 1 to 512. If 128 character, case sensitive passwords are not enabled for the service tools user IDs, the password is limited to 8 characters. If 128 character, case sensitive passwords are enabled for the service tools user IDs, then this password may be from 6 to 512 bytes. However, values greater than 128 should only be used if multi-byte characters are specified for the service tools user ID password. The number of characters, as interpreted by the CCSID of the service tools user ID password parameter, cannot exceed 128.
- CCSID of requesting service tools user ID password
- INPUT; BINARY(4)
The CCSID of the requesting service tools user ID password parameter. If the optional parameter group is not specified, CCSID 37 is used. For a list of valid CCSIDs, see the IBM i globalization topic collection.
The valid values are:
0 The CCSID of the job is used to determine the CCSID of the data to be converted. If the job CCSID is 65535, the CCSID from the default CCSID (DFTCCSID) job attribute is used. 1-65533 A valid CCSID in this range.
- Length of new service tools user ID
- INPUT; BINARY(4)
The length, in bytes, of the ID contained in the new service tools user ID parameter. If the optional parameter group is not specified, a default of 8 is used. The new service tools user ID parameter should be padded with trailing blank characters, if necessary, to the size specified by this parameter.
This parameter accepts values from 1 to 10.
- Length of new service tools user ID password
- INPUT; BINARY(4)
The length, in bytes, of the password contained in the new service tools user ID password parameter. If the optional parameter group is not specified, a default of 8 is used. The new service tools user ID password parameter should be padded with trailing blank characters, if necessary, to the size specified by this parameter.
This parameter accepts values from 6 to 512. If 128 character, case sensitive passwords are not enabled for the service tools user IDs, the password is limited to 8 characters. If 128 character, case sensitive passwords are enabled for the service tools user IDs, then this password may be from 6 to 512 bytes. However, values greater than 128 should only be used if multi-byte characters are specified for the service tools user ID password. The number of characters, as interpreted by the CCSID of the service tools user ID password parameter, cannot exceed 128.
- CCSID of new service tools user ID password
- INPUT; BINARY(4)
The CCSID of the new service tools user ID password parameter. If the optional parameter group is not specified, CCSID 37 is used. For a list of valid CCSIDs, see the IBM i globalization topic collection.
The valid values are:
0 The CCSID of the job is used to determine the CCSID of the data to be converted. If the job CCSID is 65535, the CCSID from the default CCSID (DFTCCSID) job attribute is used. 1-65533 A valid CCSID in this range.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF225B E | Service tools user ID to be changed is not correct. |
| CPF225C E | Requesting service tools user ID not correct. |
| CPF225D E | Requesting service tools user ID password not correct. |
| CPF3BC7 E | CCSID &1 outside of valid range. |
| CPF3BDE E | CCSID &1 not supported by API. |
| CPF3C1D E | Length specified in parameter &1 not valid. |
| CPF3C3C E | Value for parameter &1 not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF4AB3 E | Error changing service tools user ID. Reason code &1. |
| CPF4AB7 E | Service tools user ID password cannot be changed. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V4R1
[ Back to top | Security APIs | APIs by category ]