PermissionList - Schema Documentation - V4.5.Revision
Documents generated: 4/9/2021

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v4/PermissionList.xsd
Version 4.5.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/v4/Common.xsd (at Common.xsd)
    • http://cufxstandards.com/v4/AccessProfile.xsd (at AccessProfile.xsd)
    • http://cufxstandards.com/v4/Account.xsd (at Account.xsd)
    • http://cufxstandards.com/v4/Party.xsd (at Party.xsd)
    • http://cufxstandards.com/v4/Card.xsd (at Card.xsd)
    • http://cufxstandards.com/v4/Relationship.xsd (at Relationship.xsd)
    • http://cufxstandards.com/v4/CredentialGroup.xsd (at CredentialGroup.xsd)
    • http://cufxstandards.com/v4/ProductOffering.xsd (at ProductOffering.xsd)

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v4/PermissionList.xsd
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
common http://cufxstandards.com/v4/Common.xsd
accessProfile http://cufxstandards.com/v4/AccessProfile.xsd
account http://cufxstandards.com/v4/Account.xsd
party http://cufxstandards.com/v4/Party.xsd
card http://cufxstandards.com/v4/Card.xsd
relationship http://cufxstandards.com/v4/Relationship.xsd
credentialGroup http://cufxstandards.com/v4/CredentialGroup.xsd
productoffering http://cufxstandards.com/v4/ProductOffering.xsd
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v4/PermissionList.xsd" version="4.5.$Revision$" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:import namespace="http://cufxstandards.com/v4/Common.xsd" schemaLocation="Common.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/AccessProfile.xsd" schemaLocation="AccessProfile.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Account.xsd" schemaLocation="Account.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Party.xsd" schemaLocation="Party.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Card.xsd" schemaLocation="Card.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Relationship.xsd" schemaLocation="Relationship.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/CredentialGroup.xsd" schemaLocation="CredentialGroup.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/ProductOffering.xsd" schemaLocation="ProductOffering.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: permissionList

Name permissionList
Type PermissionList
Nillable no
Abstract no
Documentation This is a list of actions that the user is permitted to perform. Any permissions not explicitly in the list should be assumed as not permitted.
JSON Instance Representation
{permissionList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"permission" : Permission , [0..*] ?
permissionList}
Schema Component Representation
<xs:element name="permissionList" type="PermissionList"/>
top

Global Definitions

Complex Type: MaxLimits

Name MaxLimits
Abstract no
Documentation Limits encompassing daily, weekly, and monthly maximums for a given action and resource.
JSON Instance Representation
{
"dailyMax" : PermissionMaximums , [0..1]
"weeklyMax" : PermissionMaximums , [0..1]
"monthlyMax" : PermissionMaximums , [0..1]
}
Schema Component Representation
<xs:complexType name="MaxLimits">
<xs:sequence>
<xs:element name="dailyMax" type="PermissionMaximums" minOccurs="0" maxOccurs="1"/>
<xs:element name="weeklyMax" type="PermissionMaximums" minOccurs="0" maxOccurs="1"/>
<xs:element name="monthlyMax" type="PermissionMaximums" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: Permission

Name Permission
Abstract no
JSON Instance Representation
{
"actor" : accessProfile:Actor , [0..1] ?
"action" : ExtendedAction , [1] ?
"resource" : Resource , [0..1] ?
"maxLimits" : MaxLimits , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Permission">
<xs:sequence>
<xs:element name="actor" type="accessProfile:Actor" minOccurs="0" maxOccurs="1"/>
<xs:element name="action" type="ExtendedAction" minOccurs="1" maxOccurs="1"/>
<xs:element name="resource" type="Resource" minOccurs="0" maxOccurs="1"/>
<xs:element name="maxLimits" type="MaxLimits" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: PermissionList

Name PermissionList
Abstract no
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"permission" : Permission , [0..*] ?
}
Schema Component Representation
<xs:complexType name="PermissionList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="permission" type="Permission" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: PermissionMaximums

