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

name string

Possible values: non-empty

authentication_flow uuidnullable

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

authorization_flow uuid

Flow used when authorizing this provider.

property_mappings uuid[]
internal_host uri
external_host uri

Possible values: non-empty

internal_host_ssl_validation boolean

Validate SSL Certificates of upstream servers

certificate uuidnullable
skip_path_regex string

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

basic_auth_enabled Set HTTP-Basic Authentication (boolean)

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

basic_auth_password_attribute HTTP-Basic Password Key (string)

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

basic_auth_user_attribute HTTP-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.

mode ProxyMode (string)

Possible values: [proxy, forward_single, forward_domain]

intercept_header_auth boolean

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

cookie_domain string
jwks_sources uuid[]
access_token_validity string

Possible values: non-empty

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

refresh_token_validity string

Possible values: non-empty

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

Responses

200

application/json

Schema

Schema

pk ID (integer)required
name stringrequired
authentication_flow uuidnullable

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

authorization_flow uuidrequired

Flow used when authorizing this provider.

property_mappings uuid[]
component stringrequired

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

assigned_application_slug stringrequired

Internal application name, used in URLs.

assigned_application_name stringrequired

Application's display Name.

assigned_backchannel_application_slug stringrequired

Internal application name, used in URLs.

assigned_backchannel_application_name stringrequired

Application's display Name.

verbose_name stringrequired

Return object's verbose_name

verbose_name_plural stringrequired

Return object's plural verbose_name

meta_model_name stringrequired

Return internal model name

client_id stringrequired
internal_host uri
external_host urirequired
internal_host_ssl_validation boolean

Validate SSL Certificates of upstream servers

certificate uuidnullable
skip_path_regex string

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

basic_auth_enabled Set HTTP-Basic Authentication (boolean)

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

basic_auth_password_attribute HTTP-Basic Password Key (string)

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

basic_auth_user_attribute HTTP-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.

mode ProxyMode (string)

Possible values: [proxy, forward_single, forward_domain]

intercept_header_auth boolean

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

redirect_uris stringrequired
cookie_domain string
jwks_sources uuid[]
access_token_validity string

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

refresh_token_validity string

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

outpost_set string[]required

Example (from schema)

{
  "pk": 0,
  "name": "string",
  "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "authorization_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": "string",
  "cookie_domain": "string",
  "jwks_sources": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "access_token_validity": "string",
  "refresh_token_validity": "string",
  "outpost_set": [
    "string"
  ]
}

400

application/json

Schema

Schema

non_field_errors string[]
code string

Example (from schema)

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

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PATCH '/api/v3/providers/proxy/:id/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "authorization_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",
  "jwks_sources": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "access_token_validity": "string",
  "refresh_token_validity": "string"
}'

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