sources_kerberos_list

GET 
/api/v3//sources/kerberos/

Kerberos Source Viewset

Request

Query Parameters

enabled boolean
kadmin_type string

Possible values: [Heimdal, MIT, other]

KAdmin server type

name string
ordering string

Which field to use when ordering the results.

page integer

A page number within the paginated result set.

page_size integer

Number of results to return per page.

password_login_update_internal_password boolean
pbm_uuid uuid
realm string
search string

A search term.

slug string
spnego_server_name string
sync_principal string
sync_users boolean
sync_users_password boolean

Responses

200

application/json

Schema

Schema

pagination objectrequired
nextnumberrequired
previousnumberrequired
countnumberrequired
currentnumberrequired
total_pagesnumberrequired
start_indexnumberrequired
end_indexnumberrequired
results object[]required
Array [
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
iconstringrequired
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]
realmstringrequired
Kerberos realm
krb5_confstring
Custom krb5.conf to use. Uses the system one by default
kadmin_typeKadminTypeEnum (string)
KAdmin server type
Possible values: [MIT, Heimdal, other]
sync_usersboolean
Sync users from Kerberos into authentik
sync_users_passwordboolean
When a user changes their password, sync it back to Kerberos
sync_principalstring
Principal to authenticate to kadmin for sync.
sync_ccachestring
Credentials cache to authenticate to kadmin for sync. Must be in the form TYPE:residual
connectivity objectnullablerequired
Get cached source connectivity
property name*string
spnego_server_namestring
Force the use of a specific server name for SPNEGO. Must be in the form HTTP@hostname
spnego_ccachestring
Credential cache to use for SPNEGO in form type:residual
password_login_update_internal_passwordboolean
If enabled, the authentik-stored password will be updated upon login with the Kerberos password backend
]

Example (auto)

{
  "pagination": {
    "next": 0,
    "previous": 0,
    "count": 0,
    "current": 0,
    "total_pages": 0,
    "start_index": 0,
    "end_index": 0
  },
  "results": [
    {
      "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",
      "realm": "string",
      "krb5_conf": "string",
      "kadmin_type": "MIT",
      "sync_users": true,
      "sync_users_password": true,
      "sync_principal": "string",
      "sync_ccache": "string",
      "connectivity": {},
      "spnego_server_name": "string",
      "spnego_ccache": "string",
      "password_login_update_internal_password": true
    }
  ]
}

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

enabled — query

---truefalse

kadmin_type — query

---HeimdalMITother

name — query

ordering — query

page — query

page_size — query

password_login_update_internal_password — query

---truefalse

pbm_uuid — query

realm — query

search — query

slug — query

spnego_server_name — query

sync_principal — query

sync_users — query

---truefalse

sync_users_password — query

---truefalse