Skip to main content

sources_oauth_create

POST 
/sources/oauth/

Source Viewset

Request​

Body

required

    name stringrequired

    Source's display Name.

    Possible values: non-empty

    slug stringrequired

    Internal source name, used in URLs.

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

    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[]
    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    user_matching_mode UserMatchingModeEnum (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]

    user_path_template string

    Possible values: non-empty

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

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

    request_token_url stringnullable

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

    Possible values: <= 255 characters

    authorization_url stringnullable

    URL the user is redirect to to conest the flow.

    Possible values: <= 255 characters

    access_token_url stringnullable

    URL used by authentik to retrieve tokens.

    Possible values: <= 255 characters

    profile_url stringnullable

    URL used by authentik to get user information.

    Possible values: <= 255 characters

    consumer_key stringrequired

    Possible values: non-empty

    consumer_secret stringrequired

    Possible values: non-empty

    additional_scopes string
    oidc_well_known_url string
    oidc_jwks_url string
    oidc_jwks

Responses​

Schema

    pk uuidrequired
    name stringrequired

    Source's display Name.

    slug stringrequired

    Internal source name, used in URLs.

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

    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)

    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]

    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)

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

    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

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

    Possible values: <= 255 characters

    authorization_url stringnullable

    URL the user is redirect to to conest the flow.

    Possible values: <= 255 characters

    access_token_url stringnullable

    URL used by authentik to retrieve tokens.

    Possible values: <= 255 characters

    profile_url stringnullable

    URL used by authentik to get user information.

    Possible values: <= 255 characters

    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...