Third party¶
-
class
axes.models.
AccessAttempt
(id, user_agent, ip_address, username, http_accept, path_info, attempt_time, get_data, post_data, failures_since_start)¶ - Parameters
id (AutoField) – Id
user_agent (CharField) – User agent
ip_address (GenericIPAddressField) – Ip address
username (CharField) – Gebruikersnaam
http_accept (CharField) – Http accept
path_info (CharField) – Path
attempt_time (DateTimeField) – Attempt time
get_data (TextField) – Get data
post_data (TextField) – Post data
failures_since_start (PositiveIntegerField) – Failed logins
-
class
axes.models.
AccessFailureLog
(id, user_agent, ip_address, username, http_accept, path_info, attempt_time, locked_out)¶ - Parameters
id (AutoField) – Id
user_agent (CharField) – User agent
ip_address (GenericIPAddressField) – Ip address
username (CharField) – Gebruikersnaam
http_accept (CharField) – Http accept
path_info (CharField) – Path
attempt_time (DateTimeField) – Attempt time
locked_out (BooleanField) – Access lock out
-
class
axes.models.
AccessLog
(id, user_agent, ip_address, username, http_accept, path_info, attempt_time, logout_time)¶ - Parameters
id (AutoField) – Id
user_agent (CharField) – User agent
ip_address (GenericIPAddressField) – Ip address
username (CharField) – Gebruikersnaam
http_accept (CharField) – Http accept
path_info (CharField) – Path
attempt_time (DateTimeField) – Attempt time
logout_time (DateTimeField) – Logout time
-
class
django.contrib.admin.models.
LogEntry
(id, action_time, user, content_type, object_id, object_repr, action_flag, change_message)¶ - Parameters
id (AutoField) – Id
action_time (DateTimeField) – Actietijd
user_id (ForeignKey to
User
) – Gebruikercontent_type_id (ForeignKey to
ContentType
) – Inhoudstypeobject_id (TextField) – Object-id
object_repr (CharField) – Object-repr
action_flag (PositiveSmallIntegerField) – Actievlag
change_message (TextField) – Wijzigingsbericht
-
get_admin_url
()¶ Return the admin URL to edit the object represented by this log entry.
-
get_change_message
()¶ If self.change_message is a JSON structure, interpret it as a change string, properly translated.
-
get_edited_object
()¶ Return the edited object represented by this log entry.
-
class
django.contrib.auth.models.
AbstractUser
(*args, **kwargs)¶ An abstract base class implementing a fully featured User model with admin-compliant permissions.
Username and password are required. Other fields are optional.
- Parameters
password (CharField) – Wachtwoord
last_login (DateTimeField) – Laatste aanmelding
is_superuser (BooleanField) – Bepaalt dat deze gebruiker alle rechten heeft, zonder deze expliciet toe te wijzen.
username (CharField) – Vereist. 150 tekens of minder. Alleen letters, cijfers en de tekens @/,/+/-/_ zijn toegestaan.
first_name (CharField) – Voornaam
last_name (CharField) – Achternaam
email (EmailField) – Emailadres
is_staff (BooleanField) – Bepaalt of een gebruiker kan inloggen op deze admin site.
is_active (BooleanField) – Bepaalt of een gebruiker als actief behandeld moet worden. Deselecteer dit i.p.v. accounten te verwijderen.
date_joined (DateTimeField) – Toetredingsdatum
groups (ManyToManyField) – De groep waartoe deze gebruiker behoort. Gebruikers krijgen alle rechten behorende bij hun groepen.
user_permissions (ManyToManyField) – Specifieke rechten voor deze gebruiker.
-
email_user
(subject, message, from_email=None, **kwargs)¶ Send an email to this user.
-
get_full_name
()¶ Return the first_name plus the last_name, with a space in between.
-
get_short_name
()¶ Return the short name for the user.
-
class
django.contrib.auth.models.
Group
(*args, **kwargs)¶ Groups are a generic way of categorizing users to apply permissions, or some other label, to those users. A user can belong to any number of groups.
A user in a group automatically has all the permissions granted to that group. For example, if the group ‘Site editors’ has the permission can_edit_home_page, any user in that group will have that permission.
Beyond permissions, groups are a convenient way to categorize users to apply some label, or extended functionality, to them. For example, you could create a group ‘Special users’, and you could write code that would do special things to those users – such as giving them access to a members-only portion of your site, or sending them members-only email messages.
- Parameters
id (AutoField) – Id
name (CharField) – Naam
permissions (ManyToManyField) – Rechten
-
class
django.contrib.auth.models.
GroupManager
(*args, **kwargs)¶ The manager for the auth’s Group model.
-
class
django.contrib.auth.models.
Permission
(*args, **kwargs)¶ The permissions system provides a way to assign permissions to specific users and groups of users.
The permission system is used by the Django admin site, but may also be useful in your own code. The Django admin site uses permissions as follows:
The “add” permission limits the user’s ability to view the “add” form and add an object.
The “change” permission limits a user’s ability to view the change list, view the “change” form and change an object.
The “delete” permission limits the ability to delete an object.
The “view” permission limits the ability to view an object.
Permissions are set globally per type of object, not per specific object instance. It is possible to say “Mary may change news stories,” but it’s not currently possible to say “Mary may change news stories, but only the ones she created herself” or “Mary may only change news stories that have a certain status or publication date.”
The permissions listed above are automatically created for each model.
- Parameters
id (AutoField) – Id
name (CharField) – Naam
content_type_id (ForeignKey to
ContentType
) – Inhoudstypecodename (CharField) – Codenaam
-
class
django.contrib.auth.models.
PermissionsMixin
(*args, **kwargs)¶ Add the fields and methods necessary to support the Group and Permission models using the ModelBackend.
- Parameters
is_superuser (BooleanField) – Bepaalt dat deze gebruiker alle rechten heeft, zonder deze expliciet toe te wijzen.
groups (ManyToManyField) – De groep waartoe deze gebruiker behoort. Gebruikers krijgen alle rechten behorende bij hun groepen.
user_permissions (ManyToManyField) – Specifieke rechten voor deze gebruiker.
-
get_group_permissions
(obj=None)¶ Return a list of permission strings that this user has through their groups. Query all available auth backends. If an object is passed in, return only permissions matching this object.
-
get_user_permissions
(obj=None)¶ Return a list of permission strings that this user has directly. Query all available auth backends. If an object is passed in, return only permissions matching this object.
-
has_module_perms
(app_label)¶ Return True if the user has any permissions in the given app label. Use similar logic as has_perm(), above.
-
has_perm
(perm, obj=None)¶ Return True if the user has the specified permission. Query all available auth backends, but return immediately if any backend returns True. Thus, a user who has permission from a single auth backend is assumed to have permission in general. If an object is provided, check permissions for that object.
-
has_perms
(perm_list, obj=None)¶ Return True if the user has each of the specified permissions. If object is passed, check if the user has all required perms for it.
-
class
django.contrib.auth.models.
User
(*args, **kwargs)¶ Users within the Django authentication system are represented by this model.
Username and password are required. Other fields are optional.
- Parameters
id (AutoField) – Id
password (CharField) – Wachtwoord
last_login (DateTimeField) – Laatste aanmelding
is_superuser (BooleanField) – Bepaalt dat deze gebruiker alle rechten heeft, zonder deze expliciet toe te wijzen.
username (CharField) – Vereist. 150 tekens of minder. Alleen letters, cijfers en de tekens @/,/+/-/_ zijn toegestaan.
first_name (CharField) – Voornaam
last_name (CharField) – Achternaam
email (EmailField) – Emailadres
is_staff (BooleanField) – Bepaalt of een gebruiker kan inloggen op deze admin site.
is_active (BooleanField) – Bepaalt of een gebruiker als actief behandeld moet worden. Deselecteer dit i.p.v. accounten te verwijderen.
date_joined (DateTimeField) – Toetredingsdatum
groups (ManyToManyField) – De groep waartoe deze gebruiker behoort. Gebruikers krijgen alle rechten behorende bij hun groepen.
user_permissions (ManyToManyField) – Specifieke rechten voor deze gebruiker.
-
django.contrib.auth.models.
update_last_login
(sender, user, **kwargs)¶ A signal receiver which updates the last_login date for the user logging in.
-
class
django.contrib.contenttypes.models.
ContentType
(id, app_label, model)¶ - Parameters
id (AutoField) – Id
app_label (CharField) – App label
model (CharField) – Klassenaam van pythonmodel
-
get_all_objects_for_this_type
(**kwargs)¶ Return all objects of this type for the keyword arguments given.
-
get_object_for_this_type
(**kwargs)¶ Return an object of this type for the keyword arguments given. Basically, this is a proxy around this object_type’s get_object() model method. The ObjectNotExist exception, if thrown, will not be caught, so code that calls this method should catch it.
-
model_class
()¶ Return the model class for this type of content.
-
class
django.contrib.sites.models.
Site
(id, domain, name)¶ - Parameters
id (AutoField) – Id
domain (CharField) – Domeinnaam
name (CharField) – Weergavenaam
-
django.contrib.sites.models.
clear_site_cache
(sender, **kwargs)¶ Clear the cache (if primed) each time a site is saved or deleted.
-
class
django_admin_index.models.
AppGroup
(id, order, name, slug)¶ - Parameters
id (AutoField) – Id
order (PositiveIntegerField) – Sorteer
name (CharField) – Naam
slug (SlugField) – Slug
models (ManyToManyField) – Models
-
class
django_admin_index.models.
AppGroupQuerySet
(model=None, query=None, using=None, hints=None)¶
-
class
django_admin_index.models.
AppLink
(id, order, app_group, name, link)¶ - Parameters
id (AutoField) – Id
order (PositiveIntegerField) – Sorteer
app_group_id (ForeignKey to
AppGroup
) – App groupname (CharField) – Name
link (CharField) – Link
-
class
django_admin_index.models.
AppLinkQuerySet
(model=None, query=None, using=None, hints=None)¶
-
class
django_admin_index.models.
ContentTypeProxy
(id, app_label, model)¶ - Parameters
id (AutoField) – Id
app_label (CharField) – App label
model (CharField) – Klassenaam van pythonmodel
-
class
django_auth_adfs_db.models.
ADFSConfig
(id, enabled, server, tenant_id, client_secret, client_id, relying_party_id, claim_mapping, username_claim, sync_groups)¶ - Parameters
id (BigAutoField) – Id
enabled (BooleanField) – Master switch if ADFS login/SSO is enabled or not.
server (CharField) – Example: adfs.example.com. Ignored if you use Azure
tenant_id (CharField) – Your Azure tenant ID, you can find this on the overview page.
client_secret (CharField) – This is a client secret created for the Azure AD application.
client_id (CharField) – This is the Azure ‘Client ID’ or the on-premise ‘Client Identifier’ value.
relying_party_id (CharField) – For Azure AD, this is the client ID, for on-premise this is the identifier of the web application.
claim_mapping (JSONField) – Mapping from user-model fields to ADFS claims
username_claim (CharField) – Claim to use for the username. If left blank, ‘winaccountname’ is used for on-premise or ‘upn’ is for Azure AD.
sync_groups (BooleanField) – Synchronize the local user groups with the ADFS groups. Note that this means a user is removed from all groups if there is no group claim. Uncheck to manage groups manually.
-
as_settings
() → dict¶ Return the configuration as a dict suitable to pass to django-auth-adfs
-
class
django_camunda.models.
CamundaConfig
(id, enabled, root_url, rest_api_path, auth_header)¶ - Parameters
id (BigAutoField) – Id
enabled (BooleanField) – Global flag to enable/disable Camunda integration.
root_url (URLField) – Root URL where camunda is installed. The REST api path is appended to this.
rest_api_path (CharField) – Rest api path
auth_header (TextField) – HTTP Authorization header value, required if the API is not open.
-
class
mozilla_django_oidc_db.models.
OpenIDConnectConfig
(*args, **kwargs)¶ Configuration for authentication/authorization via OpenID connect
- Parameters
id (BigAutoField) – Id
enabled (BooleanField) – Indicates whether OpenID Connect for authentication/authorization is enabled
oidc_rp_client_id (CharField) – OpenID Connect client ID provided by the OIDC Provider
oidc_rp_client_secret (CharField) – OpenID Connect secret provided by the OIDC Provider
oidc_rp_sign_algo (CharField) – Algorithm the Identity Provider uses to sign ID tokens
oidc_rp_scopes_list (ArrayField) – OpenID Connect scopes that are requested during login
oidc_op_discovery_endpoint (URLField) – URL of your OpenID Connect provider discovery endpoint ending with a slash (.well-known/… will be added automatically). If this is provided, the remaining endpoints can be omitted, as they will be derived from this endpoint.
oidc_op_jwks_endpoint (URLField) – URL of your OpenID Connect provider JSON Web Key Set endpoint. Required if RS256 is used as signing algorithm.
oidc_op_authorization_endpoint (URLField) – URL of your OpenID Connect provider authorization endpoint
oidc_op_token_endpoint (URLField) – URL of your OpenID Connect provider token endpoint
oidc_op_user_endpoint (URLField) – URL of your OpenID Connect provider userinfo endpoint
oidc_rp_idp_sign_key (CharField) – Key the Identity Provider uses to sign ID tokens in the case of an RSA sign algorithm. Should be the signing key in PEM or DER format.
oidc_use_nonce (BooleanField) – Controls whether the OpenID Connect client uses nonce verification
oidc_nonce_size (PositiveIntegerField) – Sets the length of the random string used for OpenID Connect nonce verification
oidc_state_size (PositiveIntegerField) – Sets the length of the random string used for OpenID Connect state verification
oidc_exempt_urls (ArrayField) – This is a list of absolute url paths, regular expressions for url paths, or Django view names. This plus the mozilla-django-oidc urls are exempted from the session renewal by the SessionRefresh middleware.
userinfo_claims_source (CharField) – Indicates the source from which the user information claims should be extracted.
username_claim (CharField) – The name of the OIDC claim that is used as the username
claim_mapping (JSONField) – Mapping from user-model fields to OIDC claims
groups_claim (CharField) – The name of the OIDC claim that holds the values to map to local user groups.
sync_groups (BooleanField) – Synchronize the local user groups with the provided groups. Note that this means a user is removed from all groups if there is no group claim. Uncheck to manage groups manually.
sync_groups_glob_pattern (CharField) – The glob pattern that groups must match to be synchronized to the local database.
make_users_staff (BooleanField) – Users will be flagged as being a staff user automatically. This allows users to login to the admin interface. By default they have no permissions, even if they are staff.
default_groups (ManyToManyField) – The default groups to which every user logging in with OIDC will be assigned
-
class
mozilla_django_oidc_db.models.
OpenIDConnectConfigBase
(*args, **kwargs)¶ Defines the required fields for a config to establish an OIDC connection
- Parameters
enabled (BooleanField) – Indicates whether OpenID Connect for authentication/authorization is enabled
oidc_rp_client_id (CharField) – OpenID Connect client ID provided by the OIDC Provider
oidc_rp_client_secret (CharField) – OpenID Connect secret provided by the OIDC Provider
oidc_rp_sign_algo (CharField) – Algorithm the Identity Provider uses to sign ID tokens
oidc_rp_scopes_list (ArrayField) – OpenID Connect scopes that are requested during login
oidc_op_discovery_endpoint (URLField) – URL of your OpenID Connect provider discovery endpoint ending with a slash (.well-known/… will be added automatically). If this is provided, the remaining endpoints can be omitted, as they will be derived from this endpoint.
oidc_op_jwks_endpoint (URLField) – URL of your OpenID Connect provider JSON Web Key Set endpoint. Required if RS256 is used as signing algorithm.
oidc_op_authorization_endpoint (URLField) – URL of your OpenID Connect provider authorization endpoint
oidc_op_token_endpoint (URLField) – URL of your OpenID Connect provider token endpoint
oidc_op_user_endpoint (URLField) – URL of your OpenID Connect provider userinfo endpoint
oidc_rp_idp_sign_key (CharField) – Key the Identity Provider uses to sign ID tokens in the case of an RSA sign algorithm. Should be the signing key in PEM or DER format.
oidc_use_nonce (BooleanField) – Controls whether the OpenID Connect client uses nonce verification
oidc_nonce_size (PositiveIntegerField) – Sets the length of the random string used for OpenID Connect nonce verification
oidc_state_size (PositiveIntegerField) – Sets the length of the random string used for OpenID Connect state verification
oidc_exempt_urls (ArrayField) – This is a list of absolute url paths, regular expressions for url paths, or Django view names. This plus the mozilla-django-oidc urls are exempted from the session renewal by the SessionRefresh middleware.
userinfo_claims_source (CharField) – Indicates the source from which the user information claims should be extracted.
-
property
oidc_rp_scopes
¶ Scopes should be formatted as a string with spaces
-
class
mozilla_django_oidc_db.models.
UserInformationClaimsSources
(value)¶ An enumeration.
-
mozilla_django_oidc_db.models.
get_default_scopes
() → List[str]¶ Returns the default scopes to request for OpenID Connect logins
-
class
rest_framework.authtoken.models.
Token
(*args, **kwargs)¶ The default authorization token model.
- Parameters
key (CharField) – Key
user_id (OneToOneField to
User
) – Gebruikercreated (DateTimeField) – Aangemaakt
-
class
rest_framework.authtoken.models.
TokenProxy
(*args, **kwargs)¶ Proxy mapping pk to user pk for use in admin.
- Parameters
key (CharField) – Key
user_id (OneToOneField to
User
) – Gebruikercreated (DateTimeField) – Aangemaakt
-
class
zgw_consumers.models.
NLXConfig
(id, directory, outway)¶ - Parameters
id (BigAutoField) – Id
directory (CharField) – Nlx directory
outway (URLField) – Example: http://my-outway.nlx:8080
-
class
zgw_consumers.models.
Service
(id, label, api_type, api_root, client_id, secret, auth_type, header_key, header_value, oas, oas_file, nlx, user_id, user_representation)¶ - Parameters
id (BigAutoField) – Id
label (CharField) – Label
api_type (CharField) – Type
api_root (CharField) – Api root url
client_id (CharField) – Client id
secret (CharField) – Secret
auth_type (CharField) – Authorization type
header_key (CharField) – Header key
header_value (CharField) – Header value
oas (URLField) – URL to OAS yaml file
oas_file (FileField) – OAS yaml file
nlx (URLField) – NLX (outway) address
user_id (CharField) – User ID to use for the audit trail. Although these external API credentials are typically used bythis API itself instead of a user, the user ID is required.
user_representation (CharField) – Human readable representation of the user.
-
build_client
(**claims)¶ Build an API client from the service configuration.
-
class
zgw_consumers.models.
NLXConfig
(id, directory, outway)¶ - Parameters
id (BigAutoField) – Id
directory (CharField) – Nlx directory
outway (URLField) – Example: http://my-outway.nlx:8080
-
class
zgw_consumers.models.
Service
(id, label, api_type, api_root, client_id, secret, auth_type, header_key, header_value, oas, oas_file, nlx, user_id, user_representation)¶ - Parameters
id (BigAutoField) – Id
label (CharField) – Label
api_type (CharField) – Type
api_root (CharField) – Api root url
client_id (CharField) – Client id
secret (CharField) – Secret
auth_type (CharField) – Authorization type
header_key (CharField) – Header key
header_value (CharField) – Header value
oas (URLField) – URL to OAS yaml file
oas_file (FileField) – OAS yaml file
nlx (URLField) – NLX (outway) address
user_id (CharField) – User ID to use for the audit trail. Although these external API credentials are typically used bythis API itself instead of a user, the user ID is required.
user_representation (CharField) – Human readable representation of the user.
-
build_client
(**claims)¶ Build an API client from the service configuration.