OAuthSource.md

OAuthSource

Properties

Name	Type	Description	Notes
pk	UUID		[readonly]
name	String	Source's display Name.
slug	String	Internal source name, used in URLs.
enabled	Bool		[optional]
authenticationFlow	UUID	Flow to use when authenticating existing users.	[optional]
enrollmentFlow	UUID	Flow to use when enrolling new users.	[optional]
component	String	Get object component so that we know how to edit the object	[readonly]
verboseName	String	Return object's verbose_name	[readonly]
verboseNamePlural	String	Return object's plural verbose_name	[readonly]
metaModelName	String	Return internal model name	[readonly]
policyEngineMode	PolicyEngineMode		[optional]
userMatchingMode	UserMatchingModeEnum	How the source determines if an existing user should be authenticated or a new user enrolled. * `identifier` - Use the source-specific identifier * `email_link` - Link to a user with identical email address. Can have security implications when a source doesn't validate email addresses. * `email_deny` - Use the user's email address, but deny enrollment when the email address already exists. * `username_link` - Link to a user with identical username. Can have security implications when a username is used with another source. * `username_deny` - Use the user's username, but deny enrollment when the username already exists.	[optional]
managed	String	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.	[readonly]
userPathTemplate	String		[optional]
icon	String	Get the URL to the Icon. If the name is /static or starts with http it is returned as-is	[readonly]
providerType	ProviderTypeEnum
requestTokenUrl	String	URL used to request the initial token. This URL is only required for OAuth 1.	[optional]
authorizationUrl	String	URL the user is redirect to to conest the flow.	[optional]
accessTokenUrl	String	URL used by authentik to retrieve tokens.	[optional]
profileUrl	String	URL used by authentik to get user information.	[optional]
consumerKey	String
callbackUrl	String	Get OAuth Callback URL	[readonly]
additionalScopes	String		[optional]
type	SourceType		[readonly]
oidcWellKnownUrl	String		[optional]
oidcJwksUrl	String		[optional]
oidcJwks	AnyCodable		[optional]

[Back to Model list] [Back to API list] [Back to README]