Difference between revisions of "stoney core: OpenLDAP directory data organisation"

From stoney cloud
Jump to: navigation, search
[unchecked revision][unchecked revision]
(→‎People)
Line 1: Line 1:
−
 
−
 
−
 
−
 
 
The person '''Name Surname''' (with the uid=4000002) belongs to the reseller '''Reseller Ltd.''' (with sstBelongsToResellerUID=4000000) and is an employee of the same company (sstEmployeeOfUID=4000000). The person also belongs the customer '''Customer Ltd.'' (with sstBelongsToCustomerUID=4000001) and is an employee of the same company (sstEmployeeOfUID=4000001).
 
The person '''Name Surname''' (with the uid=4000002) belongs to the reseller '''Reseller Ltd.''' (with sstBelongsToResellerUID=4000000) and is an employee of the same company (sstEmployeeOfUID=4000000). The person also belongs the customer '''Customer Ltd.'' (with sstBelongsToCustomerUID=4000001) and is an employee of the same company (sstEmployeeOfUID=4000001).
  

Revision as of 14:52, 24 July 2013

The person Name Surname' (with the uid=4000002) belongs to the reseller Reseller Ltd. (with sstBelongsToResellerUID=4000000) and is an employee of the same company (sstEmployeeOfUID=4000000). The person also belongs the customer Customer Ltd. (with sstBelongsToCustomerUID=4000001) and is an employee of the same company (sstEmployeeOfUID=4000001).

The following table describes the different attributes:

AttributeType
Existence
Mandatory
User alterable
 Description
uid
MUST
x
Unique Identifier.
sstGender
MUST
x
Either 'm' for male or 'f' for female
surname
MUST
x
(x)
 Surname, example: Meier
givenName
MUST
x
(x)
 Givenname, example: Hans
preferredLanguage
MUST
x
x
 Display language of the user according to RFC 1766, example: de-CH
userPassword
MUST
x
x
 SSHA user password. {SSHA} is a RFC 2307 password scheme which uses the SHA1 secure hash algorithm. The {SSHA} is the seeded varient. {SSHA} is recommended over other RFC 2307 schemes.
mail
MUST
x
x
 E-mail address of the user, example: hans@example.com
cn
MAY
x
 Common name of the user, for instance admin or user1.
telephoneNumber
MAY
x1
x1
 Fixnet phone number, example: +41 31 222 33 44
mobileTelephoneNumber
MAY
x1
x1
 Mobile phone number, example: +41 76 222 33 44
sstTimeZoneOffset
MUST
x
x
 Time zone as an offset from UTC, example: UTC+01
sstBelongsUID
MAY
Wenn dieser Wert vorhanden ist und der Wert "1" aufweist, ist diese Person Superuser und hat Zugriff über das gesamte System. In der Regel wird der Superuser nur benötigt, um neue Wiederverkäufer (Reseller) aufzuschalten.
sstBelongsToResellerUID
MAY
Die UID des Wiederverkäufers (Reseller) zu der die Person gehört. Das heisst, die Person ist Mitarbeiter des Wiederverkäufers.
sstBelongsToCustomerUID
MUST
x
Die UID des Kunden (Customer) zu der die Person gehört. Das heisst, die Person ist Mitarbeiter des Kunden.

Legende zur Mandatory Spalte:

  • x1: Entweder telephoneNumber oder mobileTelephoneNumber müssen ausgefüllt sein.
  • (x): Noch nicht definiert, ob der Benutzer (User) diese Werte ändern darf. 


dn: sstRole=Customer Administrator,uid=4000002,ou=people,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstRoles
sstRole: Customer Administrator
sstProduct: 0

dn: sstRole=Reseller Administrator,uid=4000002,ou=people,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstRoles
sstRole: Reseller Administrator
sstProduct: 0

Objekt Klasse sstRoles:

AttributeType
Existence
Mandatory
User alterable
 Description
sstRole
MUST
x
The name of the role. Possible valuese:
  • Admin Backup
  • Admin Customer
  • Admin Mail
  • Admin Reseller
  • Admin Virtualization
  • User (this is the minimal role, that each person has).
sstProduct
MUST
x
The default value is zero. This means, the person has access to all the product which the current role allow.

If you want to restrict access to certain products, you must list the corresponding product UIDs.

Reseller

The sub tree ou=reseller,dc=stoney-cloud,dc=org contains all the resellers. Each reseller has a unique uid, which is used for later reference.

Reseller uid (per Reseller)

The following LDIF shows you the default reseller entry after a fresh stoney cloud installation. All relevant data belonging to this reseller is stored below this dn. 

dn: uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstReseller
uid: 4000000
organizationName: Reseller Ltd.
sstBelongsToResellerUID: 4000000
sstIsActive: TRUE

The following table describes the different attributes:

Attribute
Existence
Mandatory
 Description
uid
MUST
x
 A unique integer value with 7 digits or more. For example: 4000000.
organizationName
MUST
x
 The organisation name of the reseller. For example: Reseller Ltd..
sstBelongsToResellerUID
MAY
x
 Stores the reseller UID the leaf belongs to. A unique value with 7 digits or more, must correspond with the uid entry. For example: 4000000.
sstIsActive
MAY
x
 Is the entry active? Either yes (TRUE) or no (FALSE).

Legend:

  • x: Mandatory in all cases.

Reseller Billing Address

The sub tree ou=address,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org contains the billing address: 

dn: ou=address,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstAddressCompany
ou: address
organizationName: Reseller Ltd.
sstGender: m
givenName: Name
surname: Surname
postalAddress: Street Number
countryName: CH
postalCode: Postal Code
localityName: Locality
preferredLanguage: en-GB
mail: name.surname@example.com
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstWebsiteURL: https://www.example.com/

