Package com.flowable.core.idm.api

Interface PlatformIdentityService

    • Method Detail

      • createNewUserBuilder

        PlatformUserBuilder createNewUserBuilder​(java.lang.String userId)
        Create user builder for a new user with id userId. The user is transient and must be saved using PlatformUserBuilder.save()
        Parameters:
        userId - the id of the new user

      • createUpdateUserBuilder

        PlatformUserBuilder createUpdateUserBuilder​(java.lang.String userId)

      • createUpdateGroupBuilder

        PlatformGroupBuilder createUpdateGroupBuilder​(java.lang.String groupId)

      • createPlatformIdentityInfoBuilder

        PlatformIdentityInfoBuilder createPlatformIdentityInfoBuilder()
        Create a builder for updating or creating a platform identity info.

      • createPlatformIdentityInfoQuery

        PlatformIdentityInfoQuery createPlatformIdentityInfoQuery()
        Create a query for querying platform identity infos.

      • findUniqueTenantIds

        java.util.List<java.lang.String> findUniqueTenantIds()
        Find the unique tenant ids
        Returns:
        a list of the unique tenant ids

      • setUserStateAndSubState

        void setUserStateAndSubState​(java.lang.String userId,
                             java.lang.String state,
                             java.lang.String subState)
        Update the state and/or subState of the provided user. If the value for the state is null then the state of the user won't be changed. If the value for the subState is null then the subState of the user won't be changed. At least one of state and / or subState must be set
        Parameters:
        userId - the id of the user that needs to have its state updated
        state - the optional new state to set, if null it won't be changed
        subState - the optional new subState to set, if null it won't be changed
        See Also:
        for a list of commonly used states, although you can create your own ones, for a list of commonly used sub states, although you can create your own ones

      • setUserStateAndSubState

        void setUserStateAndSubState​(java.lang.String userId,
                             java.lang.String state,
                             java.lang.String subState,
                             java.lang.String tenantId)
        Update the state and/or subState of the provided user. If the value for the state is null then the state of the user won't be changed. If the value for the subState is null then the subState of the user won't be changed. At least one of state and / or subState must be set
        Parameters:
        userId - the id of the user that needs to have its state updated
        state - the optional new state to set, if null it won't be changed
        subState - the optional new subState to set, if null it won't be changed
        tenantId - the tenant id in which the change should be done
        See Also:
        for a list of commonly used states, although you can create your own ones, for a list of commonly used sub states, although you can create your own ones

      • setUserDefinitionById

        void setUserDefinitionById​(java.lang.String userId,
                           java.lang.String userDefinitionId)
        Update the user definition of the provided user.
        Parameters:
        userId - the id of the user that needs to have its user definition updated
        userDefinitionId - the user definition id of the new user definition

      • setUserDefinitionByKey

        void setUserDefinitionByKey​(java.lang.String userId,
                            java.lang.String userDefinitionKey,
                            java.lang.String tenantId)
        Update the user definition of the provided user.
        Parameters:
        userId - the id of the user that needs to have its user definition updated
        userDefinitionKey - the key of the new user definition
        tenantId - the tenant id of the new user definition

      • deactivateUser

        @Deprecated
default void deactivateUser​(java.lang.String userId,
                            java.lang.String newSubState)
        Deprecated.
        use setUserStateAndSubState(String, String, String) instead with state UserStates.INACTIVE
        Sets the user state to UserStates.INACTIVE. This method should no longer be used as it would be removed.
        Parameters:
        userId - the id of the user to be deactivated
        newSubState - the optional new sub state to set, leave it null to not change it

      • reactivateUser

        @Deprecated
default void reactivateUser​(java.lang.String userId,
                            java.lang.String newSubState)
        Deprecated.
        use setUserStateAndSubState(String, String, String) instead with state UserStates.ACTIVE
        Sets the user state to UserStates.ACTIVE. This method should no longer be used as it would be removed.
        Parameters:
        userId - the id of the user to be reactivated
        newSubState - the optional new sub state to set, leave it null to not change it

      • updateUserPresence

        @Deprecated
void updateUserPresence​(java.lang.String userId,
                        java.lang.String presence)
        Deprecated.
        use updateUserPresence(String, String, String) instead
        Updates the presence status of the user
        Parameters:
        userId - the id of the user for which the presence status needs to be updated
        presence - the id of the user for which the presence status needs to be updated
        See Also:
        for known states

      • updateUserPresence

        void updateUserPresence​(java.lang.String userId,
                        java.lang.String tenantId,
                        java.lang.String presence)
        Updates the presence status of the user in the given tenant
        Parameters:
        userId - the id of the user for which the presence status needs to be updated
        tenantId - the id of tenant in which the presence status needs to be updated
        presence - the id of the user for which the presence status needs to be updated
        See Also:
        for known states

      • setPlatformUserInfo

        @Deprecated
void setPlatformUserInfo​(java.lang.String userId,
                         java.lang.String infoName,
                         java.lang.Object value)
        Deprecated.
        use createPlatformIdentityInfoBuilder() instead

      • getPlatformUserInfo

        @Deprecated
<T> java.util.Optional<T> getPlatformUserInfo​(java.lang.String userId,
                                              java.lang.String infoName,
                                              java.lang.Class<T> infoClass)
        Deprecated.

      • findIdentityInfoByUserIdAndName

        @Deprecated
PlatformIdentityInfo findIdentityInfoByUserIdAndName​(java.lang.String userId,
                                                     java.lang.String name)
        Deprecated.

      • deletePlatformIdentityInfoById

        void deletePlatformIdentityInfoById​(java.lang.String id)
        Delete the platform identity info entry for the given id
        Parameters:
        id - the id of the identity info entry

      • deletePlatformIdentityInfoByUserId

        void deletePlatformIdentityInfoByUserId​(java.lang.String userId)
        Delete all platform identity info entries of the user
        Parameters:
        userId - the id of the user

      • deletePlatformIdentityInfoByUserIdAndTenantId

        void deletePlatformIdentityInfoByUserIdAndTenantId​(java.lang.String userId,
                                                   java.lang.String tenantId)
        Delete all platform identity info entries of the user in the given tenant
        Parameters:
        userId - the id of the user
        tenantId - the id of the tenant

      • createAuthenticationTokenBuilder

        TokenAuthenticationBuilder createAuthenticationTokenBuilder()
        Create a token authentication builder with which authentication tokens can be created.
        Returns:
        the token authentication builder

      • findPropertyByName

        IdmProperty findPropertyByName​(java.lang.String name)

      • updateProperty

        void updateProperty​(IdmProperty idmProperty)

      • createProperty

        IdmProperty createProperty​(java.lang.String name,
                           java.lang.String value)

      • deleteProperty

        void deleteProperty​(java.lang.String name)