Skip to main content

outposts_instances_list

GET 
/outposts/instances/

Outpost Viewset

Request​

Query Parameters

    managed__icontains string
    managed__iexact string
    name__icontains string
    name__iexact 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.

    providers__isnull boolean
    providers_by_pk integer[]
    search string

    A search term.

    service_connection__name__icontains string
    service_connection__name__iexact string

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 uuidrequired
    name stringrequired
    type OutpostTypeEnum (string)required

    Possible values: [proxy, ldap, radius, rac]

    providers integer[]required

    providers_obj

    object[]

    required

  • Array [

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

    invalidation_flow uuidrequired

    Flow used ending the session from a 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

  • ]

    • service_connection uuidnullable

    Select Service-Connection authentik should use to manage this outpost. Leave empty if authentik should not handle the deployment.

    service_connection_obj

    object

    required

    ServiceConnection Serializer

    pk uuidrequired
    name stringrequired
    local boolean

    If enabled, use the local connection. Required Docker socket/Kubernetes Integration

    component stringrequired

    Return component used to edit this object

    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

    refresh_interval_s integerrequired
    token_identifier stringrequired

    Get Token identifier

    config

    object

    required

    property name* any
    managed Managed by authentik (string)nullable

    Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.

  • ]

Loading...