Interface ICredentials

All Known Subinterfaces:
IInternalCredentials
@Path("/credentials/{domainUid}") public interface ICredentials

  • Field Details

    • OBFUSCATED_CREDENTIAL_VALUE

      static final String OBFUSCATED_CREDENTIAL_VALUE
      Value to use when sending credential to external clients
      See Also:

  • Method Details

    • removeSelfCredential

      @DELETE @Path("user/_credentials/{credentialId}/_self") void removeSelfCredential(@PathParam("credentialId") String credentialId)
      Remove logged user credential from its ID
      Parameters:
      credentialId -

    • removeUserCredential

      @DELETE @Path("user/{userUid}/{credentialId}") void removeUserCredential(@PathParam("userUid") String userUid, @PathParam("credentialId") String credentialId)
      Remove user credential from user UID and credential ID
      Used by bm-keycloak to store credentials
      Parameters:
      userUid -
      credentialId -

    • getSelfObfuscatedCredentials

      @GET @Path("user/_credentials/_self") ListResult<Credential> getSelfObfuscatedCredentials()
      Get logged user credential
      Returns:

    • getObfuscatedUserCredentials

      @GET @Path("user/{userUid}") ListResult<Credential> getObfuscatedUserCredentials(@PathParam("userUid") String userUid)
      Get user credentials for user UID
      Parameters:
      userUid -
      Returns:

    • addTotpCredential

      @PUT @Path("user/totp") String addTotpCredential(TotpCredential totpCredential)
      Add TOTP credential to logged user
      Parameters:
      totpCredential -

    • validateTotpCredential

      @POST @Path("user/totp/validate") Boolean validateTotpCredential(TotpCredential totpCredential)
      Validate TOTP credential.
      Parameters:
      totpCredential - TotpCredential.displayName, TotpCredential.token and TotpCredential.secret (hexadecimal) must be filled