XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace None
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.

Declared Namespaces

Prefix Namespace
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xs:schema elementFormDefault="qualified">
...
</xs:schema>
top

Global Declarations

Element: algorithm

Name algorithm
Type Locally-defined complex type
Nillable no
Abstract no
XML Instance Representation
<algorithm>
<name> algorithmname </name> [1]
<parameter> ... </parameter> [1]
</algorithm>
Schema Component Representation
<xs:element name="algorithm">
<xs:complexType>
<xs:sequence>
<xs:element name="name" type="algorithmname" default="RSA"/>
<xs:element ref="parameter"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: algorithms

Name algorithms
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Specifies algorithms and key length.
XML Instance Representation
<algorithms>
<algorithm> ... </algorithm> [1]
</algorithms>
Schema Component Representation
<xs:element name="algorithms">
<xs:complexType>
<xs:sequence>
<xs:element ref="algorithm"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: allowed

Name allowed
Type Locally-defined complex type
Nillable no
Abstract no
Documentation List of authorities the NiAS server will accept.
XML Instance Representation
<allowed>
<authority> ... </authority> [1]
</allowed>
Schema Component Representation
<xs:element name="allowed">
<xs:complexType>
<xs:sequence>
<xs:element ref="authority"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: AllowLogout

Name AllowLogout
Type Locally-defined simple type
Nillable no
Abstract no
Default Value no
Documentation This setting should be considered as experimental. If set to yes and you continue to send collect calls, the Net iD Access Server will report card removal events as “user_cancel”. However, this happens only when the Net iD Access app is in focus. Value: yes, no
XML Instance Representation
<AllowLogout> xs:string (value comes from list: {'no'}) </AllowLogout>
Schema Component Representation
<xs:element name="AllowLogout" default="no">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
top

Element: AllowOnBehalf

Name AllowOnBehalf
Type Locally-defined simple type
Nillable no
Abstract no
Default Value yes
Documentation Specify if the possibility to control the name and logo of the calling service when Net iD Access Server is used to support services not directly integrated with this protocol, i.e. federation scenarios. To use this setting you have to create your own Base64-encoded challenge. See Developers Guide. Value: yes, no
XML Instance Representation
<AllowOnBehalf> xs:string (value comes from list: {'yes'}) </AllowOnBehalf>
Schema Component Representation
<xs:element name="AllowOnBehalf" default="yes">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="yes"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
top

Element: authenticate

Name authenticate
Type Locally-defined simple type
Nillable no
Abstract no
Default Value A0
Documentation Required certificate key usage flag for authentication.
XML Instance Representation
<authenticate> xs:NCName (value comes from list: {'A0'}) </authenticate>
Schema Component Representation
<xs:element name="authenticate" default="A0">
<xs:simpleType>
<xs:restriction base="xs:NCName">
<xs:enumeration value="A0"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
top

Element: authority

Name authority
Type Locally-defined complex type
Nillable no
Abstract no
Documentation An authority entry.
XML Instance Representation
<authority>
<name> authorityname </name> [1] ?
<keyid> ... </keyid> [1]
<verify> ... </verify> [1]
<keyusage> ... </keyusage> [1]
</authority>
Schema Component Representation
<xs:element name="authority">
<xs:complexType>
<xs:sequence>
<xs:element name="name" type="authorityname" default="SITHS Type 1 CA v1"/>
<xs:element ref="keyid"/>
<xs:element ref="verify"/>
<xs:element ref="keyusage"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: EmptyWithCache

Name EmptyWithCache
Type Locally-defined simple type
Nillable no
Abstract no
Default Value no
Documentation This element is deprecated.
XML Instance Representation
<EmptyWithCache> xs:string (value comes from list: {'no'}) </EmptyWithCache>
Schema Component Representation
<xs:element name="EmptyWithCache" default="no">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
top

Element: host

Name host
Type xs:NCName
Nillable no
Abstract no
Documentation Verifies that the sign request was issued by the same server that is trying to complete the request. Value: yes, no
XML Instance Representation
<host> xs:NCName </host>
Schema Component Representation
<xs:element name="host" type="xs:NCName"/>
top

Element: id

Name id
Type xs:NCName
Nillable no
Abstract no
Documentation The id-value is allocated by SecMaker and is used by the Net iD Access app to speed up the process of finding the correct Net iD Access Server. You may NOT use a value of your own. Please contact SecMaker to get your range of id-values.
XML Instance Representation
<id> xs:NCName </id>
Schema Component Representation
<xs:element name="id" type="xs:NCName"/>
top

Element: image

