providers_proxy_list

GET /api/v3//providers/proxy/

ProxyProvider Viewset

Request

Query Parameters

application__isnull boolean

authorization_flow__slug__iexact string

basic_auth_enabled__iexact boolean

basic_auth_password_attribute__iexact string

basic_auth_user_attribute__iexact string

certificate__kp_uuid__iexact uuid

certificate__name__iexact string

cookie_domain__iexact string

external_host__iexact string

internal_host__iexact string

internal_host_ssl_validation__iexact boolean

mode__iexact string

name__iexact string

ordering string

Which field to use when ordering the results.

page integer

A page number within the paginated result set.

page_size integer

Number of results to return per page.

property_mappings__iexact uuid[]

search string

A search term.

skip_path_regex__iexact string

Responses

application/json

Schema
Example (auto)

Schema

pagination objectrequired

results object[]required

Array [

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

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

]

{
  "pagination": {
    "next": 0,
    "previous": 0,
    "count": 0,
    "current": 0,
    "total_pages": 0,
    "start_index": 0,
    "end_index": 0
  },
  "results": [
    {
      "pk": 0,
      "name": "string",
      "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "authorization_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "invalidation_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "property_mappings": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "component": "string",
      "assigned_application_slug": "string",
      "assigned_application_name": "string",
      "assigned_backchannel_application_slug": "string",
      "assigned_backchannel_application_name": "string",
      "verbose_name": "string",
      "verbose_name_plural": "string",
      "meta_model_name": "string",
      "client_id": "string",
      "internal_host": "string",
      "external_host": "string",
      "internal_host_ssl_validation": true,
      "certificate": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "skip_path_regex": "string",
      "basic_auth_enabled": true,
      "basic_auth_password_attribute": "string",
      "basic_auth_user_attribute": "string",
      "mode": "proxy",
      "intercept_header_auth": true,
      "redirect_uris": [
        {
          "matching_mode": "strict",
          "url": "string"
        }
      ],
      "cookie_domain": "string",
      "jwt_federation_sources": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "jwt_federation_providers": [
        0
      ],
      "access_token_validity": "string",
      "refresh_token_validity": "string",
      "outpost_set": [
        "string"
      ]
    }
  ]
}

application/json

Schema
Example (auto)

Schema

non_field_errorsstring[]

codestring

property name*any

Validation Error

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

application/json

Schema
Example (auto)

Schema

detailstringrequired

codestring

{
  "detail": "string",
  "code": "string"
}

Authorization: http

name: authentiktype: httpscheme: bearer

HTTPCLIENT
RESTSHARP

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

providers_proxy_list

/api/v3//providers/proxy/

Request​

Query Parameters

Responses​

Authorization: http

Request

Responses