Sign in
providers

ProxyProvider Viewset

patch/providers/proxy/{id}/

Path parameters

idinteger required

A unique integer value identifying this Proxy Provider.

Request body

namestring
authentication_flowstring uuid nullable

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

authorization_flowstring uuid

Flow used when authorizing this provider.

invalidation_flowstring uuid

Flow used ending the session from a provider.

property_mappingsstring[]
internal_hoststring uri
external_hoststring uri
internal_host_ssl_validationboolean

Validate SSL Certificates of upstream servers

certificatestring uuid nullable
skip_path_regexstring

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

basic_auth_enabledboolean

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

basic_auth_password_attributestring

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

basic_auth_user_attributestring

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

mode'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_sourcesstring[]
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).

Response

pkinteger required
namestring required
authentication_flowstring uuid nullable

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

authorization_flowstring uuid required

Flow used when authorizing this provider.

invalidation_flowstring uuid required

Flow used ending the session from a provider.

property_mappingsstring[]
componentstring required

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

assigned_application_slugstring nullable required

Internal application name, used in URLs.

assigned_application_namestring nullable required

Application's display Name.

assigned_backchannel_application_slugstring nullable required

Internal application name, used in URLs.

assigned_backchannel_application_namestring nullable required

Application's display Name.

verbose_namestring required

Return object's verbose_name

verbose_name_pluralstring required

Return object's plural verbose_name

meta_model_namestring required

Return internal model name

client_idstring required
internal_hoststring uri
external_hoststring uri required
internal_host_ssl_validationboolean

Validate SSL Certificates of upstream servers

certificatestring uuid nullable
skip_path_regexstring

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

basic_auth_enabledboolean

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

basic_auth_password_attributestring

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

basic_auth_user_attributestring

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

mode'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_sourcesstring[]
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

Changes

No recorded changes to this endpoint across all 1 revision of this API.