Skip to main content

stages_authenticator_validate_retrieve

GET 
/api/v3//stages/authenticator/validate/:stage_uuid/

AuthenticatorValidateStage Viewset

Request​

Path Parameters

    stage_uuid uuidrequired

    A UUID string identifying this Authenticator Validation Stage.

Responses​

Schema
    pkuuidrequired
    namestringrequired
    componentstringrequired

    Get object type so that we know how to edit the object

    verbose_namestringrequired

    Return object's verbose_name

    verbose_name_pluralstringrequired

    Return object's plural verbose_name

    meta_model_namestringrequired

    Return internal model name

    flow_set object[]
  • Array [
    • pkuuidrequired
    policybindingmodel_ptr_iduuidrequired
    namestringrequired
    slugstringrequired

    Visible in the URL.

    Possible values: <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    titlestringrequired

    Shown as the Title in Flow pages.

    designationFlowDesignationEnum (string)required

    Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.

    Possible values: [authentication, authorization, invalidation, enrollment, unenrollment, recovery, stage_configuration]

    backgroundstringrequired

    Get the URL to the background image. If the name is /static or starts with http it is returned as-is

    policy_engine_modePolicyEngineMode (string)

    Possible values: [all, any]

    compatibility_modeboolean

    Enable compatibility mode, increases compatibility with password managers on mobile devices.

    export_urlstringrequired

    Get export URL for flow

    layoutFlowLayoutEnum (string)

    Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]

    denied_actionDeniedActionEnum (string)

    Configure what should happen when a flow denies access to a user.

    Possible values: [message_continue, message, continue]

  • ]
    • not_configured_actionNotConfiguredActionEnum (string)

    Possible values: [skip, deny, configure]

    device_classesDeviceClassesEnum (string)[]

    Device classes which can be used to authenticate

    Possible values: [static, totp, webauthn, duo, sms, email]

    configuration_stagesuuid[]

    Stages used to configure Authenticator when user doesn't have any compatible devices. After this configuration Stage passes, the user is not prompted again.

    last_auth_thresholdstring

    If any of the user's device has been used within this threshold, this stage will be skipped

    webauthn_user_verificationUserVerificationEnum (string)

    Enforce user verification for WebAuthn devices.

    Possible values: [required, preferred, discouraged]

    webauthn_allowed_device_typesuuid[]
    webauthn_allowed_device_types_obj object[]required
  • Array [
    • aaguiduuidrequired
    descriptionstringrequired
  • ]

Authorization: http

name: authentiktype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "/api/v3/stages/authenticator/validate/:stage_uuid/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
/api/v3
Auth
Parameters
— pathrequired