Pages
API Documentation
On this page

SignOn Namespace

The Single Sign On client library and plugin API. More...

  • Header: #include <SignOn>
  • CMake: find_package(SignOnQt6 REQUIRED)
    target_link_libraries(mytarget PRIVATE SignOnQt6::SignOnQt6)

Detailed Description

Classes

class AuthService

Represents signon for client application.

class AuthSession

Represents a session to authentication plugin/server.

class Error

Base object definition for Signon error handling.

class Identity

Represents a database entry for a single identity.

class IdentityInfo

Contains identity information.

class SecurityContext

Contains access security context information.

class SessionData

Data container to hold values for authentication session.

Type Documentation

AuthSessionP

A guarded pointer to an AuthSession.

MechanismsList

Defines a string list as a list of mechanisms.

MethodName

Defines a string as an authentication method.

SecurityContextList

Defines a list of security contexts.

enum SignonUiPolicy

Policy to define how the plugin interacts with the user. This is a hint for plugin how to handle user interaction. NoUserInteractionPolicy does not allow any ui interaction to happen and plugin will get error reply QUERY_ERROR_FORBIDDEN.

Constant Value Description
SignOn::SessionData::DefaultPolicy 0 Plugin can decide when to show ui.
SignOn::SessionData::RequestPasswordPolicy 1 Force user to enter password.
SignOn::SessionData::NoUserInteractionPolicy 2 No ui elements are shown to user.
SignOn::SessionData::ValidationPolicy 3 UI elements can be shown to the user only when captcha-like security measures are required

See also SessionData::UiPolicy()

We use cookies to personalize content and to analyze our traffic. Please decide if you are willing to accept cookies from our website.