complexType XmlLdapContainer

diagram
namespace	http://ldap.api.de.n2.tibco.com
children	primary-ldap primary-group-ldap secondary-ldap secondary-group-ldap attribute-mapping administered-organisation
used by	complexType  XmlLdapContainerExport
attributes	Name   Type   Use   Default   Fixed   Annotation id   xs:long   optional   0      documentation Unique ID of the LDAP container. name   xs:string   required         documentation Unique name of the LDAP container. description   xs:string   optional         documentation Description of the LDAP container. active   xs:boolean      true      documentation Indicates if this container has been marked as deleted. entity-count   xs:int   optional         documentation Only specified when this XmlLdapContainer is used in a service response. The count of the number of LDAP entries this container referenced. This count is set when the container is queried. The count may not be currently correct if the LDAP directory has been modified since the count was set. last-accessed   xs:dateTime   optional         documentation Date and time on which the LDAP container was last queried, and the date on which the entity-count above was set.
annotation	documentation Definition of an LDAP container and any LDAP Source entries that it contains.
source	<xs:complexType name="XmlLdapContainer">   <xs:annotation>     <xs:documentation>Definition of an LDAP container and any LDAP Source entries that it contains.</xs:documentation>   </xs:annotation>   <xs:sequence>     <xs:choice minOccurs="1" maxOccurs="1">       <xs:element name="primary-ldap" type="XmlLdapContainerResource">         <xs:annotation>           <xs:documentation>Definition of the primary LDAP source for this LDAP container.</xs:documentation>         </xs:annotation>       </xs:element>       <xs:element name="primary-group-ldap" type="XmlLdapGroupSource">         <xs:annotation>           <xs:documentation>Definition of the primary LDAP source for this LDAP container.</xs:documentation>         </xs:annotation>       </xs:element>     </xs:choice>     <xs:choice minOccurs="0" maxOccurs="unbounded">       <xs:element name="secondary-ldap" type="XmlSecondaryLdapContainerResource">         <xs:annotation>           <xs:documentation>(Optional) Definition of a secondary LDAP source for this LDAP container. An LDAP container can have any number of secondary LDAP sources. A secondary LDAP source provides the ability to retrieve some LDAP data from an alternative LDAP server. Named LDAP attributes are used to map the secondary LDAP source to the primary LDAP source.</xs:documentation>         </xs:annotation>       </xs:element>       <xs:element name="secondary-group-ldap" type="XmlSecondaryLdapGroupSource">         <xs:annotation>           <xs:documentation>(Optional) Definition of a secondary LDAP source for this LDAP container. An LDAP container can have any number of secondary LDAP sources. A secondary LDAP source provides the ability to retrieve some LDAP data from an alternative LDAP server. Named LDAP attributes are used to map the secondary LDAP source to the primary LDAP source.</xs:documentation>         </xs:annotation>       </xs:element>     </xs:choice>     <xs:element name="attribute-mapping" type="XmlLdapAttributeContainerMapping" minOccurs="0" maxOccurs="unbounded">       <xs:annotation>         <xs:documentation>(Optional) Definition of a mapping of an organization model business attribute to an LDAP attribute. This can be used to obtain business attribute values from an LDAP direectory.</xs:documentation>       </xs:annotation>     </xs:element>     <xs:element name="administered-organisation" type="XmlAdministeredOrganisations" minOccurs="0" maxOccurs="unbounded">       <xs:annotation>         <xs:documentation>(Optional) Defines the list of organizations to which this container can map resources. If the organization is not in this list then this LDAP container can only be used to map users to organizations that have no restrictions.</xs:documentation>       </xs:annotation>     </xs:element>   </xs:sequence>   <xs:attribute name="id" type="xs:long" use="optional" default="0">     <xs:annotation>       <xs:documentation>Unique ID of the LDAP container.</xs:documentation>     </xs:annotation>   </xs:attribute>   <xs:attribute name="name" type="xs:string" use="required">     <xs:annotation>       <xs:documentation>Unique name of the LDAP container.</xs:documentation>     </xs:annotation>   </xs:attribute>   <xs:attribute name="description" type="xs:string" use="optional">     <xs:annotation>       <xs:documentation>Description of the LDAP container.</xs:documentation>     </xs:annotation>   </xs:attribute>   <xs:attribute name="active" type="xs:boolean" default="true">     <xs:annotation>       <xs:documentation>Indicates if this container has been marked as deleted.</xs:documentation>     </xs:annotation>   </xs:attribute>   <xs:attribute name="entity-count" type="xs:int" use="optional">     <xs:annotation>       <xs:documentation>Only specified when this XmlLdapContainer is used in a service response. The count of the number of LDAP entries this container referenced. This count is set when the container is queried. The count may not be currently correct if the LDAP directory has been modified since the count was set.</xs:documentation>     </xs:annotation>   </xs:attribute>   <xs:attribute name="last-accessed" type="xs:dateTime" use="optional">     <xs:annotation>       <xs:documentation>Date and time on which the LDAP container was last queried, and the date on which the entity-count above was set.</xs:documentation>     </xs:annotation>   </xs:attribute> </xs:complexType>

