Sign in
sources

Source Viewset

get/sources/oauth/{slug}/

Path parameters

slugstring required

Internal source name, used in URLs.

Response

pkstring uuid required
namestring required

Source's display Name.

slugstring required

Internal source name, used in URLs.

enabledboolean
promotedboolean

When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

authentication_flowstring uuid nullable

Flow to use when authenticating existing users.

enrollment_flowstring uuid nullable

Flow to use when enrolling new users.

user_property_mappingsstring[]
group_property_mappingsstring[]
componentstring required

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

verbose_namestring required

Return object's verbose_name

verbose_name_pluralstring required

Return object's plural verbose_name

meta_model_namestring required

Return internal model name

policy_engine_mode'all' | 'any'
user_matching_mode'identifier' | 'email_link' | 'email_deny' | 'username_link' | 'username_deny'
managedstring nullable required

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
iconstring
icon_urlstring nullable required
group_matching_mode'identifier' | 'name_link' | 'name_deny'
provider_type'openidconnect' | 'apple' | 'discord' | 'entraid' | 'facebook' | 'github' | 'gitlab' | 'google' | 'mailcow' | 'okta' | 'patreon' | 'reddit' | 'slack' | 'twitch' | 'twitter' | 'wechat' required
request_token_urlstring nullable

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

authorization_urlstring nullable

URL the user is redirect to to conest the flow.

access_token_urlstring nullable

URL used by authentik to retrieve tokens.

profile_urlstring nullable

URL used by authentik to get user information.

pkce'none' | 'plain' | 'S256'
consumer_keystring required
callback_urlstring required

Get OAuth Callback URL

additional_scopesstring
oidc_well_known_urlstring
oidc_jwks_urlstring
oidc_jwksobject
authorization_code_auth_method'basic_auth' | 'post_body'

Changes

No recorded changes to this endpoint across all 1 revision of this API.