Skip to content

Latest commit

 

History

History
37 lines (32 loc) · 3.29 KB

OAuthSource.md

File metadata and controls

37 lines (32 loc) · 3.29 KB

OAuthSource

Properties

Name Type Description Notes
pk uuid::Uuid [readonly]
name String Source's display Name.
slug String Internal source name, used in URLs.
enabled Option<bool> [optional]
authentication_flow Option<uuid::Uuid> Flow to use when authenticating existing users. [optional]
enrollment_flow Option<uuid::Uuid> Flow to use when enrolling new users. [optional]
component String Get object component so that we know how to edit the object [readonly]
verbose_name String Return object's verbose_name [readonly]
verbose_name_plural String Return object's plural verbose_name [readonly]
meta_model_name String Return internal model name [readonly]
policy_engine_mode Option<models::PolicyEngineMode> [optional]
user_matching_mode Option<models::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 Option<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]
user_path_template Option<String> [optional]
icon Option<String> Get the URL to the Icon. If the name is /static or starts with http it is returned as-is [readonly]
provider_type models::ProviderTypeEnum
request_token_url Option<String> URL used to request the initial token. This URL is only required for OAuth 1. [optional]
authorization_url Option<String> URL the user is redirect to to conest the flow. [optional]
access_token_url Option<String> URL used by authentik to retrieve tokens. [optional]
profile_url Option<String> URL used by authentik to get user information. [optional]
consumer_key String
callback_url String Get OAuth Callback URL [readonly]
additional_scopes Option<String> [optional]
r#type models::SourceType [readonly]
oidc_well_known_url Option<String> [optional]
oidc_jwks_url Option<String> [optional]
oidc_jwks Option<serde_json::Value> [optional]

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