providers_proxy_partial_update

PATCH 
/api/v3//providers/proxy/:id/

ProxyProvider Viewset

Request

Path Parameters

id integerrequired

A unique integer value identifying this Proxy Provider.

application/json

Body

namestring

Possible values: non-empty

authentication_flowuuidnullable

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

authorization_flowuuid

Flow used when authorizing this provider.

invalidation_flowuuid

Flow used ending the session from a provider.

property_mappingsuuid[]

internal_hosturi

external_hosturi

Possible values: non-empty

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.

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).

Possible values: non-empty

refresh_token_validitystring

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

Possible values: non-empty

Responses

200

application/json

Schema

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

Example (auto)

{
  "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"
  ]
}

400

application/json

Schema

Schema

non_field_errorsstring[]

codestring

property name*any

Validation Error

Example (auto)

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

403

application/json

Schema

Schema

detailstringrequired
codestring

Example (auto)

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

Authorization: http

name: authentiktype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "/api/v3/providers/proxy/:id/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"authentication_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"authorization_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"invalidation_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"property_mappings\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ],\n  \"internal_host\": \"string\",\n  \"external_host\": \"string\",\n  \"internal_host_ssl_validation\": true,\n  \"certificate\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"skip_path_regex\": \"string\",\n  \"basic_auth_enabled\": true,\n  \"basic_auth_password_attribute\": \"string\",\n  \"basic_auth_user_attribute\": \"string\",\n  \"mode\": \"proxy\",\n  \"intercept_header_auth\": true,\n  \"cookie_domain\": \"string\",\n  \"jwt_federation_sources\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ],\n  \"jwt_federation_providers\": [\n    0\n  ],\n  \"access_token_validity\": \"string\",\n  \"refresh_token_validity\": \"string\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

id — pathrequired

Body

{
  "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"
  ],
  "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,
  "cookie_domain": "string",
  "jwt_federation_sources": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "jwt_federation_providers": [
    0
  ],
  "access_token_validity": "string",
  "refresh_token_validity": "string"
}