Changes between Version 6 and Version 7 of HBPHPCLDAP

Timestamp:

06/15/16 15:19:49 (8 years ago)

Author:

Carsten Karbach

Comment:

--

HBPHPCLDAP

@@ -21 +21 @@
 [[Image(/raw-attachment/wiki/HBPHPCLDAP/HBPLDAP_v2.png,800px)]]
 
+=== Rest API example calls ===
+
+The Rest API documentation can be found at https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/doc. You can use the Swagger UI to generate all REST API calls. Here are some example calls on this REST API:
+
+Examples:
+
+==== Projects ====
+- get
+{{{
+https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/projects
+}}}
+
+- add new project
+{{{
+curl -X POST --header 'Content-Type: application/json' --header 'Accept: text/html' 'https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/projects?projectname=bp045678'
+}}}
+
+- get project details
+{{{
+https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/projects/bp045678
+}}}
+
+- add accounts to project
+{{{
+curl -X POST --header 'Content-Type: application/json' --header 'Accept: text/html' 'https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/projects/bp045678/accounts?bp0ID=bp000005'
+}}}
+
+- get accounts of project
+{{{
+https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/projects/bp045678/accounts
+}}}
+
+- remove account from project
+{{{
+curl -X DELETE --header 'Accept: text/html' 'https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/projects/bp045678/accounts/bp000005'
+}}}
+
+- add project to system
+{{{
+curl -X POST --header 'Content-Type: application/json' --header 'Accept: text/html' 'https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/projects/bp045678/systems?system=juqueen'
+}}}
+
+- delete project
+{{{
+curl -X DELETE --header 'Accept: text/html' 'https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/projects/bp045678'
+}}}
+
+==== Accounts ====
+- get account list
+{{{
+https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/accounts
+https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/accounts?filter=cn%3D*Karbach*
+https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/accounts?filter=uid%3D*5
+}}}
+- create account for project
+{{{
+curl -X POST --header 'Content-Type: application/json' --header 'Accept: text/html' 'https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/accounts?oidcid=244515&action=create&project=bp02'
+}}}
+- get account details
+{{{
+https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/accounts/bp000003
+}}}
+- add account to project
+{{{
+curl -X POST --header 'Content-Type: application/json' --header 'Accept: text/html' 'https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/projects/bp000001/accounts?bp0ID=bp000004'
+}}}
+- delete account from project
+{{{
+curl -X DELETE --header 'Accept: text/html' 'https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/projects/bp000001/accounts/bp000004'
+}}}
+
+==== People ====
+
+- get all stored OIDC IDs
+{{{
+https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/people
+}}}
+
+- get filtered by mail
+{{{
+https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/people?filter=mail%3D*karbach*
+}}}
+
+- get person details
+{{{
+https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/people/244515
+}}}
+
+- find person entries from OIDC server
+{{{
+https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/people/oidc?filter=sn%3DOrth
+}}}
+
+- import person entry from OIDC
+{{{
+curl -X POST --header 'Content-Type: application/json' --header 'Accept: text/html' 'https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/people?oidcid=255622'
+}}}
+
+- update attributes for person
+{{{
+curl -X PATCH --header 'Content-Type: application/json' --header 'Accept: text/html' 'https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/people/255622?attribute=postaladdress&action=add&value=Forschungszentrum%20Juelich%20GmbH%3BWilhelm-Johnen-Strasse%3B%3B52428%3BJuelich%3BGermany'
+}}}
+
+- delete person and all connected accounts
+{{{
+curl -X DELETE --header 'Accept: text/html' 'https://hbpacc.zam.kfa-juelich.de/hpcmanagement/v1/people/255622'
+}}}
+
+
 === Trouble shooting ===