Skip to main content

sources_oauth_list

GET 
/api/v3//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.

    pbm_uuid uuid
    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 objectrequired
    nextnumberrequired
    previousnumberrequired
    countnumberrequired
    currentnumberrequired
    total_pagesnumberrequired
    start_indexnumberrequired
    end_indexnumberrequired
    results object[]required
  • Array [
    • pkuuidrequired
    namestringrequired

    Source's display Name.

    slugstringrequired

    Internal source name, used in URLs.

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

    enabledboolean
    authentication_flowuuidnullable

    Flow to use when authenticating existing users.

    enrollment_flowuuidnullable

    Flow to use when enrolling new users.

    user_property_mappingsuuid[]
    group_property_mappingsuuid[]
    componentstringrequired

    Get object component so that we know how to edit the object

    verbose_namestringrequired

    Return object's verbose_name

    verbose_name_pluralstringrequired

    Return object's plural verbose_name

    meta_model_namestringrequired

    Return internal model name

    policy_engine_modePolicyEngineMode (string)

    Possible values: [all, any]

    user_matching_modeUserMatchingModeEnum (string)

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

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

    managedManaged 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_templatestring
    iconstringnullablerequired
    group_matching_modeGroupMatchingModeEnum (string)

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

    Possible values: [identifier, name_link, name_deny]

    provider_typeProviderTypeEnum (string)required

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

    request_token_urlstringnullable

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

    Possible values: <= 255 characters

    authorization_urlstringnullable

    URL the user is redirect to to conest the flow.

    Possible values: <= 255 characters

    access_token_urlstringnullable

    URL used by authentik to retrieve tokens.

    Possible values: <= 255 characters

    profile_urlstringnullable

    URL used by authentik to get user information.

    Possible values: <= 255 characters

    consumer_keystringrequired
    callback_urlstringrequired

    Get OAuth Callback URL

    additional_scopesstring
    type object

    Serializer for SourceType

    namestringrequired
    verbose_namestringrequired
    urls_customizablebooleanrequired
    request_token_urlstringnullablerequired
    authorization_urlstringnullablerequired
    access_token_urlstringnullablerequired
    profile_urlstringnullablerequired
    oidc_well_known_urlstringnullablerequired
    oidc_jwks_urlstringnullablerequired
    oidc_well_known_urlstring
    oidc_jwks_urlstring
    oidc_jwks
    authorization_code_auth_methodAuthorizationCodeAuthMethodEnum (string)

    How to perform authentication during an authorization_code token request flow

    Possible values: [basic_auth, post_body]

  • ]

Authorization: http

name: authentiktype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "/api/v3/sources/oauth/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
/api/v3
Auth
Parameters
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query