Skip to main content

propertymappings_provider_scope_list

GET 
/propertymappings/provider/scope/

ScopeMapping Viewset

Request​

Query Parameters

    managed string[]
    managed__isnull boolean
    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.

    scope_name string
    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 uuidrequired
    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.

    name stringrequired
    expression stringrequired
    component stringrequired

    Get object's component so that we know how to edit the 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

    scope_name stringrequired

    Scope name requested by the client

    description string

    Description shown to the user when consenting. If left empty, the user won't be informed.

  • ]

Loading...