Skip to main content

core_applications_list

GET 
/core/applications/

Custom list method that checks Policy based access instead of guardian

Request​

Query Parameters

    for_user integer
    group string
    meta_description string
    meta_launch_url string
    meta_publisher string
    name string
    only_with_launch_url boolean
    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.

    slug string
    superuser_full_list boolean

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

    Application's display Name.

    slug stringrequired

    Internal application name, used in URLs.

    Possible values: <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    provider integernullable

    provider_obj

    object

    required

    Provider Serializer

    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

    backchannel_providers integer[]

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

    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

  • ]

    • launch_url stringnullablerequired

    Allow formatting of launch URL

    open_in_new_tab boolean

    Open launch URL in a new browser tab or window.

    meta_launch_url uri
    meta_icon stringnullablerequired

    Get the URL to the App Icon image. If the name is /static or starts with http it is returned as-is

    meta_description string
    meta_publisher string
    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    group string

  • ]

Loading...