attribute XmlLdapContainer/@id

type	xs:long
properties	use  optional default  0
annotation	documentation Unique ID of the LDAP container.
source	<xs:attribute name="id" type="xs:long" use="optional" default="0">   <xs:annotation>     <xs:documentation>Unique ID of the LDAP container.</xs:documentation>   </xs:annotation> </xs:attribute>

attribute XmlLdapContainer/@name

type	xs:string
properties	use  required
annotation	documentation Unique name of the LDAP container.
source	<xs:attribute name="name" type="xs:string" use="required">   <xs:annotation>     <xs:documentation>Unique name of the LDAP container.</xs:documentation>   </xs:annotation> </xs:attribute>

attribute XmlLdapContainer/@description

type	xs:string
properties	use  optional
annotation	documentation Description of the LDAP container.
source	<xs:attribute name="description" type="xs:string" use="optional">   <xs:annotation>     <xs:documentation>Description of the LDAP container.</xs:documentation>   </xs:annotation> </xs:attribute>

attribute XmlLdapContainer/@active

type	xs:boolean
properties	default  true
annotation	documentation Indicates if this container has been marked as deleted.
source	<xs:attribute name="active" type="xs:boolean" default="true">   <xs:annotation>     <xs:documentation>Indicates if this container has been marked as deleted.</xs:documentation>   </xs:annotation> </xs:attribute>

attribute XmlLdapContainer/@entity-count

type	xs:int
properties	use  optional
annotation	documentation Only specified when this XmlLdapContainer is used in a service response. The count of the number of LDAP entries this container referenced. This count is set when the container is queried. The count may not be currently correct if the LDAP directory has been modified since the count was set.
source	<xs:attribute name="entity-count" type="xs:int" use="optional">   <xs:annotation>     <xs:documentation>Only specified when this XmlLdapContainer is used in a service response. The count of the number of LDAP entries this container referenced. This count is set when the container is queried. The count may not be currently correct if the LDAP directory has been modified since the count was set.</xs:documentation>   </xs:annotation> </xs:attribute>

attribute XmlLdapContainer/@last-accessed

type	xs:dateTime
properties	use  optional
annotation	documentation Date and time on which the LDAP container was last queried, and the date on which the entity-count above was set.
source	<xs:attribute name="last-accessed" type="xs:dateTime" use="optional">   <xs:annotation>     <xs:documentation>Date and time on which the LDAP container was last queried, and the date on which the entity-count above was set.</xs:documentation>   </xs:annotation> </xs:attribute>

element XmlLdapContainer/primary-ldap

