summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorRatan Gupta <ratagupt@in.ibm.com>2018-10-08 00:23:01 +0530
committerBrad Bishop <bradleyb@fuzziesquirrel.com>2018-11-20 02:41:46 +0000
commit23886efd0780cd6c87741a9ecac2d55d9ab4c7a8 (patch)
tree6ca90b067a60ffac60def9156428e78b7adccdfe /docs
parentbc4f180c2f15cdca8489168fd796e92aeeb8f52b (diff)
downloadphosphor-user-manager-23886efd0780cd6c87741a9ecac2d55d9ab4c7a8.tar.gz
phosphor-user-manager-23886efd0780cd6c87741a9ecac2d55d9ab4c7a8.zip
Add readme for user manager
This document presently have the various REST commands related to configuration of LDAP on the BMC. Change-Id: I0c1be4692b546bb591378f73bc992d6c742c3bc1 Signed-off-by: Ratan Gupta <ratagupt@in.ibm.com> Signed-off-by: Nagaraju Goruganti <ngorugan@in.ibm.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/README.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..0481327
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,49 @@
+## To Build
+```
+To build this package, do the following steps:
+
+ 1. ./bootstrap.sh
+ 2. ./configure ${CONFIGURE_FLAGS}
+ 3. make
+
+To clean the repository run `./bootstrap.sh clean`.
+```
+
+#### LDAP Configuration
+
+#### Configure LDAP
+
+```
+curl -c cjar -b cjar -k -H "Content-Type: application/json" -X POST -d '{"data":[false,"ldap://<ldap://<LDAP server ip/hostname>/", "<bindDN>", "<baseDN>","<bindDNPassword>","<searchScope>","<serverType>"]}'' https://$BMC_IP//xyz/openbmc_project/user/ldap/action/CreateConfig
+
+```
+#### NOTE
+If the configured ldap server is secure then we need to upload the client certificate and the CA certificate in following cases.
+ - First time LDAP configuration.
+ - Change the already configured Client/CA certificate
+
+#### Upload LDAP Client Certificate
+
+```
+curl -c cjar -b cjar -k -H "Content-Type: application/octet-stream"
+ -X PUT -T <FILE> https://<BMC_IP>/xyz/openbmc_project/certs/client/ldap
+```
+
+#### Upload CA Certificate
+
+```
+curl -c cjar -b cjar -k -H "Content-Type: application/octet-stream"
+ -X PUT -T <FILE> https://<BMC_IP>/xyz/openbmc_project/certs/authority/ldap
+```
+
+#### Clear LDAP Config
+
+```
+curl -b cjar -k -H "Content-Type: application/json" -X POST -d '{"data":[]}' https://$BMC_IP/xyz/openbmc_project/user/ldap/config/action/delete
+```
+
+#### Get LDAP Config
+
+```
+curl -b cjar -k https://$BMC_IP/xyz/openbmc_project/user/ldap/enumerate
+```
OpenPOWER on IntegriCloud