Interface AdministrativeFlowDescriptor

    • Method Detail

      • getLoggingId

        @Nullable
        String getLoggingId()
        Get a logging ID to use when auditing this profile.
        Returns:
        logging ID
      • isNonBrowserSupported

        boolean isNonBrowserSupported​(@Nullable
                                      ProfileRequestContext profileRequestContext)
        Get whether this flow supports non-browser clients (default is true).
        Parameters:
        profileRequestContext - current profile request context
        Returns:
        whether this flow supports non-browser clients
      • isAuthenticated

        boolean isAuthenticated​(@Nullable
                                ProfileRequestContext profileRequestContext)
        Get whether user authentication is required (default is false).
        Parameters:
        profileRequestContext - current profile request context
        Returns:
        whether user authentication is required
      • getUIInfo

        @Nullable
        UIInfo getUIInfo()
        Get the user interface details for this profile.
        Returns:
        user interface details
      • getPolicyName

        @Nullable
        String getPolicyName​(@Nullable
                             ProfileRequestContext profileRequestContext)
        Get the access control policy for this flow.
        Parameters:
        profileRequestContext - current profile request context
        Returns:
        name of access control policy
      • isLocal

        default boolean isLocal()
        Get whether this profile is for functionality local to the IdP.

        Most authentication profiles are non-local, designed to issue security tokens to other systems, so this is generally false.

        Specified by:
        isLocal in interface AuthenticationProfileConfiguration
        Returns:
        true iff the use of the associated profile is local to the IdP