Name image
Type Locally-defined simple type
Nillable no
Abstract no
Default Value logo.png
Documentation Relative file path to [installation path]/niac-folder pointing to a PNG-file with the server logo.
XML Instance Representation
<image> xs:string (value comes from list: {'logo.png'}) </image>
Schema Component Representation
<xs:element name="image" default="logo.png">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="logo.png"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
top

Element: information

Name information
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Container for Net iD Access Server configuration settings.
XML Instance Representation
<information>
<trace> ... </trace> [1]
<path> ... </path> [1]
<name> ... </name> [1]
<id> ... </id> [1]
<version> ... </version> [1]
<image> ... </image> [1]
<site> ... </site> [1]
<AllowLogout> ... </AllowLogout> [1]
<AllowOnBehalf> ... </AllowOnBehalf> [1]
<EmptyWithCache> ... </EmptyWithCache> [1]
<RequestTimeout> ... </RequestTimeout> [1]
<test> ... </test> [1]
<algorithms> ... </algorithms> [1]
<allowed> ... </allowed> [1]
</information>
Schema Component Representation
<xs:element name="information">
<xs:complexType>
<xs:sequence>
<xs:element ref="trace"/>
<xs:element ref="path"/>
<xs:element ref="name"/>
<xs:element ref="id"/>
<xs:element ref="version"/>
<xs:element ref="image"/>
<xs:element ref="site"/>
<xs:element ref="AllowLogout"/>
<xs:element ref="AllowOnBehalf"/>
<xs:element ref="EmptyWithCache"/>
<xs:element ref="RequestTimeout"/>
<xs:element ref="test"/>
<xs:element ref="algorithms"/>
<xs:element ref="allowed"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: keyid

Name keyid
Type xs:string
Nillable no
Abstract no
Documentation Key id of the authority certificate.
XML Instance Representation
<keyid> xs:string </keyid>
Schema Component Representation
<xs:element name="keyid" type="xs:string"/>
top

Element: keyusage

Name keyusage
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Container for encryption key settings
XML Instance Representation
<keyusage>
<authenticate> ... </authenticate> [1]
<signature> ... </signature> [1]
</keyusage>
Schema Component Representation
<xs:element name="keyusage">
<xs:complexType>
<xs:sequence>
<xs:element ref="authenticate"/>
<xs:element ref="signature"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: local

Name local
Type xs:NCName
Nillable no
Abstract no
Documentation Indicates if the client certificate should be verified via CAPI with the local settings for certification verification. Value: yes, no
XML Instance Representation
<local> xs:NCName </local>
Schema Component Representation
<xs:element name="local" type="xs:NCName"/>
top

Element: name

Name name
Type Locally-defined simple type
Nillable no
Abstract no
Default Value Net iD Access Server
Documentation Name of the NiAS server.
XML Instance Representation
<name> xs:string (value comes from list: {'Net iD Access Server'}) </name>
Schema Component Representation
<xs:element name="name" default="Net iD Access Server">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Net iD Access Server"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
top

Element: niv

Name niv
Type xs:NCName
Nillable no
Abstract no
Documentation Use Net iD Validator.
XML Instance Representation
<niv> xs:NCName </niv>
Schema Component Representation
<xs:element name="niv" type="xs:NCName"/>
top

Element: ocsp

Name ocsp
Type xs:NCName
Nillable no
Abstract no
Documentation Indicates if the OCSP-response should be included in the COMPLETE-message. Value: yes, no
XML Instance Representation
<ocsp> xs:NCName </ocsp>
Schema Component Representation
<xs:element name="ocsp" type="xs:NCName"/>
top

Element: parameter

Name parameter
Type xs:integer
Nillable no
Abstract no
XML Instance Representation
<parameter> xs:integer </parameter>
Schema Component Representation
<xs:element name="parameter" type="xs:integer"/>
top

Element: path

