Skip to main content

sources_group_connections_oauth_list

GET 
/sources/group_connections/oauth/

Group-source connection Viewset

Request​

Query Parameters

    group uuid
    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.

    source__slug 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 ID (integer)required
    group uuidrequired

    source

    object

    required

    Source Serializer

    pk uuidrequired
    name stringrequired

    Source's display Name.

    slug stringrequired

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

    Internal source name, used in URLs.

    enabled boolean
    authentication_flow uuidnullable

    Flow to use when authenticating existing users.

    enrollment_flow uuidnullable

    Flow to use when enrolling new users.

    user_property_mappings uuid[]
    group_property_mappings uuid[]
    component stringrequired

    Get object 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

    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    user_matching_mode UserMatchingModeEnum (string)

    Possible values: [identifier, email_link, email_deny, username_link, username_deny]

    How the source determines if an existing user should be authenticated or a new user enrolled.

    managed Managed by authentik (string)nullablerequired

    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.

    user_path_template string
    icon stringnullablerequired

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

    identifier stringrequired
    created date-timerequired

  • ]

Loading...