complexType XmlContainer

diagram |
namespace | http://base.api.de.bpm.tibco.com
children | primary-ldap primary-group-ldap secondary-ldap secondary-group-ldap restricted-org
used by |
element | test
attributes |
Name | Type | Use | Default | Fixed | Annotation
id | xs:long | optional | 0 |  |
documentation
Unique ID of the LDAP container. Only given when updating an existing 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
Read-only - Indicates if this container has been marked as deleted. Containers will only be deleted when all resources derived from it are deleted.
entity-count | xs:int | optional |  |  |
documentation
Read-only - only specified when this XmlContainer 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
Read-only - 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="XmlContainer"> <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="XmlLdapQuerySource"> <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="XmlSecondaryLdapQuerySource"> <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 directory. Named LDAP attributes are used to map the secondary LDAP entries to the primary LDAP entries.</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 directory. Named LDAP attributes are used to map the secondary LDAP entries to the primary LDAP entries.</xs:documentation> </xs:annotation> </xs:element> </xs:choice> <xs:element name="restricted-org" type="XmlRestrictedOrg" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>(Optional) Identifies the organisations to which access is restricted to only those resources derived from the LDAP container in which this element resides. It also restricts the organizations to which resources derived from the LDAP container can be assigned.</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. Only given when updating an existing 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>Read-only - Indicates if this container has been marked as deleted. Containers will only be deleted when all resources derived from it are deleted.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="entity-count" type="xs:int" use="optional"> <xs:annotation> <xs:documentation>Read-only - only specified when this XmlContainer 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>Read-only - 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 XmlContainer/@id

type | xs:long
properties |
use | optional
default | 0
annotation |
documentation
Unique ID of the LDAP container. Only given when updating an existing LDAP container.
source | <xs:attribute name="id" type="xs:long" use="optional" default="0"> <xs:annotation> <xs:documentation>Unique ID of the LDAP container. Only given when updating an existing LDAP container.</xs:documentation> </xs:annotation> </xs:attribute>

attribute XmlContainer/@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 XmlContainer/@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 XmlContainer/@active

type | xs:boolean
properties |
default | true
annotation |
documentation
Read-only - Indicates if this container has been marked as deleted. Containers will only be deleted when all resources derived from it are deleted.
source | <xs:attribute name="active" type="xs:boolean" default="true"> <xs:annotation> <xs:documentation>Read-only - Indicates if this container has been marked as deleted. Containers will only be deleted when all resources derived from it are deleted.</xs:documentation> </xs:annotation> </xs:attribute>

attribute XmlContainer/@entity-count

type | xs:int
properties |
use | optional
annotation |
documentation
Read-only - only specified when this XmlContainer 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>Read-only - only specified when this XmlContainer 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 XmlContainer/@last-accessed

type | xs:dateTime
properties |
use | optional
annotation |
documentation
Read-only - 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>Read-only - 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 XmlContainer/primary-ldap

diagram |
type | XmlLdapQuerySource
properties |
content | complex
children | attribute-mapping
attributes |
Name | Type | Use | Default | Fixed | Annotation
ldap-alias | xs:string | required |  |  |
documentation
The name (or alias) by which a configured LDAP connection shared resource is identified. LDAP connection shared resource are named with the prefix "ldap/de/" in order to indicate that they are intended for Directory Engine use. The alias given here is that name without the "ldap/de/" prefix. An LDAP container can contain only one instance of an LDAP source for any alias.
resource-name-attributes | xs:string | optional |  |  |
documentation
(Optional) A space-separated list of named LDAP attributes, whose values will be concatenated to generate a default display name for resources derived from entries in this LDAP source. When an LDAP container contains one or more secondary LDAP sources, and those LDAP sources also provide resource-name-attributes, those of the first entry encountered will be used.
base-dn | xs:string | optional |  |  |
documentation
(Optional) Provides an additional base DN that will be used to restrict the scope of the LDAP query. This base DN is relative to, and in additon, to any base DN specified in the URL of the LDAP connection shared resource identified by the ldap-alias.
ldap-query | xs:string | required |  |  |
documentation
LDAP query expression used to identify the entries to be returned from this LDAP source.
search-scope | XmlLdapSearchScope | optional |  |  |
documentation
The Search Scope determines the depth to which the search will be performed. By default the search will be SUBTREE.
annotation |
documentation
Definition of the primary LDAP source for this LDAP container.
source | <xs:element name="primary-ldap" type="XmlLdapQuerySource"> <xs:annotation> <xs:documentation>Definition of the primary LDAP source for this LDAP container.</xs:documentation> </xs:annotation> </xs:element>

element XmlContainer/primary-group-ldap

