Keywords › KEYRING Keyword—Add a Key Ring to a User

KEYRING Keyword—Add a Key Ring to a User

Valid on z/OS.

Use the KEYRING keyword to:

• Add a key ring to an individual user. A user can be a member of more than one key ring. The ring name is unique within the user, and the name you specify in KEYRING identifies the key ring for a user.
• List information about a keyring.

When used with ADDTO, this keyword has the following format:

TSS ADDTO(acid) KEYRING(8‑byte‑ring‑name)

When used with LIST, this keyword has the following format:

TSS LIST(ACIDS) KEYRING(ALL)

For each certificate connected to the key ring, the following information is displayed:

• Name of the certificate
• Owner of the certificate
• Label assigned to the certificate
• DEFAULT status of the certificate within the ring
• Usage within the ring

Key rings can be listed for ACID types user, CERTAUTH, and CERTSITE.

This keyword is used with:

• The commands ADDTO, REMOVE, REPLACE, and LIST
• The ACID types User, DCA, VCA, ZCA, LSCA, and SCA
• MISC8 ACID(MAINTAIN), MISC4(CERTUSER), and MISC4(CERTLIST) authority
• Administrators who do not have the above authority need:
  • UPDATE access to TSSCMD.CERTUSER.ADDTO in the CASECAUT resource class to ADD a KEYRING keyword
  • UPDATE access to TSSCMD.CERTUSER.REMOVE in the CASECAUT resource class to REMOVE a KEYRING keyword
  • UPDATE access to TSSCMD.CERTUSER.REPLACE in the CASECAUT resource class to REPLACE a KEYRING keyword

Examples: KEYRING keyword

This example adds a key ring to a user:

TSS ADDTO(USER01) KEYRING(CASRING)

This example identifies the key ring by its ring name or by its label:

TSS LIST(acid) {KEYRING(8‑byte ring name)}
               {LABLRING(237‑byte ring label)}

This example lists all the ACIDs and the key rings associated with them:

TSS LIST(ACIDS) KEYRING(ALL)

This example lists information on a specific key ring:

TSS LIST(acid) LABLRING(name)

This example displays all key rings associated with a particular user:

TSS LIST(user01) KEYRING(ALL)