Update a credential
PUT/api/v1/Credential/:credentialId
Replaces the settings of one credential with the body you send. A blank password or enable password keeps the stored value, so you can update other fields without re-sending secrets.
Permission required: Admin, App or UserPlus role. A UserPlus user also needs the Credential Manage permission for this credential.
Values for AuthenticationMethodType: 0 = Password, 1 = SshCertificate, 2 = SshCertificateAndPassword.
Values for CredentialType: -1 = Any, 0 = Configuration, 1 = User, 2 = Service, 3 = ActivityToken, 4 = Application, 5 = VaultUser, 6 = SshKeyCert.
Caution: The change takes effect immediately, and the request body can contain secrets, so send it only over a secure connection.
Request
Responses
- 200
- 400
- 401
- 403
- 409
The updated credential. Password, enable password, key and passphrase fields are left out.
The id in the body does not match the URL, the user name matches an existing NPS user, or the update failed. The body describes the problem.
A UserPlus user does not have permission to manage this credential.
The signed-in user does not have the required role.
The domain and user name already belong to another service account.