Skip to main content

providers_proxy_retrieve

GET 
/api/v3//providers/proxy/:id/

ProxyProvider Viewset

Request​

Path Parameters

    id integerrequired

    A unique integer value identifying this Proxy Provider.

Responses​

Schema
    pkID (integer)required
    namestringrequired
    authentication_flowuuidnullable

    Flow used for authentication when the associated application is accessed by an un-authenticated user.

    authorization_flowuuidrequired

    Flow used when authorizing this provider.

    invalidation_flowuuidrequired

    Flow used ending the session from a provider.

    property_mappingsuuid[]
    componentstringrequired

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

    assigned_application_slugstringrequired

    Internal application name, used in URLs.

    assigned_application_namestringrequired

    Application's display Name.

    assigned_backchannel_application_slugstringrequired

    Internal application name, used in URLs.

    assigned_backchannel_application_namestringrequired

    Application's display Name.

    verbose_namestringrequired

    Return object's verbose_name

    verbose_name_pluralstringrequired

    Return object's plural verbose_name

    meta_model_namestringrequired

    Return internal model name

    client_idstringrequired
    internal_hosturi
    external_hosturirequired
    internal_host_ssl_validationboolean

    Validate SSL Certificates of upstream servers

    certificateuuidnullable
    skip_path_regexstring

    Regular expressions for which authentication is not required. Each new line is interpreted as a new Regular Expression.

    basic_auth_enabledSet HTTP-Basic Authentication (boolean)

    Set a custom HTTP-Basic Authentication header based on values from authentik.

    basic_auth_password_attributeHTTP-Basic Password Key (string)

    User/Group Attribute used for the password part of the HTTP-Basic Header.

    basic_auth_user_attributeHTTP-Basic Username Key (string)

    User/Group Attribute used for the user part of the HTTP-Basic Header. If not set, the user's Email address is used.

    modeProxyMode (string)

    Enable support for forwardAuth in traefik and nginx auth_request. Exclusive with internal_host.

    Possible values: [proxy, forward_single, forward_domain]

    intercept_header_authboolean

    When enabled, this provider will intercept the authorization header and authenticate requests based on its value.

    redirect_uris object[]required
  • Array [
    • matching_modeMatchingModeEnum (string)required

    Possible values: [strict, regex]

    urlstringrequired
  • ]
    • cookie_domainstring
    jwt_federation_sourcesuuid[]
    jwt_federation_providersinteger[]
    access_token_validitystring

    Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).

    refresh_token_validitystring

    Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).

    outpost_setstring[]required

Authorization: http

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