diagram
type	XmlLdapContainerResource
properties	content  complex
attributes	Name   Type   Use   Default   Fixed   Annotation id   xs:long   required         documentation Unique ID of the LDAP source. guid   xs:string   optional         documentation Unique GUID of the LDAP source. ldap-alias   xs:string   required         documentation Alias of the LDAP directory that is referenced by this LDAP source. The alias is a previously configured shared resource that identifies this LDAP source. display-name-attributes   xs:string   optional         documentation (Optional) LDAP attributes that can be used to generate a default display name for any resource located within this LDAP source. ldap-search-string   xs:string   optional         documentation (Optional) LDAP query expression that can be used to restrict the data that is returned from this LDAP source. base-dn   xs:string   optional         documentation Optionally provides an additional base DN that will be used to restrict the results. This base DN is relative, and in additon, to any base DN specified in the URL of the LDAP Connection shared resource identified by the ldap-alias.
annotation	documentation Definition of the primary LDAP source for this LDAP container.
source	<xs:element name="primary-ldap" type="XmlLdapContainerResource">   <xs:annotation>     <xs:documentation>Definition of the primary LDAP source for this LDAP container.</xs:documentation>   </xs:annotation> </xs:element>

element XmlLdapContainer/primary-group-ldap

diagram
type	XmlLdapGroupSource
properties	content  complex
attributes	Name   Type   Use   Default   Fixed   Annotation id   xs:long   required         documentation Unique ID of the LDAP source. guid   xs:string   optional         documentation Unique GUID of the LDAP source. ldap-alias   xs:string   required         documentation Alias of the LDAP directory that is referenced by this LDAP source. The alias is a previously configured shared resource that identifies this LDAP source. display-name-attributes   xs:string   optional         documentation (Optional) LDAP attributes that can be used to generate a default display name for any resource located within this LDAP source. group-dn   xs:string   required         documentation The Group DN uniquely identifies the directory entry that is the group. This can be derived by performing a search based upon the base-DN, search filter and scope parameters described above. Or, it can be manually entered (with verification) by the user. member-attribute   xs:string   required         documentation The member attribute names the attribute within the group entry that holds the collection of member idenifiers - their DNs. This will give the final list of candidate resources.
annotation	documentation Definition of the primary LDAP source for this LDAP container.
source	<xs:element name="primary-group-ldap" type="XmlLdapGroupSource">   <xs:annotation>     <xs:documentation>Definition of the primary LDAP source for this LDAP container.</xs:documentation>   </xs:annotation> </xs:element>

element XmlLdapContainer/secondary-ldap

diagram
type	XmlSecondaryLdapContainerResource
properties	content  complex
children	container-mapping
attributes	Name   Type   Use   Default   Fixed   Annotation id   xs:long   required         documentation Unique ID of the LDAP source. guid   xs:string   optional         documentation Unique GUID of the LDAP source. ldap-alias   xs:string   required         documentation Alias of the LDAP directory that is referenced by this LDAP source. The alias is a previously configured shared resource that identifies this LDAP source. display-name-attributes   xs:string   optional         documentation (Optional) LDAP attributes that can be used to generate a default display name for any resource located within this LDAP source. ldap-search-string   xs:string   optional         documentation (Optional) LDAP query expression that can be used to restrict the data that is returned from this LDAP source. base-dn   xs:string   optional         documentation Optionally provides an additional base DN that will be used to restrict the results. This base DN is relative, and in additon, to any base DN specified in the URL of the LDAP Connection shared resource identified by the ldap-alias.
annotation	documentation (Optional) Definition of a secondary LDAP source for this LDAP container. An LDAP container can have any number of secondary LDAP sources. A secondary LDAP source provides the ability to retrieve some LDAP data from an alternative LDAP server. Named LDAP attributes are used to map the secondary LDAP source to the primary LDAP source.
source	<xs:element name="secondary-ldap" type="XmlSecondaryLdapContainerResource">   <xs:annotation>     <xs:documentation>(Optional) Definition of a secondary LDAP source for this LDAP container. An LDAP container can have any number of secondary LDAP sources. A secondary LDAP source provides the ability to retrieve some LDAP data from an alternative LDAP server. Named LDAP attributes are used to map the secondary LDAP source to the primary LDAP source.</xs:documentation>   </xs:annotation> </xs:element>

