Start of changeClear Master Key (QC3CLRMK, Qc3ClearMasterKey)


  Required Parameter Group:

1 Master key ID Input Binary(4)
2 Master key version Input Char(1)
3 Error code I/O Char(*)

 Service Program Name: QC3MKCLR

 Default Public Authority: *EXCLUDE

 Threadsafe: Yes

The Clear Master Key (OPM, QC3CLRMK; ILE, Qc3ClearMasterKey) API clears the specified master key version. Before clearing an old master key version, care should be taken to ensure no keys or data are are still encrypted under it.

For more information about master keys, refer to Cryptographic Services Master Keyse.


Authorities and Locks

Required special authority
*ALLOBJ and *SECADM

Required Parameter Group

Master key ID
INPUT; BINARY(4)

The master key IDs are

1 Master key 1
2 Master key 2
3 Master key 3
4 Master key 4
5 Master key 5
6 Master key 6
7 Master key 7
8 Master key 8

Master key version
INPUT; CHAR(1)

The new or old version of the master key

0 New version
2 Old version

Error code
I/O; CHAR(*)

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


Error Messages

Message ID Error Message Text
CPF222E E &1 special authority is required.
CPF24B4 E Severe error while addressing parameter list.
CPF3C1E E Required parameter &1 omitted.
CPF3CF1 E Error code parameter not valid.
CPF3CF2 E Error(s) occurred during running of &1 API.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.
CPF9DAD E The master key ID is not valid.
CPF9DAE E The master key version is not valid.
CPF9DDA E Unexpected return code &1.

End of change

API introduced: V5R4
Top | Cryptographic Services APIs | APIs by category