The following table describes the different attributes:

Attribute
Existence
Mandatory
 Description
organizationName
MUST
x
 Company name, example: stepping stone GmbH
sstGender
MUST
x
 Either 'm' for male or 'f' for female.
givenName
MUST
x
 Givenname, example: Hans.
surname
MUST
x
 Surname, example: Muster.
postalAddress
MAY
x2
 Street Number, example: Neufeldstrasse 9. Multi-lined field.
postOfficeBox
MAY
x2
 Postbox, example: 3456.
stateOrProvinceName
MAY
x3
 This pulldown menu is only active (appears to the user), if the country is set to Canada or the USA.
countryName
MUST
x
 Country code according to ISO 3166-1 (for the web interface) and the corresponding ISO 3166-1-alpha-2 code (as the LDAP entry). Example: For Switzerland the value is CH.
postalCode
MUST
x
 Zipcode, example: 3012
localityName
MUST
x
 City, example: Bern.
preferredLanguage
MUST
x
 Display language of the user according to RFC 1766, example: de-CH. Currently supported:
  • de-CH
  • en-GB
mail
MUST
x
 E-mail address of the user, example: hans.muster@example.com.
telephoneNumber
MAY
x1
 Fixnet phone number, example: +41 31 222 33 44.
mobileTelephoneNumber
MAY
x1
 Mobile phone number, example: +41 76 222 33 44.
sstWebsiteURL
MAY
 URL gemäss RFC-3986 http://tools.ietf.org/html/rfc3986. For example http://www.stepping-stone.ch/.

Legend:

  • x1: Either telephoneNumber or mobileTelephoneNumber need to be present. Both attributes can exist together.
  • x2: Either postalAddress or postOfficeBox need to be present. Both attributes can exist together.
  • x3: If the countryName is either Canada or the USA, the stateOrProvinceName needs to be present.

Reseller Shipping Address (optional)

The sub tree ou=shipping,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org contains the shipping address and is optional (it is only needed, if the shipping address differs from the billing Address). 

dn: ou=shipping,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstAddressCompany
ou: shipping
organizationName: Reseller Ltd.
sstGender: m
givenName: Name
surname: Surname
postalAddress: Street Number
countryName: CH
postalCode: Postal Code
localityName: Locality
preferredLanguage: en-GB
mail: name.surname@example.com
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstWebsiteURL: https://www.example.com/

Reseller Billing

The sub tree ou=billing,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org contains billing relevant data: 

dn: ou=billing,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstBillingReseller
ou: billing
sstResellerBill: FALSE

This entry need to be described in detail. TBD.

The following table describes the different attributes:

Attribute
Existence
Mandatory
 Description
attribure
MUST
x
 TBD.

Legend:

  • x: Mandatory in all cases.

Reseller Customers

The sub tree ou=customers,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org contains the customers belonging to the reseller Reseller Ltd. (all the customers with the the attribute sstBelongsToResellerUID=4000000). With the attribute labeledURI we use the functionality of the dynamic lists overlay to automatically give us a list of customers belonging to this reseller. 

dn: ou=customers,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: labeledURIObject
ou: customers
labeledURI: ldap:///ou=customers,dc=stoney-cloud,dc=org??one?(sstBelongsToResellerUID=4000000)
member: uid=4000001,ou=customers,dc=stoney-cloud,dc=org

In this example, the reseller Reseller Ltd. has one customer (with the uid=4000001).

The following table describes the different attributes:

Attribute
Existence
Mandatory
 Description
attribure
MUST
x
 TBD.

Legend:

  • x: Mandatory in all cases.

Reseller Employees

The sub tree ou=employees,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org contains the employees belonging to the reseller Reseller Ltd. (all the employees with the the attribute sstBelongsToEmployeeUID=4000000). With the attribute labeledURI we use the functionality of the dynamic lists overlay to automatically give us a list of employees belonging to this reseller. The number of employees is always the same or smaller than the number of people belonging to a reseller (they are a subset). 

dn: ou=employees,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: labeledURIObject
ou: employees
labeledURI: ldap:///ou=people,dc=stoney-cloud,dc=org??one?(sstEmployeeOfUID=4000000)
member: uid=4000002,ou=people,dc=stoney-cloud,dc=org

In this example, the reseller Reseller Ltd. has one employee (with the uid=4000002).

The following table describes the different attributes:

Attribute
Existence
Mandatory
 Description
attribure
MUST
x
 TBD.

Legend:

  • x: Mandatory in all cases.

Reseller People

The sub tree ou=people,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org contains the all the people belonging to the reseller Reseller Ltd. (all the people, including the employees, with the the attribute sstBelongsToResellerUID=4000000). With the attribute labeledURI we use the functionality of the dynamic lists overlay to automatically give us a list of employees belonging to this reseller. The number of people is always the same or larger than the number of employees belonging to a reseller. 

dn: ou=people,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: labeledURIObject
ou: employees
labeledURI: ldap:///ou=people,dc=stoney-cloud,dc=org??one?(sstBelongsToResellerUID=4000000)
member: uid=4000002,ou=people,dc=stoney-cloud,dc=org
member: uid=4000064,ou=people,dc=stoney-cloud,dc=org
member: uid=4000066,ou=people,dc=stoney-cloud,dc=org
member: uid=4000069,ou=people,dc=stoney-cloud,dc=org

In this example, four people the reseller Reseller Ltd. (including the employee with the uid=4000002).

The following table describes the different attributes:

Attribute
Existence
Mandatory
 Description
attribure
MUST
x
 TBD.

Legend:

  • x: Mandatory in all cases.

Services

Retrieved from "http://wiki.stoney-cloud.org/mediawiki/index.php?title=stoney_core:_OpenLDAP_directory_data_organisation&oldid=136"