AccessProfile - Schema Documentation - V5.0.Revision
Documents generated: 6/7/2021

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v5/AccessProfile.xsd
Version 5.0.Revision
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.
Schema Composition
  • This schema imports schema(s) from the following namespace(s):
    • http://cufxstandards.com/v5/ISOCountryCodeType-V2006.xsd (at ISOCountryCodeType-V2006.xsd)
    • http://cufxstandards.com/v5/Relationship.xsd (at Relationship.xsd)
    • http://cufxstandards.com/v5/CredentialGroup.xsd (at CredentialGroup.xsd)
    • http://cufxstandards.com/v5/Common.xsd (at Common.xsd)

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v5/AccessProfile.xsd
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
isoCountryCodeType http://cufxstandards.com/v5/ISOCountryCodeType-V2006.xsd
relationship http://cufxstandards.com/v5/Relationship.xsd
credentialGroup http://cufxstandards.com/v5/CredentialGroup.xsd
common http://cufxstandards.com/v5/Common.xsd
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v5/AccessProfile.xsd" version="5.0.$Revision$" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:import namespace="http://cufxstandards.com/v5/ISOCountryCodeType-V2006.xsd" schemaLocation="ISOCountryCodeType-V2006.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Relationship.xsd" schemaLocation="Relationship.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/CredentialGroup.xsd" schemaLocation="CredentialGroup.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Common.xsd" schemaLocation="Common.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: accessProfileList

Name accessProfileList
Type AccessProfileList
Nillable no
Abstract no
Documentation The access profile collection/array contains all the access profiles, for instance, that the credential set is authorized to access at the Institution based on applied filters.
JSON Instance Representation
{accessProfileList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"accessProfile" : AccessProfile , [0..*] ?
accessProfileList}
Schema Component Representation
<xs:element name="accessProfileList" type="AccessProfileList"/>
top

Global Definitions

Complex Type: AccessProfile

Name AccessProfile
Abstract no
JSON Instance Representation
{
"accessProfileId" : AccessProfileId , [0..1] ?
"actor" : Actor , [0..1] ?
"language" : xs:string , [0..1] ?
"locale" : xs:string , [0..1] ?
"characterEncoding" : xs:string , [0..1] ?
"createAccessDateTime" : xs:dateTime , [0..1] ?
"savedAccessProfile" : xs:boolean , [0..1] ?
"softwareClient" : SoftwareClient , [0..1] ?
"device" : Device , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="AccessProfile">
<xs:sequence>
<xs:element name="accessProfileId" type="AccessProfileId" minOccurs="0" maxOccurs="1"/>
<xs:element name="actor" type="Actor" minOccurs="0" maxOccurs="1"/>
<xs:element name="language" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="locale" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="characterEncoding" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="createAccessDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="savedAccessProfile" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="softwareClient" type="SoftwareClient" minOccurs="0" maxOccurs="1"/>
<xs:element name="device" type="Device" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: AccessProfileIdList

Name AccessProfileIdList
Abstract no
Documentation The access profile collection/array contains all the access profiles, for instance, that the credential set is authorized to access at the Institution based on applied filters.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"accessProfileId" : AccessProfileId , [0..*] ?
}
Schema Component Representation
<xs:complexType name="AccessProfileIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="accessProfileId" type="AccessProfileId" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: AccessProfileList

Name AccessProfileList
Abstract no
Documentation The access profile collection/array contains all the access profiles, for instance, that the credential set is authorized to access at the Institution based on applied filters.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"accessProfile" : AccessProfile , [0..*] ?
}
Schema Component Representation
<xs:complexType name="AccessProfileList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="accessProfile" type="AccessProfile" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: Actor

Name Actor
Abstract no
Documentation Intended choice- Due to cross language serialization issues the choice construct has been removed. It is the responsibility of the implementer to add programmatic logic for this complex type to detect, handle and or error when population of more than one element is present.
JSON Instance Representation
{
"fiUserId" : credentialGroup:FiUserId , [0..1] ?
"userId" : common:UserId , [0..1] ?
"partyId" : common:PartyId , [0..1] ?
"relationshipId" : relationship:RelationshipId , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Actor">
<xs:sequence>
<xs:element name="fiUserId" type="credentialGroup:FiUserId" minOccurs="0" maxOccurs="1"/>
<xs:element name="userId" type="common:UserId" minOccurs="0" maxOccurs="1"/>
<xs:element name="partyId" type="common:PartyId" minOccurs="0" maxOccurs="1"/>
<xs:element name="relationshipId" type="relationship:RelationshipId" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: ActorList

Name ActorList
Abstract no
Documentation The access profile collection/array contains all the actors, for instance, that the credential set is authorized to access at the Institution based on applied filters.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"actor" : Actor , [0..*] ?
}
Schema Component Representation
<xs:complexType name="ActorList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="actor" type="Actor" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: Device

Name Device
Abstract no
Documentation The device information profile that is accessing the system information.
JSON Instance Representation
{
"deviceId" : DeviceId , [0..1] ?
"deviceType" : xs:string , [0..1] ?
"deviceName" : xs:string , [0..1] ?
"rawDeviceDetail" : xs:string , [0..1] ?
"ipAddress" : common:IpAddress , [0..1] ?
"manufacturer" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Device">
<xs:sequence>
<xs:element name="deviceId" type="DeviceId" minOccurs="0" maxOccurs="1"/>
<xs:element name="deviceType" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="deviceName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="rawDeviceDetail" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="ipAddress" type="common:IpAddress" minOccurs="0" maxOccurs="1"/>
<xs:element name="manufacturer" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: SoftwareClient

Name SoftwareClient
Abstract no
Documentation The software client information profile, i.e. user agent information or other software information.
JSON Instance Representation
{
"softwareClientId" : SoftwareClientId , [0..1] ?
"rawSoftwareClientDetail" : xs:string , [0..1] ?
"browserName" : xs:string , [0..1] ?
"browserVersion" : xs:string , [0..1] ?
"operatingSystemName" : xs:string , [0..1] ?
"operatingSystemVersion" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="SoftwareClient">
<xs:sequence>
<xs:element name="softwareClientId" type="SoftwareClientId" minOccurs="0" maxOccurs="1"/>
<xs:element name="rawSoftwareClientDetail" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="browserName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="browserVersion" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="operatingSystemName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="operatingSystemVersion" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Simple Type: AccessProfileId

Name AccessProfileId
Content
  • Base XSD Type: string
Schema Component Representation
<xs:simpleType name="AccessProfileId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: DeviceId

Name DeviceId
Content
  • Base XSD Type: string
Schema Component Representation
<xs:simpleType name="DeviceId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: SoftwareClientId

Name SoftwareClientId
Content
  • Base XSD Type: string
Schema Component Representation
<xs:simpleType name="SoftwareClientId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top