sources_oauth_partial_update

PATCH 
/api/v3//sources/oauth/:slug/

Source Viewset

Request

Path Parameters

slug stringrequired

application/json

Body

namestring
Source's display Name.
Possible values: non-empty
slugstring
Internal source name, used in URLs.
Possible values: non-empty and <= 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[]
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]
user_path_templatestring
Possible values: non-empty
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)
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_keystring
Possible values: non-empty
consumer_secretstring
Possible values: non-empty
additional_scopesstring
oidc_well_known_urlstring
oidc_jwks_urlstring
oidc_jwks

Responses

200

application/json

Schema

Schema

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

Example (auto)

{
  "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "slug": "string",
  "enabled": true,
  "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enrollment_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "user_property_mappings": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "group_property_mappings": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "component": "string",
  "verbose_name": "string",
  "verbose_name_plural": "string",
  "meta_model_name": "string",
  "policy_engine_mode": "all",
  "user_matching_mode": "identifier",
  "managed": "string",
  "user_path_template": "string",
  "icon": "string",
  "group_matching_mode": "identifier",
  "provider_type": "apple",
  "request_token_url": "string",
  "authorization_url": "string",
  "access_token_url": "string",
  "profile_url": "string",
  "consumer_key": "string",
  "callback_url": "string",
  "additional_scopes": "string",
  "type": {
    "name": "string",
    "verbose_name": "string",
    "urls_customizable": true,
    "request_token_url": "string",
    "authorization_url": "string",
    "access_token_url": "string",
    "profile_url": "string",
    "oidc_well_known_url": "string",
    "oidc_jwks_url": "string"
  },
  "oidc_well_known_url": "string",
  "oidc_jwks_url": "string",
  "oidc_jwks": {}
}

400

application/json

Schema

Schema

non_field_errorsstring[]

codestring

property name*any

Validation Error

Example (auto)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detailstringrequired
codestring

Example (auto)

{
  "detail": "string",
  "code": "string"
}

Authorization: http

name: authentiktype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

slug — pathrequired

Body

{
  "name": "string",
  "slug": "string",
  "enabled": true,
  "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enrollment_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "user_property_mappings": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "group_property_mappings": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "policy_engine_mode": "all",
  "user_matching_mode": "identifier",
  "user_path_template": "string",
  "group_matching_mode": "identifier",
  "provider_type": "apple",
  "request_token_url": "string",
  "authorization_url": "string",
  "access_token_url": "string",
  "profile_url": "string",
  "consumer_key": "string",
  "consumer_secret": "string",
  "additional_scopes": "string",
  "oidc_well_known_url": "string",
  "oidc_jwks_url": "string",
  "oidc_jwks": {}
}