Name PermissionMaximums
Abstract no
Documentation Maximum limits for actions and resources.
JSON Instance Representation
{
"maxAmount" : common:Money , [0..1]
"maxNumber" : xs:integer , [0..1]
"rollingAmount" : common:Money , [0..1]
"rollingNumber" : xs:integer , [0..1]
}
Schema Component Representation
<xs:complexType name="PermissionMaximums">
<xs:sequence>
<xs:element name="maxAmount" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="maxNumber" type="xs:integer" minOccurs="0" maxOccurs="1"/>
<xs:element name="rollingAmount" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="rollingNumber" type="xs:integer" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: Resource

Name Resource
Abstract no
Documentation The account, user, or other securable asset that the action applies to. 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
{
"accountId" : account:AccountId , [0..1] ?
"fiUserId" : credentialGroup:FiUserId , [0..1] ?
"cardId" : card:CardId , [0..1] ?
"relationshipId" : relationship:RelationshipId , [0..1] ?
"productId" : productoffering:ProductId , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Resource">
<xs:sequence>
<xs:element name="accountId" type="account:AccountId" minOccurs="0" maxOccurs="1"/>
<xs:element name="fiUserId" type="credentialGroup:FiUserId" minOccurs="0" maxOccurs="1"/>
<xs:element name="cardId" type="card:CardId" minOccurs="0" maxOccurs="1"/>
<xs:element name="relationshipId" type="relationship:RelationshipId" minOccurs="0" maxOccurs="1"/>
<xs:element name="productId" type="productoffering:ProductId" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Simple Type: Action

Name Action
Content
  • Base XSD Type: string
  • value comes from list: {'AgreeToTerms'|'CategorizeTransactions'|'CreateUser'|'CreateAccount'|'ModifyResourceAccess'|'AddExternalAccount'|'ManageAccountDetail'|'ManageContactInfo'|'ManageCredential'|'ManagePreference'|'ManageScheduledTransfers'|'ManageUser'|'OrderChecks'|'PayBills'|'ProcessPayroll'|'RemoteDeposit'|'SendSecureMessage'|'SendWire'|'StopPayment'|'TransferDestinationAccount'|'TransferSourceAccount'|'ViewAccountBalance'|'ViewAccountDetail'|'ViewTransactions'|'ViewSecureMessages'|'ViewStatements'}
Schema Component Representation
<xs:simpleType name="Action">
<xs:restriction base="xs:string">
<xs:enumeration value="AgreeToTerms"/>
<xs:enumeration value="CategorizeTransactions"/>
<xs:enumeration value="CreateUser"/>
<xs:enumeration value="CreateAccount"/>
<xs:enumeration value="ModifyResourceAccess"/>
<xs:enumeration value="AddExternalAccount"/>
<xs:enumeration value="ManageAccountDetail"/>
<xs:enumeration value="ManageContactInfo"/>
<xs:enumeration value="ManageCredential"/>
<xs:enumeration value="ManagePreference"/>
<xs:enumeration value="ManageScheduledTransfers"/>
<xs:enumeration value="ManageUser"/>
<xs:enumeration value="OrderChecks"/>
<xs:enumeration value="PayBills"/>
<xs:enumeration value="ProcessPayroll"/>
<xs:enumeration value="RemoteDeposit"/>
<xs:enumeration value="SendSecureMessage"/>
<xs:enumeration value="SendWire"/>
<xs:enumeration value="StopPayment"/>
<xs:enumeration value="TransferDestinationAccount"/>
<xs:enumeration value="TransferSourceAccount"/>
<xs:enumeration value="ViewAccountBalance"/>
<xs:enumeration value="ViewAccountDetail"/>
<xs:enumeration value="ViewTransactions"/>
<xs:enumeration value="ViewSecureMessages"/>
<xs:enumeration value="ViewStatements"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: EnumerationExtension

Name EnumerationExtension
Content
  • Base XSD Type: string
  • pattern = custom:\w+
Documentation A string value that must contain a "custom:" prefix.
Schema Component Representation
<xs:simpleType name="EnumerationExtension">
<xs:restriction base="xs:string">
<xs:pattern value="custom:\w+"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: ExtendedAction

Name ExtendedAction
Content
Documentation The feature that the user is permitted to use, or prevented from using, and is extensible using the "custom:" prefix. CUFX-compatible client may ignore unrecognized extended actions.
Schema Component Representation
<xs:simpleType name="ExtendedAction">
<xs:union memberTypes="Action EnumerationExtension"/>
</xs:simpleType>
top