providers_proxy_create
POST/api/v3//providers/proxy/
ProxyProvider Viewset
Request
- application/json
Body
required
Possible values: non-empty
Flow used for authentication when the associated application is accessed by an un-authenticated user.
Flow used when authorizing this provider.
Flow used ending the session from a provider.
Possible values: non-empty
Validate SSL Certificates of upstream servers
Regular expressions for which authentication is not required. Each new line is interpreted as a new Regular Expression.
Set a custom HTTP-Basic Authentication header based on values from authentik.
User/Group Attribute used for the password part of the HTTP-Basic Header.
User/Group Attribute used for the user part of the HTTP-Basic Header. If not set, the user's Email address is used.
Enable support for forwardAuth in traefik and nginx auth_request. Exclusive with internal_host.
Possible values: [proxy, forward_single, forward_domain]
When enabled, this provider will intercept the authorization header and authenticate requests based on its value.
Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).
Possible values: non-empty
Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).
Possible values: non-empty
Responses
- 201
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
Flow used for authentication when the associated application is accessed by an un-authenticated user.
Flow used when authorizing this provider.
Flow used ending the session from a provider.
Get object component so that we know how to edit the object
Internal application name, used in URLs.
Application's display Name.
Internal application name, used in URLs.
Application's display Name.
Return object's verbose_name
Return object's plural verbose_name
Return internal model name
Validate SSL Certificates of upstream servers
Regular expressions for which authentication is not required. Each new line is interpreted as a new Regular Expression.
Set a custom HTTP-Basic Authentication header based on values from authentik.
User/Group Attribute used for the password part of the HTTP-Basic Header.
User/Group Attribute used for the user part of the HTTP-Basic Header. If not set, the user's Email address is used.
Enable support for forwardAuth in traefik and nginx auth_request. Exclusive with internal_host.
Possible values: [proxy, forward_single, forward_domain]
When enabled, this provider will intercept the authorization header and authenticate requests based on its value.
redirect_uris
object[]
required
Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).
Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).
{
"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",
"intercept_header_auth": true,
"redirect_uris": [
{
"matching_mode": "strict",
"url": "string"
}
],
"cookie_domain": "string",
"jwks_sources": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"access_token_validity": "string",
"refresh_token_validity": "string",
"outpost_set": [
"string"
]
}
- application/json
- Schema
- Example (from schema)
Schema
Validation Error
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
{
"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.Post, "/api/v3/providers/proxy/");
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 \"jwks_sources\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\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());