blueprints: fix schema generation for PrimaryKeyRelated fields with non-int PK (#9140)
* fix build error with bandit Signed-off-by: Jens Langhammer <jens@goauthentik.io> * blueprints: fix incorrect schema for primarykeyrelated fields with non-int PK Signed-off-by: Jens Langhammer <jens@goauthentik.io> * blueprints: fix export containing null ID Signed-off-by: Jens Langhammer <jens@goauthentik.io> * include authentik version in blueprint schema Signed-off-by: Jens Langhammer <jens@goauthentik.io> --------- Signed-off-by: Jens Langhammer <jens@goauthentik.io>
This commit is contained in:
Jens L
2
Makefile
2
Makefile
@ -65,7 +65,7 @@ lint-fix: ## Lint and automatically fix errors in the python source code. Repor
|
|||||||
codespell -w $(CODESPELL_ARGS)
|
codespell -w $(CODESPELL_ARGS)
|
||||||
|
|
||||||
lint: ## Lint the python and golang sources
|
lint: ## Lint the python and golang sources
|
||||||
bandit -r $(PY_SOURCES) -x node_modules
|
bandit -r $(PY_SOURCES) -x web/node_modules -x tests/wdio/node_modules -x website/node_modules
|
||||||
golangci-lint run -v
|
golangci-lint run -v
|
||||||
|
|
||||||
core-install:
|
core-install:
|
||||||
|
|||||||
@ -4,12 +4,14 @@ from json import dumps
|
|||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from django.core.management.base import BaseCommand, no_translations
|
from django.core.management.base import BaseCommand, no_translations
|
||||||
from django.db.models import Model
|
from django.db.models import Model, fields
|
||||||
from drf_jsonschema_serializer.convert import field_to_converter
|
from drf_jsonschema_serializer.convert import converter, field_to_converter
|
||||||
from rest_framework.fields import Field, JSONField, UUIDField
|
from rest_framework.fields import Field, JSONField, UUIDField
|
||||||
|
from rest_framework.relations import PrimaryKeyRelatedField
|
||||||
from rest_framework.serializers import Serializer
|
from rest_framework.serializers import Serializer
|
||||||
from structlog.stdlib import get_logger
|
from structlog.stdlib import get_logger
|
||||||
|
|
||||||
|
from authentik import __version__
|
||||||
from authentik.blueprints.v1.common import BlueprintEntryDesiredState
|
from authentik.blueprints.v1.common import BlueprintEntryDesiredState
|
||||||
from authentik.blueprints.v1.importer import SERIALIZER_CONTEXT_BLUEPRINT, is_model_allowed
|
from authentik.blueprints.v1.importer import SERIALIZER_CONTEXT_BLUEPRINT, is_model_allowed
|
||||||
from authentik.blueprints.v1.meta.registry import BaseMetaModel, registry
|
from authentik.blueprints.v1.meta.registry import BaseMetaModel, registry
|
||||||
@ -18,6 +20,23 @@ from authentik.lib.models import SerializerModel
|
|||||||
LOGGER = get_logger()
|
LOGGER = get_logger()
|
||||||
|
|
||||||
|
|
||||||
|
@converter
|
||||||
|
class PrimaryKeyRelatedFieldConverter:
|
||||||
|
"""Custom primary key field converter which is aware of non-integer based PKs
|
||||||
|
|
||||||
|
This is not an exhaustive fix for other non-int PKs, however in authentik we either
|
||||||
|
use UUIDs or ints"""
|
||||||
|
|
||||||
|
field_class = PrimaryKeyRelatedField
|
||||||
|
|
||||||
|
def convert(self, field: PrimaryKeyRelatedField):
|
||||||
|
model: Model = field.queryset.model
|
||||||
|
pk_field = model._meta.pk
|
||||||
|
if isinstance(pk_field, fields.UUIDField):
|
||||||
|
return {"type": "string", "format": "uuid"}
|
||||||
|
return {"type": "integer"}
|
||||||
|
|
||||||
|
|
||||||
class Command(BaseCommand):
|
class Command(BaseCommand):
|
||||||
"""Generate JSON Schema for blueprints"""
|
"""Generate JSON Schema for blueprints"""
|
||||||
|
|
||||||
@ -29,7 +48,7 @@ class Command(BaseCommand):
|
|||||||
"$schema": "http://json-schema.org/draft-07/schema",
|
"$schema": "http://json-schema.org/draft-07/schema",
|
||||||
"$id": "https://goauthentik.io/blueprints/schema.json",
|
"$id": "https://goauthentik.io/blueprints/schema.json",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"title": "authentik Blueprint schema",
|
"title": f"authentik {__version__} Blueprint schema",
|
||||||
"required": ["version", "entries"],
|
"required": ["version", "entries"],
|
||||||
"properties": {
|
"properties": {
|
||||||
"version": {
|
"version": {
|
||||||
|
|||||||
@ -556,7 +556,11 @@ class BlueprintDumper(SafeDumper):
|
|||||||
|
|
||||||
def factory(items):
|
def factory(items):
|
||||||
final_dict = dict(items)
|
final_dict = dict(items)
|
||||||
|
# Remove internal state variables
|
||||||
final_dict.pop("_state", None)
|
final_dict.pop("_state", None)
|
||||||
|
# Future-proof to only remove the ID if we don't set a value
|
||||||
|
if "id" in final_dict and final_dict.get("id") is None:
|
||||||
|
final_dict.pop("id")
|
||||||
return final_dict
|
return final_dict
|
||||||
|
|
||||||
data = asdict(data, dict_factory=factory)
|
data = asdict(data, dict_factory=factory)
|
||||||
|
|||||||
@ -2,7 +2,7 @@
|
|||||||
"$schema": "http://json-schema.org/draft-07/schema",
|
"$schema": "http://json-schema.org/draft-07/schema",
|
||||||
"$id": "https://goauthentik.io/blueprints/schema.json",
|
"$id": "https://goauthentik.io/blueprints/schema.json",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"title": "authentik Blueprint schema",
|
"title": "authentik 2024.2.2 Blueprint schema",
|
||||||
"required": [
|
"required": [
|
||||||
"version",
|
"version",
|
||||||
"entries"
|
"entries"
|
||||||
@ -2872,7 +2872,8 @@
|
|||||||
"title": "Is primary"
|
"title": "Is primary"
|
||||||
},
|
},
|
||||||
"tenant": {
|
"tenant": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Tenant"
|
"title": "Tenant"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@ -2994,11 +2995,13 @@
|
|||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"target": {
|
"target": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Target"
|
"title": "Target"
|
||||||
},
|
},
|
||||||
"stage": {
|
"stage": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Stage"
|
"title": "Stage"
|
||||||
},
|
},
|
||||||
"evaluate_on_plan": {
|
"evaluate_on_plan": {
|
||||||
@ -3058,12 +3061,14 @@
|
|||||||
"description": "Can be in the format of 'unix://<path>' when connecting to a local docker daemon, or 'https://<hostname>:2376' when connecting to a remote system."
|
"description": "Can be in the format of 'unix://<path>' when connecting to a local docker daemon, or 'https://<hostname>:2376' when connecting to a remote system."
|
||||||
},
|
},
|
||||||
"tls_verification": {
|
"tls_verification": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Tls verification",
|
"title": "Tls verification",
|
||||||
"description": "CA which the endpoint's Certificate is verified against. Can be left empty for no validation."
|
"description": "CA which the endpoint's Certificate is verified against. Can be left empty for no validation."
|
||||||
},
|
},
|
||||||
"tls_authentication": {
|
"tls_authentication": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Tls authentication",
|
"title": "Tls authentication",
|
||||||
"description": "Certificate/Key used for authentication. Can be left empty for no authentication."
|
"description": "Certificate/Key used for authentication. Can be left empty for no authentication."
|
||||||
}
|
}
|
||||||
@ -3123,7 +3128,8 @@
|
|||||||
"title": "Providers"
|
"title": "Providers"
|
||||||
},
|
},
|
||||||
"service_connection": {
|
"service_connection": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Service connection",
|
"title": "Service connection",
|
||||||
"description": "Select Service-Connection authentik should use to manage this outpost. Leave empty if authentik should not handle the deployment."
|
"description": "Select Service-Connection authentik should use to manage this outpost. Leave empty if authentik should not handle the deployment."
|
||||||
},
|
},
|
||||||
@ -3557,11 +3563,13 @@
|
|||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"policy": {
|
"policy": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Policy"
|
"title": "Policy"
|
||||||
},
|
},
|
||||||
"group": {
|
"group": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Group"
|
"title": "Group"
|
||||||
},
|
},
|
||||||
"user": {
|
"user": {
|
||||||
@ -3569,7 +3577,8 @@
|
|||||||
"title": "User"
|
"title": "User"
|
||||||
},
|
},
|
||||||
"target": {
|
"target": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Target"
|
"title": "Target"
|
||||||
},
|
},
|
||||||
"negate": {
|
"negate": {
|
||||||
@ -3611,19 +3620,22 @@
|
|||||||
"title": "Name"
|
"title": "Name"
|
||||||
},
|
},
|
||||||
"authentication_flow": {
|
"authentication_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Authentication flow",
|
"title": "Authentication flow",
|
||||||
"description": "Flow used for authentication when the associated application is accessed by an un-authenticated user."
|
"description": "Flow used for authentication when the associated application is accessed by an un-authenticated user."
|
||||||
},
|
},
|
||||||
"authorization_flow": {
|
"authorization_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Authorization flow",
|
"title": "Authorization flow",
|
||||||
"description": "Flow used when authorizing this provider."
|
"description": "Flow used when authorizing this provider."
|
||||||
},
|
},
|
||||||
"property_mappings": {
|
"property_mappings": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "integer"
|
"type": "string",
|
||||||
|
"format": "uuid"
|
||||||
},
|
},
|
||||||
"title": "Property mappings"
|
"title": "Property mappings"
|
||||||
},
|
},
|
||||||
@ -3634,12 +3646,14 @@
|
|||||||
"description": "DN under which objects are accessible."
|
"description": "DN under which objects are accessible."
|
||||||
},
|
},
|
||||||
"search_group": {
|
"search_group": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Search group",
|
"title": "Search group",
|
||||||
"description": "Users in this group can do search queries. If not set, every user can execute search queries."
|
"description": "Users in this group can do search queries. If not set, every user can execute search queries."
|
||||||
},
|
},
|
||||||
"certificate": {
|
"certificate": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Certificate"
|
"title": "Certificate"
|
||||||
},
|
},
|
||||||
"tls_server_name": {
|
"tls_server_name": {
|
||||||
@ -3729,19 +3743,22 @@
|
|||||||
"title": "Name"
|
"title": "Name"
|
||||||
},
|
},
|
||||||
"authentication_flow": {
|
"authentication_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Authentication flow",
|
"title": "Authentication flow",
|
||||||
"description": "Flow used for authentication when the associated application is accessed by an un-authenticated user."
|
"description": "Flow used for authentication when the associated application is accessed by an un-authenticated user."
|
||||||
},
|
},
|
||||||
"authorization_flow": {
|
"authorization_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Authorization flow",
|
"title": "Authorization flow",
|
||||||
"description": "Flow used when authorizing this provider."
|
"description": "Flow used when authorizing this provider."
|
||||||
},
|
},
|
||||||
"property_mappings": {
|
"property_mappings": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "integer"
|
"type": "string",
|
||||||
|
"format": "uuid"
|
||||||
},
|
},
|
||||||
"title": "Property mappings"
|
"title": "Property mappings"
|
||||||
},
|
},
|
||||||
@ -3789,7 +3806,8 @@
|
|||||||
"description": "Include User claims from scopes in the id_token, for applications that don't access the userinfo endpoint."
|
"description": "Include User claims from scopes in the id_token, for applications that don't access the userinfo endpoint."
|
||||||
},
|
},
|
||||||
"signing_key": {
|
"signing_key": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Signing Key",
|
"title": "Signing Key",
|
||||||
"description": "Key used to sign the tokens. Only required when JWT Algorithm is set to RS256."
|
"description": "Key used to sign the tokens. Only required when JWT Algorithm is set to RS256."
|
||||||
},
|
},
|
||||||
@ -3840,19 +3858,22 @@
|
|||||||
"title": "Name"
|
"title": "Name"
|
||||||
},
|
},
|
||||||
"authentication_flow": {
|
"authentication_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Authentication flow",
|
"title": "Authentication flow",
|
||||||
"description": "Flow used for authentication when the associated application is accessed by an un-authenticated user."
|
"description": "Flow used for authentication when the associated application is accessed by an un-authenticated user."
|
||||||
},
|
},
|
||||||
"authorization_flow": {
|
"authorization_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Authorization flow",
|
"title": "Authorization flow",
|
||||||
"description": "Flow used when authorizing this provider."
|
"description": "Flow used when authorizing this provider."
|
||||||
},
|
},
|
||||||
"property_mappings": {
|
"property_mappings": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "integer"
|
"type": "string",
|
||||||
|
"format": "uuid"
|
||||||
},
|
},
|
||||||
"title": "Property mappings"
|
"title": "Property mappings"
|
||||||
},
|
},
|
||||||
@ -3871,7 +3892,8 @@
|
|||||||
"description": "Validate SSL Certificates of upstream servers"
|
"description": "Validate SSL Certificates of upstream servers"
|
||||||
},
|
},
|
||||||
"certificate": {
|
"certificate": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Certificate"
|
"title": "Certificate"
|
||||||
},
|
},
|
||||||
"skip_path_regex": {
|
"skip_path_regex": {
|
||||||
@ -3945,19 +3967,22 @@
|
|||||||
"title": "Name"
|
"title": "Name"
|
||||||
},
|
},
|
||||||
"authentication_flow": {
|
"authentication_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Authentication flow",
|
"title": "Authentication flow",
|
||||||
"description": "Flow used for authentication when the associated application is accessed by an un-authenticated user."
|
"description": "Flow used for authentication when the associated application is accessed by an un-authenticated user."
|
||||||
},
|
},
|
||||||
"authorization_flow": {
|
"authorization_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Authorization flow",
|
"title": "Authorization flow",
|
||||||
"description": "Flow used when authorizing this provider."
|
"description": "Flow used when authorizing this provider."
|
||||||
},
|
},
|
||||||
"property_mappings": {
|
"property_mappings": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "integer"
|
"type": "string",
|
||||||
|
"format": "uuid"
|
||||||
},
|
},
|
||||||
"title": "Property mappings"
|
"title": "Property mappings"
|
||||||
},
|
},
|
||||||
@ -3990,19 +4015,22 @@
|
|||||||
"title": "Name"
|
"title": "Name"
|
||||||
},
|
},
|
||||||
"authentication_flow": {
|
"authentication_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Authentication flow",
|
"title": "Authentication flow",
|
||||||
"description": "Flow used for authentication when the associated application is accessed by an un-authenticated user."
|
"description": "Flow used for authentication when the associated application is accessed by an un-authenticated user."
|
||||||
},
|
},
|
||||||
"authorization_flow": {
|
"authorization_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Authorization flow",
|
"title": "Authorization flow",
|
||||||
"description": "Flow used when authorizing this provider."
|
"description": "Flow used when authorizing this provider."
|
||||||
},
|
},
|
||||||
"property_mappings": {
|
"property_mappings": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "integer"
|
"type": "string",
|
||||||
|
"format": "uuid"
|
||||||
},
|
},
|
||||||
"title": "Property mappings"
|
"title": "Property mappings"
|
||||||
},
|
},
|
||||||
@ -4069,12 +4097,14 @@
|
|||||||
"title": "Signature algorithm"
|
"title": "Signature algorithm"
|
||||||
},
|
},
|
||||||
"signing_kp": {
|
"signing_kp": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Signing Keypair",
|
"title": "Signing Keypair",
|
||||||
"description": "Keypair used to sign outgoing Responses going to the Service Provider."
|
"description": "Keypair used to sign outgoing Responses going to the Service Provider."
|
||||||
},
|
},
|
||||||
"verification_kp": {
|
"verification_kp": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Verification Certificate",
|
"title": "Verification Certificate",
|
||||||
"description": "When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default."
|
"description": "When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default."
|
||||||
},
|
},
|
||||||
@ -4143,14 +4173,16 @@
|
|||||||
"property_mappings": {
|
"property_mappings": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "integer"
|
"type": "string",
|
||||||
|
"format": "uuid"
|
||||||
},
|
},
|
||||||
"title": "Property mappings"
|
"title": "Property mappings"
|
||||||
},
|
},
|
||||||
"property_mappings_group": {
|
"property_mappings_group": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"description": "Property mappings used for group creation/updating."
|
"description": "Property mappings used for group creation/updating."
|
||||||
},
|
},
|
||||||
"title": "Property mappings group",
|
"title": "Property mappings group",
|
||||||
@ -4173,7 +4205,8 @@
|
|||||||
"title": "Exclude users service account"
|
"title": "Exclude users service account"
|
||||||
},
|
},
|
||||||
"filter_group": {
|
"filter_group": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Filter group"
|
"title": "Filter group"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@ -4238,12 +4271,14 @@
|
|||||||
"title": "Enabled"
|
"title": "Enabled"
|
||||||
},
|
},
|
||||||
"authentication_flow": {
|
"authentication_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Authentication flow",
|
"title": "Authentication flow",
|
||||||
"description": "Flow to use when authenticating existing users."
|
"description": "Flow to use when authenticating existing users."
|
||||||
},
|
},
|
||||||
"enrollment_flow": {
|
"enrollment_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Enrollment flow",
|
"title": "Enrollment flow",
|
||||||
"description": "Flow to use when enrolling new users."
|
"description": "Flow to use when enrolling new users."
|
||||||
},
|
},
|
||||||
@ -4283,12 +4318,14 @@
|
|||||||
"title": "Server URI"
|
"title": "Server URI"
|
||||||
},
|
},
|
||||||
"peer_certificate": {
|
"peer_certificate": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Peer certificate",
|
"title": "Peer certificate",
|
||||||
"description": "Optionally verify the LDAP Server's Certificate against the CA Chain in this keypair."
|
"description": "Optionally verify the LDAP Server's Certificate against the CA Chain in this keypair."
|
||||||
},
|
},
|
||||||
"client_certificate": {
|
"client_certificate": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Client certificate",
|
"title": "Client certificate",
|
||||||
"description": "Client certificate to authenticate against the LDAP Server's Certificate."
|
"description": "Client certificate to authenticate against the LDAP Server's Certificate."
|
||||||
},
|
},
|
||||||
@ -4366,20 +4403,23 @@
|
|||||||
"title": "Sync groups"
|
"title": "Sync groups"
|
||||||
},
|
},
|
||||||
"sync_parent_group": {
|
"sync_parent_group": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Sync parent group"
|
"title": "Sync parent group"
|
||||||
},
|
},
|
||||||
"property_mappings": {
|
"property_mappings": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "integer"
|
"type": "string",
|
||||||
|
"format": "uuid"
|
||||||
},
|
},
|
||||||
"title": "Property mappings"
|
"title": "Property mappings"
|
||||||
},
|
},
|
||||||
"property_mappings_group": {
|
"property_mappings_group": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"description": "Property mappings used for group creation/updating."
|
"description": "Property mappings used for group creation/updating."
|
||||||
},
|
},
|
||||||
"title": "Property mappings group",
|
"title": "Property mappings group",
|
||||||
@ -4440,12 +4480,14 @@
|
|||||||
"title": "Enabled"
|
"title": "Enabled"
|
||||||
},
|
},
|
||||||
"authentication_flow": {
|
"authentication_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Authentication flow",
|
"title": "Authentication flow",
|
||||||
"description": "Flow to use when authenticating existing users."
|
"description": "Flow to use when authenticating existing users."
|
||||||
},
|
},
|
||||||
"enrollment_flow": {
|
"enrollment_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Enrollment flow",
|
"title": "Enrollment flow",
|
||||||
"description": "Flow to use when enrolling new users."
|
"description": "Flow to use when enrolling new users."
|
||||||
},
|
},
|
||||||
@ -4619,12 +4661,14 @@
|
|||||||
"title": "Enabled"
|
"title": "Enabled"
|
||||||
},
|
},
|
||||||
"authentication_flow": {
|
"authentication_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Authentication flow",
|
"title": "Authentication flow",
|
||||||
"description": "Flow to use when authenticating existing users."
|
"description": "Flow to use when authenticating existing users."
|
||||||
},
|
},
|
||||||
"enrollment_flow": {
|
"enrollment_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Enrollment flow",
|
"title": "Enrollment flow",
|
||||||
"description": "Flow to use when enrolling new users."
|
"description": "Flow to use when enrolling new users."
|
||||||
},
|
},
|
||||||
@ -4731,12 +4775,14 @@
|
|||||||
"title": "Enabled"
|
"title": "Enabled"
|
||||||
},
|
},
|
||||||
"authentication_flow": {
|
"authentication_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Authentication flow",
|
"title": "Authentication flow",
|
||||||
"description": "Flow to use when authenticating existing users."
|
"description": "Flow to use when authenticating existing users."
|
||||||
},
|
},
|
||||||
"enrollment_flow": {
|
"enrollment_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Enrollment flow",
|
"title": "Enrollment flow",
|
||||||
"description": "Flow to use when enrolling new users."
|
"description": "Flow to use when enrolling new users."
|
||||||
},
|
},
|
||||||
@ -4771,7 +4817,8 @@
|
|||||||
"title": "Icon"
|
"title": "Icon"
|
||||||
},
|
},
|
||||||
"pre_authentication_flow": {
|
"pre_authentication_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Pre authentication flow",
|
"title": "Pre authentication flow",
|
||||||
"description": "Flow used before authentication."
|
"description": "Flow used before authentication."
|
||||||
},
|
},
|
||||||
@ -4825,12 +4872,14 @@
|
|||||||
"title": "Binding type"
|
"title": "Binding type"
|
||||||
},
|
},
|
||||||
"verification_kp": {
|
"verification_kp": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Verification Certificate",
|
"title": "Verification Certificate",
|
||||||
"description": "When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default."
|
"description": "When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default."
|
||||||
},
|
},
|
||||||
"signing_kp": {
|
"signing_kp": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Signing Keypair",
|
"title": "Signing Keypair",
|
||||||
"description": "Keypair used to sign outgoing Responses going to the Identity Provider."
|
"description": "Keypair used to sign outgoing Responses going to the Identity Provider."
|
||||||
},
|
},
|
||||||
@ -4975,7 +5024,8 @@
|
|||||||
"title": "Flow set"
|
"title": "Flow set"
|
||||||
},
|
},
|
||||||
"configure_flow": {
|
"configure_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Configure flow",
|
"title": "Configure flow",
|
||||||
"description": "Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage."
|
"description": "Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage."
|
||||||
},
|
},
|
||||||
@ -5117,7 +5167,8 @@
|
|||||||
"title": "Flow set"
|
"title": "Flow set"
|
||||||
},
|
},
|
||||||
"configure_flow": {
|
"configure_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Configure flow",
|
"title": "Configure flow",
|
||||||
"description": "Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage."
|
"description": "Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage."
|
||||||
},
|
},
|
||||||
@ -5281,7 +5332,8 @@
|
|||||||
"title": "Flow set"
|
"title": "Flow set"
|
||||||
},
|
},
|
||||||
"configure_flow": {
|
"configure_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Configure flow",
|
"title": "Configure flow",
|
||||||
"description": "Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage."
|
"description": "Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage."
|
||||||
},
|
},
|
||||||
@ -5412,7 +5464,8 @@
|
|||||||
"title": "Flow set"
|
"title": "Flow set"
|
||||||
},
|
},
|
||||||
"configure_flow": {
|
"configure_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Configure flow",
|
"title": "Configure flow",
|
||||||
"description": "Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage."
|
"description": "Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage."
|
||||||
},
|
},
|
||||||
@ -5566,7 +5619,8 @@
|
|||||||
"configuration_stages": {
|
"configuration_stages": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"description": "Stages used to configure Authenticator when user doesn't have any compatible devices. After this configuration Stage passes, the user is not prompted again."
|
"description": "Stages used to configure Authenticator when user doesn't have any compatible devices. After this configuration Stage passes, the user is not prompted again."
|
||||||
},
|
},
|
||||||
"title": "Configuration stages",
|
"title": "Configuration stages",
|
||||||
@ -5682,7 +5736,8 @@
|
|||||||
"title": "Flow set"
|
"title": "Flow set"
|
||||||
},
|
},
|
||||||
"configure_flow": {
|
"configure_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Configure flow",
|
"title": "Configure flow",
|
||||||
"description": "Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage."
|
"description": "Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage."
|
||||||
},
|
},
|
||||||
@ -6004,7 +6059,8 @@
|
|||||||
"groups": {
|
"groups": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "integer"
|
"type": "string",
|
||||||
|
"format": "uuid"
|
||||||
},
|
},
|
||||||
"title": "Groups"
|
"title": "Groups"
|
||||||
},
|
},
|
||||||
@ -6587,17 +6643,20 @@
|
|||||||
"description": "When a valid username/email has been entered, and this option is enabled, the user's username and avatar will be shown. Otherwise, the text that the user entered will be shown"
|
"description": "When a valid username/email has been entered, and this option is enabled, the user's username and avatar will be shown. Otherwise, the text that the user entered will be shown"
|
||||||
},
|
},
|
||||||
"enrollment_flow": {
|
"enrollment_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Enrollment flow",
|
"title": "Enrollment flow",
|
||||||
"description": "Optional enrollment flow, which is linked at the bottom of the page."
|
"description": "Optional enrollment flow, which is linked at the bottom of the page."
|
||||||
},
|
},
|
||||||
"recovery_flow": {
|
"recovery_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Recovery flow",
|
"title": "Recovery flow",
|
||||||
"description": "Optional recovery flow, which is linked at the bottom of the page."
|
"description": "Optional recovery flow, which is linked at the bottom of the page."
|
||||||
},
|
},
|
||||||
"passwordless_flow": {
|
"passwordless_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Passwordless flow",
|
"title": "Passwordless flow",
|
||||||
"description": "Optional passwordless flow, which is linked at the bottom of the page."
|
"description": "Optional passwordless flow, which is linked at the bottom of the page."
|
||||||
},
|
},
|
||||||
@ -6746,7 +6805,8 @@
|
|||||||
"description": "When enabled, the invitation will be deleted after usage."
|
"description": "When enabled, the invitation will be deleted after usage."
|
||||||
},
|
},
|
||||||
"flow": {
|
"flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Flow",
|
"title": "Flow",
|
||||||
"description": "When set, only the configured flow can use this invitation."
|
"description": "When set, only the configured flow can use this invitation."
|
||||||
}
|
}
|
||||||
@ -6858,7 +6918,8 @@
|
|||||||
"description": "Selection of backends to test the password against."
|
"description": "Selection of backends to test the password against."
|
||||||
},
|
},
|
||||||
"configure_flow": {
|
"configure_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Configure flow",
|
"title": "Configure flow",
|
||||||
"description": "Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage."
|
"description": "Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage."
|
||||||
},
|
},
|
||||||
@ -7142,14 +7203,16 @@
|
|||||||
"fields": {
|
"fields": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "integer"
|
"type": "string",
|
||||||
|
"format": "uuid"
|
||||||
},
|
},
|
||||||
"title": "Fields"
|
"title": "Fields"
|
||||||
},
|
},
|
||||||
"validation_policies": {
|
"validation_policies": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "integer"
|
"type": "string",
|
||||||
|
"format": "uuid"
|
||||||
},
|
},
|
||||||
"title": "Validation policies"
|
"title": "Validation policies"
|
||||||
}
|
}
|
||||||
@ -7579,7 +7642,8 @@
|
|||||||
"description": "When set, newly created users are inactive and cannot login."
|
"description": "When set, newly created users are inactive and cannot login."
|
||||||
},
|
},
|
||||||
"create_users_group": {
|
"create_users_group": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Create users group",
|
"title": "Create users group",
|
||||||
"description": "Optionally add newly created users to this group."
|
"description": "Optionally add newly created users to this group."
|
||||||
},
|
},
|
||||||
@ -7629,31 +7693,38 @@
|
|||||||
"title": "Branding favicon"
|
"title": "Branding favicon"
|
||||||
},
|
},
|
||||||
"flow_authentication": {
|
"flow_authentication": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Flow authentication"
|
"title": "Flow authentication"
|
||||||
},
|
},
|
||||||
"flow_invalidation": {
|
"flow_invalidation": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Flow invalidation"
|
"title": "Flow invalidation"
|
||||||
},
|
},
|
||||||
"flow_recovery": {
|
"flow_recovery": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Flow recovery"
|
"title": "Flow recovery"
|
||||||
},
|
},
|
||||||
"flow_unenrollment": {
|
"flow_unenrollment": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Flow unenrollment"
|
"title": "Flow unenrollment"
|
||||||
},
|
},
|
||||||
"flow_user_settings": {
|
"flow_user_settings": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Flow user settings"
|
"title": "Flow user settings"
|
||||||
},
|
},
|
||||||
"flow_device_code": {
|
"flow_device_code": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Flow device code"
|
"title": "Flow device code"
|
||||||
},
|
},
|
||||||
"web_certificate": {
|
"web_certificate": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Web certificate",
|
"title": "Web certificate",
|
||||||
"description": "Web Certificate used by the authentik Core webserver."
|
"description": "Web Certificate used by the authentik Core webserver."
|
||||||
},
|
},
|
||||||
@ -7708,7 +7779,8 @@
|
|||||||
"description": "Users added to this group will be superusers."
|
"description": "Users added to this group will be superusers."
|
||||||
},
|
},
|
||||||
"parent": {
|
"parent": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Parent"
|
"title": "Parent"
|
||||||
},
|
},
|
||||||
"users": {
|
"users": {
|
||||||
@ -7726,7 +7798,8 @@
|
|||||||
"roles": {
|
"roles": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "integer"
|
"type": "string",
|
||||||
|
"format": "uuid"
|
||||||
},
|
},
|
||||||
"title": "Roles"
|
"title": "Roles"
|
||||||
}
|
}
|
||||||
@ -7763,7 +7836,8 @@
|
|||||||
"groups": {
|
"groups": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "integer"
|
"type": "string",
|
||||||
|
"format": "uuid"
|
||||||
},
|
},
|
||||||
"title": "Groups"
|
"title": "Groups"
|
||||||
},
|
},
|
||||||
@ -7943,19 +8017,22 @@
|
|||||||
"title": "Name"
|
"title": "Name"
|
||||||
},
|
},
|
||||||
"authentication_flow": {
|
"authentication_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Authentication flow",
|
"title": "Authentication flow",
|
||||||
"description": "Flow used for authentication when the associated application is accessed by an un-authenticated user."
|
"description": "Flow used for authentication when the associated application is accessed by an un-authenticated user."
|
||||||
},
|
},
|
||||||
"authorization_flow": {
|
"authorization_flow": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Authorization flow",
|
"title": "Authorization flow",
|
||||||
"description": "Flow used when authorizing this provider."
|
"description": "Flow used when authorizing this provider."
|
||||||
},
|
},
|
||||||
"property_mappings": {
|
"property_mappings": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "integer"
|
"type": "string",
|
||||||
|
"format": "uuid"
|
||||||
},
|
},
|
||||||
"title": "Property mappings"
|
"title": "Property mappings"
|
||||||
},
|
},
|
||||||
@ -8012,7 +8089,8 @@
|
|||||||
"property_mappings": {
|
"property_mappings": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "integer"
|
"type": "string",
|
||||||
|
"format": "uuid"
|
||||||
},
|
},
|
||||||
"title": "Property mappings"
|
"title": "Property mappings"
|
||||||
},
|
},
|
||||||
@ -8368,7 +8446,8 @@
|
|||||||
"transports": {
|
"transports": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"description": "Select which transports should be used to notify the user. If none are selected, the notification will only be shown in the authentik UI."
|
"description": "Select which transports should be used to notify the user. If none are selected, the notification will only be shown in the authentik UI."
|
||||||
},
|
},
|
||||||
"title": "Transports",
|
"title": "Transports",
|
||||||
@ -8385,7 +8464,8 @@
|
|||||||
"description": "Controls which severity level the created notifications will have."
|
"description": "Controls which severity level the created notifications will have."
|
||||||
},
|
},
|
||||||
"group": {
|
"group": {
|
||||||
"type": "integer",
|
"type": "string",
|
||||||
|
"format": "uuid",
|
||||||
"title": "Group",
|
"title": "Group",
|
||||||
"description": "Define which group of users this notification should be sent and shown to. If left empty, Notification won't ben sent."
|
"description": "Define which group of users this notification should be sent and shown to. If left empty, Notification won't ben sent."
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user