blob: 28c76b8309ae977efd07baea251f8354894337e7 [file] [log] [blame]
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -05001description: >
2 Implement to update LDAP mandatory properties.
Ratan Gupta69619ce2019-04-22 20:29:46 +05303 Any service implementing User.Ldap.Config interface on one or more
4 objects must implement Object.Enable interface on the object.
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -05005
6properties:
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -05007 - name: LDAPServerURI
8 type: string
9 description: >
10 Specifies the LDAP URI of the server to connect to.
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050011 errors:
12 - xyz.openbmc_project.Common.Error.InternalFailure
13 - xyz.openbmc_project.Common.Error.InvalidArgument
Ratan Guptaa3338fa2018-10-24 23:34:55 +053014 - xyz.openbmc_project.Common.Error.NoCACertificate
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050015 - name: LDAPBindDN
16 type: string
17 description: >
18 Specifies the distinguished name with which to bind to the directory
19 server for lookups.
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050020 errors:
21 - xyz.openbmc_project.Common.Error.InternalFailure
22 - xyz.openbmc_project.Common.Error.InvalidArgument
Ratan Gupta46239082019-03-20 07:11:40 +053023 - name: LDAPBindDNPassword
24 type: string
25 description: >
26 Specifies the credentials with which to bind,Implementation should
27 consider changing the permissions of the underlying file to
28 only grant access to the root user.
29 This property value should not be reflected on the D-bus object itself.
30 Implementation can use the given value and update the service
31 implementing the LDAP client.This is just to facilitate the support
32 for changing the bin dn password if needed.
33 Currently this property is over D-bus, There are security concerns
34 for the same, but once we find better way to update the ldap password
35 we would fix it.
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050036 - name: LDAPBaseDN
37 type: string
38 description: >
39 Specifies the base distinguished name to use as search base.
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050040 errors:
41 - xyz.openbmc_project.Common.Error.InternalFailure
42 - xyz.openbmc_project.Common.Error.InvalidArgument
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050043 - name: LDAPSearchScope
44 type: enum[self.SearchScope]
45 description: >
46 Specifies the search scope:subtree, one level or base object.
Lei YUcb1d0592019-01-09 10:25:49 +080047 default: sub
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050048 errors:
49 - xyz.openbmc_project.Common.Error.InternalFailure
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050050 - name: LDAPType
51 type: enum[self.Type]
52 description: >
53 Specifies the the configured server is ActiveDirectory(AD) or
54 OpenLdap. It's just an indication for the LDAP stack running on
55 the BMC, in case the app is implemented in such a way that it has
56 to react differently for AD vs openldap.
Ratan Gupta1bd70872019-04-16 12:53:40 +053057 This property is readonly, Once the D-Bus object gets created then
58 this property should not be modifiable.
Nagaraju Goruganti95fafa82018-09-30 23:25:42 -050059 errors:
60 - xyz.openbmc_project.Common.Error.InternalFailure
Ratan Gupta1bd70872019-04-16 12:53:40 +053061 - xyz.openbmc_project.Common.Error.NotAllowed
Ratan Gupta910b0d92019-03-08 20:40:49 +053062 - name: GroupNameAttribute
63 type: string
64 description: >
65 The value of this property shall be the attribute name
66 that contains the name of the Group in the LDAP server.
67 - name: UserNameAttribute
68 type: string
69 description: >
70 The value of this property shall be the attribute name
71 that contains the username in the LDAP server.
Nagaraju Gorugantic6cfd2c2018-08-10 00:57:41 -050072enumerations:
73 - name: SearchScope
74 description: >
75 Possible base scopes.
76 values:
77 - name: sub
78 - name: one
79 - name: base
80
81 - name: Type
82 description: >
83 Possible LDAP Types.
84 values:
85 - name: ActiveDirectory
86 - name: OpenLdap
87
88# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4