Package pl.edu.icm.unity.engine.api

Interface EntityCredentialManagement

public interface EntityCredentialManagement
API for management of entities' credentials.
Author:
K. Benedyczak

  • Method Details

    • setEntityCredentialRequirements

      void setEntityCredentialRequirements(EntityParam entity, String requirementId) throws EngineException
      Changes CredentialRequirements of an entity.
      Parameters:
      entity - to be modified
      requirementId - to be set
      Throws:
      EngineException

    • setEntityCredential

      void setEntityCredential(EntityParam entity, String credentialId, String secrets) throws EngineException
      Sets authentication secretes for the entity. After the change, the credential will be in correct state.
      Parameters:
      entity - to be modified
      credentialId - credential id to be changed.
      secrets - the credential type specific value of the credential.
      Throws:
      EngineException

    • setEntityCredentialStatus

      void setEntityCredentialStatus(EntityParam entity, String credentialId, LocalCredentialState desiredCredentialState) throws EngineException
      Sets local credential state.
      Parameters:
      entity - to be modified
      credentialId - credential id to be changed.
      desiredCredentialState - desired credential state. If 'notSet' then the current credential is removed. The status can be set to 'outdated' only if the credential supports invalidation and currently there is a (correct or outdated) credential set. The 'correct' value is not allowed, and will cause an exception. Credential can be put into correct state with setEntityCredential(EntityParam, String, String).
      Throws:
      EngineException

    • setUserMFAOptIn

      void setUserMFAOptIn(EntityParam entity, boolean value) throws EngineException
      Throws:
      EngineException

    • getUserMFAOptIn

      boolean getUserMFAOptIn(EntityParam entity) throws EngineException
      Throws:
      EngineException