Name path
Type Locally-defined simple type
Nillable no
Abstract no
Default Value C:\inetpub\wwwroot\NiAS\db\
Documentation Absolute path to the database folder where this file and the database subfolder are located.
XML Instance Representation
<path> xs:string (value comes from list: {'C:\inetpub\wwwroot\NiAS\db\'}) </path>
Schema Component Representation
<xs:element name="path" default="C:\inetpub\wwwroot\NiAS\db\">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="C:\inetpub\wwwroot\NiAS\db\"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
top

Element: RequestTimeout

Name RequestTimeout
Type Locally-defined simple type
Nillable no
Abstract no
Default Value 0
Documentation Defines the time a request can be active. In this version the timeout is only triggered by an update from the client side for the status to be changed. That is, the client must ask for a request or try to register a request for the status to be changed. Value: 0 = Valid forever, x = Time in seconds, Default 0.
XML Instance Representation
<RequestTimeout> xs:integer (value comes from list: {'0'}) </RequestTimeout>
Schema Component Representation
<xs:element name="RequestTimeout" default="0">
<xs:simpleType>
<xs:restriction base="xs:integer">
<xs:enumeration value="0"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
top

Element: signature

Name signature
Type Locally-defined simple type
Nillable no
Abstract no
Default Value 40
Documentation Required certificate key usage flag for signing.
XML Instance Representation
<signature> xs:integer (value comes from list: {'40'}) </signature>
Schema Component Representation
<xs:element name="signature" default="40">
<xs:simpleType>
<xs:restriction base="xs:integer">
<xs:enumeration value="40"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
top

Element: SigningTime

Name SigningTime
Type xs:NCName
Nillable no
Abstract no
Documentation Time allowed to perform signing Values: 0 = No control of time format or time, 1 = Signing is allowed in x second(s)
XML Instance Representation
<SigningTime> xs:NCName </SigningTime>
Schema Component Representation
<xs:element name="SigningTime" type="xs:NCName"/>
top

Element: site

Name site
Type xs:string
Nillable no
Abstract no
Documentation Path relative to [installation path]/niac-folder pointing to a webpage the client should display when viewing information about the server.
XML Instance Representation
<site> xs:string </site>
Schema Component Representation
<xs:element name="site" type="xs:string"/>
top

Element: test

Name test
Type xs:NCName
Nillable no
Abstract no
Documentation Include the menu item Test in the Net iD Access client, which points to a test site. Value: Link to test site.
XML Instance Representation
<test> xs:NCName </test>
Schema Component Representation
<xs:element name="test" type="xs:NCName"/>
top

Element: trace

Name trace
Type xs:string
Nillable no
Abstract no
Documentation Absolute path to the folder where the trace document will be saved. If no trace is wanted change the element to <notrace> but keep the path intact to avoid having to reenter the path if tracing needs to be turned on again.
XML Instance Representation
<trace> xs:string </trace>
Schema Component Representation
<xs:element name="trace" type="xs:string"/>
top

Element: verify

Name verify
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Container for certification verification settings.
XML Instance Representation
<verify>
<local> ... </local> [1]
<ocsp> ... </ocsp> [1]
<host> ... </host> [1]
<niv> ... </niv> [1]
<SigningTime> ... </SigningTime> [1]
</verify>
Schema Component Representation
<xs:element name="verify">
<xs:complexType>
<xs:sequence>
<xs:element ref="local"/>
<xs:element ref="ocsp"/>
<xs:element ref="host"/>
<xs:element ref="niv"/>
<xs:element ref="SigningTime"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: version

Name version
Type Locally-defined simple type
Nillable no
Abstract no
Default Value 1.4.0.14
Documentation Version of the NiAS server. This element is deprecated since v2.0
XML Instance Representation
<version> xs:string (value comes from list: {'1.4.0.14'}) </version>
Schema Component Representation
<xs:element name="version" default="1.4.0.14">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="1.4.0.14"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
top

Global Definitions

Simple Type: algorithmname

Super-types: xs:string < algorithmname (by restriction)
Sub-types: None
Name algorithmname
Content
  • Base XSD Type: string
  • value comes from list: {'RSA'}
Schema Component Representation
<xs:simpleType name="algorithmname">
<xs:restriction base="xs:string">
<xs:enumeration value="RSA"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: authorityname

Super-types: xs:string < authorityname (by restriction)
Sub-types: None
Name authorityname
Content
  • Base XSD Type: string
  • value comes from list: {'SITHS Type 1 CA v1'}
Schema Component Representation
<xs:simpleType name="authorityname">
<xs:restriction base="xs:string">
<xs:enumeration value="SITHS Type 1 CA v1"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: keyid

Super-types: xs:string < keyid (by restriction)
Sub-types: None
Name keyid
Content
  • Base XSD Type: string
  • value comes from list: {'959D7C354DEDFD0213A3F5H3D8A85F23C5B263FF4'}
Schema Component Representation
<xs:simpleType name="keyid">
<xs:restriction base="xs:string">
<xs:enumeration value="959D7C354DEDFD0213A3F5H3D8A85F23C5B263FF4"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: parameter

Super-types: xs:string < parameter (by restriction)
Sub-types: None
Name parameter
Content
  • Base XSD Type: string
  • value comes from list: {'2048'}
Schema Component Representation
<xs:simpleType name="parameter">
<xs:restriction base="xs:string">
<xs:enumeration value="2048"/>
</xs:restriction>
</xs:simpleType>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base="Address">
<sequence>
<element name="state" type="AusStates"/>
<element name="postcode">
<simpleType>
<restriction base="string">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type="string" fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
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