Skip to main content

outposts_proxy_list

GET 
/outposts/proxy/

ProxyProvider Viewset

Request​

Query Parameters

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

    search string

    A search term.

Responses​

Schema

    pagination

    object

    required

    next numberrequired
    previous numberrequired
    count numberrequired
    current numberrequired
    total_pages numberrequired
    start_index numberrequired
    end_index numberrequired

    results

    object[]

    required

  • Array [

    • pk ID (integer)required
    name stringrequired
    internal_host uri
    external_host urirequired
    internal_host_ssl_validation boolean

    Validate SSL Certificates of upstream servers

    client_id string

    Possible values: <= 255 characters

    client_secret string

    Possible values: <= 255 characters

    oidc_configuration

    object

    required

    rest_framework Serializer for OIDC Configuration

    issuer stringrequired
    authorization_endpoint stringrequired
    token_endpoint stringrequired
    userinfo_endpoint stringrequired
    end_session_endpoint stringrequired
    introspection_endpoint stringrequired
    jwks_uri stringrequired
    response_types_supported string[]required
    id_token_signing_alg_values_supported string[]required
    subject_types_supported string[]required
    token_endpoint_auth_methods_supported string[]required
    cookie_secret string
    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)

    Enable support for forwardAuth in traefik and nginx auth_request. Exclusive with internal_host.

    Possible values: [proxy, forward_single, forward_domain]

    cookie_domain string
    access_token_validity doublenullablerequired

    Get token validity as second count

    intercept_header_auth boolean

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

    scopes_to_request string[]required

    Get all the scope names the outpost should request, including custom-defined ones

    assigned_application_slug stringrequired

    Internal application name, used in URLs.

    assigned_application_name stringrequired

    Application's display Name.

  • ]

Loading...