Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
d) Customer Management

Update a password for a customer

It is the responsibility of the tenant to ensure they have verified that the customer is the one setting the new password

put/eclipse-conductor/rest/v1/tenants/{tenantId}/customers/{customerId}/identities/{identity}

Path parameters

tenantIdinteger required
customerIdinteger required
identitystring required

Request body

authLockedAfterstring date-time

Optional. ISO 8601 date/time of when the identity cannot be used after. Changing password before authLockedAfter would set authLockedAfter to null and effectively make the identity usable any time

base64EncodedPublicKeystring

An optional PKI RSA public key for added security. If a public key is provided then the PKI login-challenges endpoint should be used to get a challenge to respond to as part of the login

changeAfterstring date-time

Optional. ISO 8601 date/time of when the current password expires and a password reset must be done

passwordstring required

Can be pre-hashed with BCRYPT or passed as clear text in which case Eclipse will hash it

totpEnabledboolean

Whether this identoty will require a time base one time password when authenticating

totpResetboolean

Resets the TOTP secret and returns a new QRCode which can be scanned with any RFC 6238 compliant App (E.g. Google Authenticator)

Example request

{
  "authLockedAfter": "2022-03-10T12:15:50-04:00",
  "changeAfter": "2022-03-10T12:15:50-04:00"
}

Response

OK

authLockedAfterstring date-time

Optional. ISO 8601 date/time of when the identity cannot be used after. Changing password before authLockedAfter would set authLockedAfter to null and effectively make the identity usable any time

authLockedUntilstring date-time

Optional. ISO 8601 date/time of when the identity cannot be used before

base64EncodedPublicKeystring

An optional PKI RSA public key for added security. If a public key is provided then the PKI login-challenges endpoint should be used to get a challenge to respond to as part of the login

changeAfterstring date-time

Optional. ISO 8601 date/time of when the current password expires and a password reset must be done

failedAuthAttemptsinteger
identitystring required

Identity/username for authentication

totpEnabledboolean

Whether this identity will require a time base one time password when authenticating

totpQrCodestring

Resets the TOTP secret and returns a new QRCode which can be scanned with any RFC 6238 compliant App (E.g. Google Authenticator)

Example response

{
  "authLockedAfter": "2022-03-10T12:15:50-04:00",
  "authLockedUntil": "2022-03-10T12:15:50-04:00",
  "changeAfter": "2022-03-10T12:15:50-04:00"
}