Skip to main content

sources_oauth_list

GET 
/sources/oauth/

Source Viewset

Request​

Query Parameters

    access_token_url string
    additional_scopes string
    authentication_flow uuid
    authorization_url string
    consumer_key string
    enabled boolean
    enrollment_flow uuid
    group_matching_mode string

    Possible values: [identifier, name_deny, name_link]

    How the source determines if an existing group should be used or a new group created.

    has_jwks boolean

    Only return sources with JWKS data

    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.

    policy_engine_mode string

    Possible values: [all, any]

    profile_url string
    provider_type string
    request_token_url string
    search string

    A search term.

    slug string
    user_matching_mode string

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

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

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

    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]

    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
    group_matching_mode GroupMatchingModeEnum (string)

    Possible values: [identifier, name_link, name_deny]

    provider_type ProviderTypeEnum (string)required

    Possible values: [apple, openidconnect, azuread, discord, facebook, github, gitlab, google, mailcow, okta, patreon, reddit, twitch, twitter]

    request_token_url stringnullable

    Possible values: <= 255 characters

    URL used to request the initial token. This URL is only required for OAuth 1.

    authorization_url stringnullable

    Possible values: <= 255 characters

    URL the user is redirect to to conest the flow.

    access_token_url stringnullable

    Possible values: <= 255 characters

    URL used by authentik to retrieve tokens.

    profile_url stringnullable

    Possible values: <= 255 characters

    URL used by authentik to get user information.

    consumer_key stringrequired
    callback_url stringrequired

    Get OAuth Callback URL

    additional_scopes string

    type

    object

    required

    Serializer for SourceType

    name stringrequired
    verbose_name stringrequired
    urls_customizable booleanrequired
    request_token_url stringnullablerequired
    authorization_url stringnullablerequired
    access_token_url stringnullablerequired
    profile_url stringnullablerequired
    oidc_well_known_url stringnullablerequired
    oidc_jwks_url stringnullablerequired
    oidc_well_known_url string
    oidc_jwks_url string
    oidc_jwks

  • ]

Loading...