element XmlLdapContainer/secondary-group-ldap

diagram
type	XmlSecondaryLdapGroupSource
properties	content  complex
children	container-mapping
attributes	Name   Type   Use   Default   Fixed   Annotation id   xs:long   required         documentation Unique ID of the LDAP source. guid   xs:string   optional         documentation Unique GUID of the LDAP source. ldap-alias   xs:string   required         documentation Alias of the LDAP directory that is referenced by this LDAP source. The alias is a previously configured shared resource that identifies this LDAP source. display-name-attributes   xs:string   optional         documentation (Optional) LDAP attributes that can be used to generate a default display name for any resource located within this LDAP source. group-dn   xs:string   required         documentation The Group DN uniquely identifies the directory entry that is the group. This can be derived by performing a search based upon the base-DN, search filter and scope parameters described above. Or, it can be manually entered (with verification) by the user. member-attribute   xs:string   required         documentation The member attribute names the attribute within the group entry that holds the collection of member idenifiers - their DNs. This will give the final list of candidate resources.
annotation	documentation (Optional) Definition of a secondary LDAP source for this LDAP container. An LDAP container can have any number of secondary LDAP sources. A secondary LDAP source provides the ability to retrieve some LDAP data from an alternative LDAP server. Named LDAP attributes are used to map the secondary LDAP source to the primary LDAP source.
source	<xs:element name="secondary-group-ldap" type="XmlSecondaryLdapGroupSource">   <xs:annotation>     <xs:documentation>(Optional) Definition of a secondary LDAP source for this LDAP container. An LDAP container can have any number of secondary LDAP sources. A secondary LDAP source provides the ability to retrieve some LDAP data from an alternative LDAP server. Named LDAP attributes are used to map the secondary LDAP source to the primary LDAP source.</xs:documentation>   </xs:annotation> </xs:element>

element XmlLdapContainer/attribute-mapping

diagram
type	XmlLdapAttributeContainerMapping
properties	minOcc  0 maxOcc  unbounded content  complex
attributes	Name   Type   Use   Default   Fixed   Annotation ldap-resource-id   xs:long   required         documentation ID (within this enclosing XmlLdapContainer element) of the LDAP source that contains the named LDAP Attribute. business-attribute-id   xs:string   required         documentation The GUID of the business attribute (Resource Attribute) as defined in the organization model. ldap-attribute   xs:string   required         documentation LDAP attribute that is to be mapped to the identified business attribute. Whenever a value is required for the business attribute, it will be provided by this LDAP attribute.
annotation	documentation (Optional) Definition of a mapping of an organization model business attribute to an LDAP attribute. This can be used to obtain business attribute values from an LDAP direectory.
source	<xs:element name="attribute-mapping" type="XmlLdapAttributeContainerMapping" minOccurs="0" maxOccurs="unbounded">   <xs:annotation>     <xs:documentation>(Optional) Definition of a mapping of an organization model business attribute to an LDAP attribute. This can be used to obtain business attribute values from an LDAP direectory.</xs:documentation>   </xs:annotation> </xs:element>

element XmlLdapContainer/administered-organisation

diagram
type	XmlAdministeredOrganisations
properties	minOcc  0 maxOcc  unbounded content  complex
attributes	Name   Type   Use   Default   Fixed   Annotation guid   xs:string   required         documentation Unique identifier of the organization to be administered. name   xs:string            documentation Name of the organization to be administered. Only required when this element is used in a service response.
annotation	documentation (Optional) Defines the list of organizations to which this container can map resources. If the organization is not in this list then this LDAP container can only be used to map users to organizations that have no restrictions.
source	<xs:element name="administered-organisation" type="XmlAdministeredOrganisations" minOccurs="0" maxOccurs="unbounded">   <xs:annotation>     <xs:documentation>(Optional) Defines the list of organizations to which this container can map resources. If the organization is not in this list then this LDAP container can only be used to map users to organizations that have no restrictions.</xs:documentation>   </xs:annotation> </xs:element>

XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy