Child pages
  • User Authentication Schema Reference

This is the documentation of the release 2.2 of automaIT. The documentation of the latest stable release can be found at AUTOMAIT.

Skip to end of metadata
Go to start of metadata

Table of Contents

top

Global Declarations

Element: authentication-provider

Documentation: Defines a special authentication provider for integrating a Spring Security authentication provider with user information contained in the data store.
<authentication-provider
authentication-manager-ref="nonEmptyString [1] Reference to a Spring security authentication provider bean for performing the external authentication, typically an LDAP, AD or CAS provider.">
<!-- 'identifiedType' super type was not found in this schema. Some elements and attributes may be missing. -->
<user-creation
description="nonEmptyString [0..1] Specifies the description to be set to automatically created users. This should typically reflect the originating external authentication provider in some way."> [0..1] Enables automatic user creation for users successfully authenticated by the referenced Spring security authentication provider. If disabled, all external users must be present in the data store, i.e. manually created, in order to provide successful authentication.
<group> groupType </group> [0..*] Specifies a group to be assigned to automatically created users by default. None existent groups will be ignored, i.e. no groups are created automatically.
<role> roleType </role> [0..*] Specifies a role to be assigned to automatically created users by default. The role is assigned directly to the user independently of its groups and their roles.
</user-creation>
<authority-group-mapping
authority="string [1] Specifies the external authority name, e.g. ROLE_AIX_USERS, which shall be mapped dynamically to the referenced group's roles."
group="string [1] Specifies the group whose referenced roles shall be assigned to the user dynamically. None existent groups will be ignored, i.e. no additional roles will be assigned."/> [0..*] Enables dynamic mapping of an external authority to a group within the data store. This mapping is an add-on to the automatic user creation and will not be persisted in the data store. For example, an automatically created user assigned to ROLE_AUTHORIZED_WEB_USER may additionally be assigned to group 'guest', i.e. their roles, through this tag.
<authority-role-mapping
authority="string [1] Specifies the external authority name, e.g. ROLE_AIX_USERS, which shall be mapped dynamically to the target role."
role="validRoles [1] Specifies the internal application role to map to."/> [0..*] Enables dynamic mapping of an external authority to a role within the data store. This mapping is an add-on to the automatic user creation and will not be persisted in the data store. For example, an automatically created user assigned to ROLE_AUTHORIZED_WEB_USER may additionally be assigned to the role ROLE_AUTHORIZED_CLI_USER.
</authentication-provider>
top

Global Definitions

Complex Type: groupType

Super-types: None
Sub-types: None
Name groupType
Abstract no
<...
name="nonEmptyString [1] Identifies the target group within the data store by name."/>
top

Complex Type: roleType

Super-types: None
Sub-types: None
Name roleType
Abstract no
<...
name="validRoles [1] Identifies a valid application role by name."/>
top

Simple Type: nonEmptyString

Super-types: string < nonEmptyString (by restriction)
Sub-types: None
Name nonEmptyString
Content
  • Base XSD Type: string
  • length >= 1
top

Simple Type: validRoles

Super-types: string < validRoles (by restriction)
Sub-types: None
Name validRoles
Content
  • Base XSD Type: string
  • value comes from list: {'ROLE_ADMIN'|'ROLE_HOST_ADMIN'|'ROLE_SECURITY_ADMIN'|'ROLE_MAINTENANCE'|'ROLE_AUTHORIZED_WEB_USER'|'ROLE_AUTHORIZED_CLI_USER'}
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top