# MongoDB\Driver\ClientEncryption::addKeyAltName

(mongodb >=1.15.0)

MongoDB\Driver\ClientEncryption::addKeyAltName — Adds an alternate name to a key document

### Descripción

final public MongoDB\Driver\ClientEncryption::addKeyAltName(MongoDB\BSON\Binary `$keyId`, string `$keyAltName`): ?object

Adds `keyAltName` to the set of alternate names for the key document with the given UUID `keyId`.

### Parámetros

`keyId`

  A MongoDB\BSON\Binary instance with subtype 4 (UUID) identifying the key document.

`keyAltName`

  Alternate name to add to the key document.

### Valores devueltos

Returns the previous version of the key document, or `null` if no document matched.

### Errores/Excepciones

- Lanza una MongoDB\Driver\Exception\InvalidArgumentException en errores de análisis de argumentos.
- Lanza una MongoDB\Driver\Exception\ConnectionException si la conexión al servidor falla (por razones diferentes a la autenticación).
- Lanza una MongoDB\Driver\Exception\AuthenticationException si la autenticación es necesaria y falla.
- Throws MongoDB\Driver\Exception\RuntimeException on other errors.

### Ver también

- MongoDB\Driver\ClientEncryption::getKeyByAltName() - Gets a key document by an alternate name
- MongoDB\Driver\ClientEncryption::removeKeyAltName() - Removes an alternate name from a key document