Skip to main content

stages_password_retrieve

GET 
/api/v3//stages/password/:stage_uuid/

PasswordStage Viewset

Request​

Path Parameters

    stage_uuid uuidrequired

    A UUID string identifying this Password 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]

  • ]
    • backendsBackendsEnum (string)[]required

    Selection of backends to test the password against.

    Possible values: [authentik.core.auth.InbuiltBackend, authentik.core.auth.TokenBackend, authentik.sources.ldap.auth.LDAPBackend, authentik.sources.kerberos.auth.KerberosBackend]

    configure_flowuuidnullable

    Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage.

    failed_attempts_before_cancelinteger

    How many attempts a user has before the flow is canceled. To lock the user out, use a reputation policy and a user_write stage.

    Possible values: >= -2147483648 and <= 2147483647

    allow_show_passwordboolean

    When enabled, provides a 'show password' button with the password input field.

Authorization: http

name: authentiktype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "/api/v3/stages/password/: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