Ziti C SDK
Loading...
Searching...
No Matches
ziti_auth_event Struct Reference

Event notifying the app that additional action is required to continue authentication or normal operation. More...

#include <ziti_events.h>

Data Fields

enum ziti_auth_action action
 
const char * error
 error message, if any action == ziti_auth_cannot_continue
 
const char * error_code
 controller error code, if any (e.g.
 
const char * type
 
const char * detail
 
ziti_jwt_signer_array providers
 

Detailed Description

Event notifying the app that additional action is required to continue authentication or normal operation.

The app may request that information from the user and then submit it to ziti_context.

the following authentication actions are supported:

[ziti_auth_prompt_totp] - request for MFA code, application must call [ziti_mfa_auth()] when it acquires TOTP code

[ziti_auth_login_external] - request for that app to launch external program (web browser) that can authenticate with provided url ([detail] field)

TODO: future [ziti_auth_prompt_pin] - request for HSM/TPM key pin, application must call [TBD method] when it acquires PIN

Field Documentation

◆ action

enum ziti_auth_action ziti_auth_event::action

◆ detail

const char* ziti_auth_event::detail

◆ error

const char* ziti_auth_event::error

error message, if any action == ziti_auth_cannot_continue

◆ error_code

const char* ziti_auth_event::error_code

controller error code, if any (e.g.

"ENROLLMENT_IDENTITY_ALREADY_ENROLLED")

◆ providers

ziti_jwt_signer_array ziti_auth_event::providers

◆ type

const char* ziti_auth_event::type

The documentation for this struct was generated from the following file: