sources_oauth_update
PUT/sources/oauth/:slug/
Source Viewset
Request
Path Parameters
- application/json
Body
required
Source's display Name.
Possible values: non-empty
Internal source name, used in URLs.
Possible values: non-empty
and <= 50 characters
, Value must match regular expression ^[-a-zA-Z0-9_]+$
Flow to use when authenticating existing users.
Flow to use when enrolling new users.
Possible values: [all
, any
]
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
]
Possible values: non-empty
How the source determines if an existing group should be used or a new group created.
Possible values: [identifier
, name_link
, name_deny
]
Possible values: [apple
, openidconnect
, azuread
, discord
, facebook
, github
, gitlab
, google
, mailcow
, okta
, patreon
, reddit
, twitch
, twitter
]
URL used to request the initial token. This URL is only required for OAuth 1.
Possible values: <= 255 characters
URL the user is redirect to to conest the flow.
Possible values: <= 255 characters
URL used by authentik to retrieve tokens.
Possible values: <= 255 characters
URL used by authentik to get user information.
Possible values: <= 255 characters
Possible values: non-empty
Possible values: non-empty
Responses
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
Source's display Name.
Internal source name, used in URLs.
Possible values: <= 50 characters
, Value must match regular expression ^[-a-zA-Z0-9_]+$
Flow to use when authenticating existing users.
Flow to use when enrolling new users.
Get object component so that we know how to edit the object
Return object's verbose_name
Return object's plural verbose_name
Return internal model name
Possible values: [all
, any
]
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
]
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.
How the source determines if an existing group should be used or a new group created.
Possible values: [identifier
, name_link
, name_deny
]
Possible values: [apple
, openidconnect
, azuread
, discord
, facebook
, github
, gitlab
, google
, mailcow
, okta
, patreon
, reddit
, twitch
, twitter
]
URL used to request the initial token. This URL is only required for OAuth 1.
Possible values: <= 255 characters
URL the user is redirect to to conest the flow.
Possible values: <= 255 characters
URL used by authentik to retrieve tokens.
Possible values: <= 255 characters
URL used by authentik to get user information.
Possible values: <= 255 characters
Get OAuth Callback URL
type
object
required
Serializer for SourceType
{
"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",
"managed": "string",
"user_path_template": "string",
"icon": "string",
"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",
"oidc_well_known_url": "string",
"oidc_jwks_url": "string",
"oidc_jwks": {}
}
- application/json
- Schema
- Example (from schema)
Schema
Validation Error
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "string",
"code": "string"
}