diagram |
type | XmlLdapGroupSource
properties |
content | complex
children | attribute-mapping
attributes |
Name | Type | Use | Default | Fixed | Annotation
ldap-alias | xs:string | required |  |  |
documentation
The name (or alias) by which a configured LDAP connection shared resource is identified. LDAP connection shared resource are named with the prefix "ldap/de/" in order to indicate that they are intended for Directory Engine use. The alias given here is that name without the "ldap/de/" prefix. An LDAP container can contain only one instance of an LDAP source for any alias.
resource-name-attributes | xs:string | optional |  |  |
documentation
(Optional) A space-separated list of named LDAP attributes, whose values will be concatenated to generate a default display name for resources derived from entries in this LDAP source. When an LDAP container contains one or more secondary LDAP sources, and those LDAP sources also provide resource-name-attributes, those of the first entry encountered will be used.
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 XmlContainer/secondary-ldap

diagram |
type | XmlSecondaryLdapQuerySource
properties |
content | complex
children | attribute-mapping primary-link
attributes |
Name | Type | Use | Default | Fixed | Annotation
ldap-alias | xs:string | required |  |  |
documentation
The name (or alias) by which a configured LDAP connection shared resource is identified. LDAP connection shared resource are named with the prefix "ldap/de/" in order to indicate that they are intended for Directory Engine use. The alias given here is that name without the "ldap/de/" prefix. An LDAP container can contain only one instance of an LDAP source for any alias.
resource-name-attributes | xs:string | optional |  |  |
documentation
(Optional) A space-separated list of named LDAP attributes, whose values will be concatenated to generate a default display name for resources derived from entries in this LDAP source. When an LDAP container contains one or more secondary LDAP sources, and those LDAP sources also provide resource-name-attributes, those of the first entry encountered will be used.
base-dn | xs:string | optional |  |  |
documentation
(Optional) Provides an additional base DN that will be used to restrict the scope of the LDAP query. This base DN is relative to, and in additon, to any base DN specified in the URL of the LDAP connection shared resource identified by the ldap-alias.
ldap-query | xs:string | required |  |  |
documentation
LDAP query expression used to identify the entries to be returned from this LDAP source.
search-scope | XmlLdapSearchScope | optional |  |  |
documentation
The Search Scope determines the depth to which the search will be performed. By default the search will be SUBTREE.
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 directory. Named LDAP attributes are used to map the secondary LDAP entries to the primary LDAP entries.
source | <xs:element name="secondary-ldap" type="XmlSecondaryLdapQuerySource"> <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 directory. Named LDAP attributes are used to map the secondary LDAP entries to the primary LDAP entries.</xs:documentation> </xs:annotation> </xs:element>

element XmlContainer/secondary-group-ldap

diagram |
type | XmlSecondaryLdapGroupSource
properties |
content | complex
children | attribute-mapping primary-link
attributes |
Name | Type | Use | Default | Fixed | Annotation
ldap-alias | xs:string | required |  |  |
documentation
The name (or alias) by which a configured LDAP connection shared resource is identified. LDAP connection shared resource are named with the prefix "ldap/de/" in order to indicate that they are intended for Directory Engine use. The alias given here is that name without the "ldap/de/" prefix. An LDAP container can contain only one instance of an LDAP source for any alias.
resource-name-attributes | xs:string | optional |  |  |
documentation
(Optional) A space-separated list of named LDAP attributes, whose values will be concatenated to generate a default display name for resources derived from entries in this LDAP source. When an LDAP container contains one or more secondary LDAP sources, and those LDAP sources also provide resource-name-attributes, those of the first entry encountered will be used.
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 directory. Named LDAP attributes are used to map the secondary LDAP entries to the primary LDAP entries.
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 directory. Named LDAP attributes are used to map the secondary LDAP entries to the primary LDAP entries.</xs:documentation> </xs:annotation> </xs:element>

element XmlContainer/restricted-org

diagram |
type | XmlRestrictedOrg
properties |
minOcc | 0
maxOcc | unbounded
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
org-guid | xs:string | required |  |  |
documentation
Unique identifier of the organisation to be administered.
name | xs:string | optional |  |  |
documentation
Read-only - Name of the organization to be administered. Only supplied for display purposes.
annotation |
documentation
(Optional) Identifies the organisations to which access is restricted to only those resources derived from the LDAP container in which this element resides. It also restricts the organizations to which resources derived from the LDAP container can be assigned.
source | <xs:element name="restricted-org" type="XmlRestrictedOrg" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>(Optional) Identifies the organisations to which access is restricted to only those resources derived from the LDAP container in which this element resides. It also restricts the organizations to which resources derived from the LDAP container can be assigned.</xs:documentation> </xs:annotation> </xs:element>

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