Skip to main content

sources_user_connections_oauth_partial_update

PATCH 
/api/v3//sources/user_connections/oauth/:id/

Source Viewset

Request​

Path Parameters

    id integerrequired

    A unique integer value identifying this User OAuth Source Connection.

Body

    user integer
    identifier string

    Possible values: non-empty and <= 255 characters

    access_token stringnullable

Responses​

Schema

    pk ID (integer)required
    user integerrequired

    source

    object

    required

    Source Serializer

    pk uuidrequired
    name stringrequired

    Source's display Name.

    slug stringrequired

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

    Internal source name, used in URLs.

    enabled boolean
    authentication_flow uuidnullable

    Flow to use when authenticating existing users.

    enrollment_flow uuidnullable

    Flow to use when enrolling new users.

    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)

    Possible values: [identifier, email_link, email_deny, username_link, username_deny]

    How the source determines if an existing user should be authenticated or a new user enrolled.

    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

    Get the URL to the Icon. If the name is /static or starts with http it is returned as-is

    identifier stringrequired

    Possible values: <= 255 characters

curl -L -X PATCH '/api/v3/sources/user_connections/oauth/:id/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "user": 0,
  "identifier": "string",
  "access_token": "string"
}'
Request Collapse all
Base URL
/api/v3
Auth
Parameters
— pathrequired
Body
{
  "user": 0,
  "identifier": "string",
  "access_token": "string"
}