From df9525095ed044af1a9d3f83821bfb22c91cc9bc Mon Sep 17 00:00:00 2001 From: Maxime Besson Date: Fri, 24 Apr 2020 16:56:16 +0200 Subject: [PATCH] Integrate API Documentation --- Makefile | 8 + _example/etc/api-apache2.4.conf | 10 + _example/etc/api-apache2.X.conf | 16 + _example/etc/api-apache2.conf | 11 + _example/etc/api-nginx.conf | 27 +- doc/index.html | 7 +- doc/pages/manager-api/.swagger-codegen-ignore | 23 + .../manager-api/.swagger-codegen/VERSION | 1 + doc/pages/manager-api/index.html | 10265 ++++++++++++++++ doc/sources/manager-api/config-codegen.json | 6 + doc/sources/manager-api/openapi-spec.yaml | 785 ++ lemonldap-ng-manager/MANIFEST | 1 + lemonldap-ng-manager/site/templates/api.tpl | 14 + 13 files changed, 11163 insertions(+), 11 deletions(-) create mode 100644 doc/pages/manager-api/.swagger-codegen-ignore create mode 100644 doc/pages/manager-api/.swagger-codegen/VERSION create mode 100644 doc/pages/manager-api/index.html create mode 100644 doc/sources/manager-api/config-codegen.json create mode 100644 doc/sources/manager-api/openapi-spec.yaml create mode 100644 lemonldap-ng-manager/site/templates/api.tpl diff --git a/Makefile b/Makefile index fd189574f..ab34e4dab 100644 --- a/Makefile +++ b/Makefile @@ -1183,3 +1183,11 @@ e2e_cert: -reqexts SAN \ -extensions SAN \ -config e2e-tests/openssl.cnf + +api_doc: doc/sources/manager-api/openapi-spec.yaml doc/sources/manager-api/config-codegen.json + @if [ -f "$(SWAGGER_CODEGEN)" ] ; then \ + java -jar "$(SWAGGER_CODEGEN)" generate -i doc/sources/manager-api/openapi-spec.yaml -l html2 -o doc/pages/manager-api/ -c doc/sources/manager-api/config-codegen.json; \ + else \ + echo "Please run me with SWAGGER_CODEGEN=/path/to/swagger-codegen.jar"; \ + fi + diff --git a/_example/etc/api-apache2.4.conf b/_example/etc/api-apache2.4.conf index 112c5d7ab..53abd3403 100644 --- a/_example/etc/api-apache2.4.conf +++ b/_example/etc/api-apache2.4.conf @@ -40,6 +40,7 @@ # RewriteCond "%{REQUEST_URI}" "!\.html(?:/.*)?$" # REST URLs + RewriteCond "%{REQUEST_URI}" "!^/(?:doc)" RewriteRule "^/(.+)$" "/api.fcgi/$1" [PT] # 2) FastCGI engine @@ -83,6 +84,15 @@ + # On-line documentation + Alias /doc/ __DEFDOCDIR__ + + Require all granted + ErrorDocument 404 /notfound.html + Options +FollowSymLinks + DirectoryIndex index.html start.html + + # Uncomment this if site if you use SSL only #Header set Strict-Transport-Security "max-age=15768000" diff --git a/_example/etc/api-apache2.X.conf b/_example/etc/api-apache2.X.conf index 93eed0a1b..ffcc7425c 100644 --- a/_example/etc/api-apache2.X.conf +++ b/_example/etc/api-apache2.X.conf @@ -40,6 +40,7 @@ # RewriteCond "%{REQUEST_URI}" "!\.html(?:/.*)?$" # REST URLs + RewriteCond "%{REQUEST_URI}" "!^/(?:doc)" RewriteRule "^/(.+)$" "/api.fcgi/$1" [PT] # 2) FastCGI engine @@ -90,6 +91,21 @@ + # On-line documentation + Alias /doc/ __DEFDOCDIR__ + + = 2.3> + Require all granted + + + Order Deny,Allow + Allow from all + + ErrorDocument 404 /notfound.html + Options +FollowSymLinks + DirectoryIndex index.html start.html + + # Uncomment this if site if you use SSL only #Header set Strict-Transport-Security "max-age=15768000" diff --git a/_example/etc/api-apache2.conf b/_example/etc/api-apache2.conf index 4f3854290..f362c8778 100644 --- a/_example/etc/api-apache2.conf +++ b/_example/etc/api-apache2.conf @@ -40,6 +40,7 @@ # RewriteCond "%{REQUEST_URI}" "!\.html(?:/.*)?$" # REST URLs + RewriteCond "%{REQUEST_URI}" "!^/(?:doc)" RewriteRule "^/(.+)$" "/api.fcgi/$1" [PT] # 2) FastCGI engine @@ -84,6 +85,16 @@ + # On-line documentation + Alias /doc/ __DEFDOCDIR__ + + Order allow,deny + Allow from all + ErrorDocument 404 /notfound.html + Options +FollowSymLinks + DirectoryIndex index.html start.html + + # Uncomment this if site if you use SSL only #Header set Strict-Transport-Security "max-age=15768000" diff --git a/_example/etc/api-nginx.conf b/_example/etc/api-nginx.conf index e4fa1d5f2..3f9668c1d 100644 --- a/_example/etc/api-nginx.conf +++ b/_example/etc/api-nginx.conf @@ -15,7 +15,13 @@ server { #set_real_ip_from 127.0.0.1; #real_ip_header X-Forwarded-For; - rewrite ^/(.*)$ /api.psgi/$1 break; + location /doc/ { + alias /usr/share/doc/lemonldap-ng-doc/; + index index.html start.html; + } + location / { + rewrite ^/(.*)$ /api.psgi/$1; + } location ~ ^(?/.*\.psgi)(?:$|/) { @@ -37,17 +43,18 @@ server { # Uncomment this if you use https only #add_header Strict-Transport-Security "max-age=15768000"; - # By default, access to this VHost is denied - # If you want to enable the manager APIs, you MUST - # implement a robust authentication scheme to protect this - # VHost since LemonLDAP::NG provides no protection to the - # Manager APIs yet - # - #allow 127.0.0.0/8; - #allow ::1/128; - deny all; } + # By default, access to this VHost is denied + # If you want to enable the manager APIs, you MUST + # implement a robust authentication scheme to protect this + # VHost since LemonLDAP::NG provides no protection to the + # Manager APIs yet + # + #allow 127.0.0.0/8; + #allow ::1/128; + deny all; + # DEBIAN # If install was made with USEDEBIANLIBS (official releases), uncomment this #location /javascript/ { diff --git a/doc/index.html b/doc/index.html index 4b1c93b32..2eeb7c1d1 100644 --- a/doc/index.html +++ b/doc/index.html @@ -5,9 +5,14 @@
-

LemonLDAP::NG offline documentation

+

LemonLDAP::NG Administrator documentation

Documentation
+
+

LemonLDAP::NG Manager API documentation

+
+ API Reference +
diff --git a/doc/pages/manager-api/.swagger-codegen-ignore b/doc/pages/manager-api/.swagger-codegen-ignore new file mode 100644 index 000000000..c5fa491b4 --- /dev/null +++ b/doc/pages/manager-api/.swagger-codegen-ignore @@ -0,0 +1,23 @@ +# Swagger Codegen Ignore +# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/doc/pages/manager-api/.swagger-codegen/VERSION b/doc/pages/manager-api/.swagger-codegen/VERSION new file mode 100644 index 000000000..edd1851a7 --- /dev/null +++ b/doc/pages/manager-api/.swagger-codegen/VERSION @@ -0,0 +1 @@ +3.0.18 \ No newline at end of file diff --git a/doc/pages/manager-api/index.html b/doc/pages/manager-api/index.html new file mode 100644 index 000000000..add620a46 --- /dev/null +++ b/doc/pages/manager-api/index.html @@ -0,0 +1,10265 @@ + + + + + LemonLDAP::NG Manager API + + + + + + + + + + + + + +
+
+ +
+
+
+

LemonLDAP::NG Manager API

+
+
+
+ +
+
+

Class2fa

+
+
+
+

deleteSecondFactors

+

Delete all second factors for a user

+
+
+
+

+

+

+
+ 
/api/v1/secondFactor/{uid}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X DELETE "/api/v1/api/v1/secondFactor/{uid}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.Class2faApi;
+
+import java.io.File;
+import java.util.*;
+
+public class Class2faApiExample {
+
+    public static void main(String[] args) {
+        
+        Class2faApi apiInstance = new Class2faApi();
+        String uid = uid_example; // String | 
+        try {
+            apiInstance.deleteSecondFactors(uid);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling Class2faApi#deleteSecondFactors");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.Class2faApi;
+
+public class Class2faApiExample {
+
+    public static void main(String[] args) {
+        Class2faApi apiInstance = new Class2faApi();
+        String uid = uid_example; // String | 
+        try {
+            apiInstance.deleteSecondFactors(uid);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling Class2faApi#deleteSecondFactors");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
String *uid = uid_example; // 
+
+Class2faApi *apiInstance = [[Class2faApi alloc] init];
+
+// Delete all second factors for a user
+[apiInstance deleteSecondFactorsWith:uid
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.Class2faApi()
+var uid = uid_example; // {{String}} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.deleteSecondFactors(uid, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class deleteSecondFactorsExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new Class2faApi();
+            var uid = uid_example;  // String | 
+
+            try
+            {
+                // Delete all second factors for a user
+                apiInstance.deleteSecondFactors(uid);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling Class2faApi.deleteSecondFactors: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiClass2faApi();
+$uid = uid_example; // String | 
+
+try {
+    $api_instance->deleteSecondFactors($uid);
+} catch (Exception $e) {
+    echo 'Exception when calling Class2faApi->deleteSecondFactors: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::Class2faApi;
+
+my $api_instance = WWW::SwaggerClient::Class2faApi->new();
+my $uid = uid_example; # String | 
+
+eval { 
+    $api_instance->deleteSecondFactors(uid => $uid);
+};
+if ($@) {
+    warn "Exception when calling Class2faApi->deleteSecondFactors: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.Class2faApi()
+uid = uid_example # String | 
+
+try: 
+    # Delete all second factors for a user
+    api_instance.delete_second_factors(uid)
+except ApiException as e:
+    print("Exception when calling Class2faApi->deleteSecondFactors: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + +
NameDescription
uid* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 204 - Successful modification

+ +
    +
+ +
+
+ +

Status: 404 - The specified resource was not found

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+
+

deleteSecondFactorsById

+

Delete a second factors for a user

+
+
+
+

+

+

+
+ 
/api/v1/secondFactor/{uid}/id/{id}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X DELETE "/api/v1/api/v1/secondFactor/{uid}/id/{id}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.Class2faApi;
+
+import java.io.File;
+import java.util.*;
+
+public class Class2faApiExample {
+
+    public static void main(String[] args) {
+        
+        Class2faApi apiInstance = new Class2faApi();
+        String uid = uid_example; // String | 
+        String id = id_example; // String | 
+        try {
+            apiInstance.deleteSecondFactorsById(uid, id);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling Class2faApi#deleteSecondFactorsById");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.Class2faApi;
+
+public class Class2faApiExample {
+
+    public static void main(String[] args) {
+        Class2faApi apiInstance = new Class2faApi();
+        String uid = uid_example; // String | 
+        String id = id_example; // String | 
+        try {
+            apiInstance.deleteSecondFactorsById(uid, id);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling Class2faApi#deleteSecondFactorsById");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
String *uid = uid_example; // 
+String *id = id_example; // 
+
+Class2faApi *apiInstance = [[Class2faApi alloc] init];
+
+// Delete a second factors for a user
+[apiInstance deleteSecondFactorsByIdWith:uid
+    id:id
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.Class2faApi()
+var uid = uid_example; // {{String}} 
+var id = id_example; // {{String}} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.deleteSecondFactorsById(uid, id, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class deleteSecondFactorsByIdExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new Class2faApi();
+            var uid = uid_example;  // String | 
+            var id = id_example;  // String | 
+
+            try
+            {
+                // Delete a second factors for a user
+                apiInstance.deleteSecondFactorsById(uid, id);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling Class2faApi.deleteSecondFactorsById: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiClass2faApi();
+$uid = uid_example; // String | 
+$id = id_example; // String | 
+
+try {
+    $api_instance->deleteSecondFactorsById($uid, $id);
+} catch (Exception $e) {
+    echo 'Exception when calling Class2faApi->deleteSecondFactorsById: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::Class2faApi;
+
+my $api_instance = WWW::SwaggerClient::Class2faApi->new();
+my $uid = uid_example; # String | 
+my $id = id_example; # String | 
+
+eval { 
+    $api_instance->deleteSecondFactorsById(uid => $uid, id => $id);
+};
+if ($@) {
+    warn "Exception when calling Class2faApi->deleteSecondFactorsById: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.Class2faApi()
+uid = uid_example # String | 
+id = id_example # String | 
+
+try: 
+    # Delete a second factors for a user
+    api_instance.delete_second_factors_by_id(uid, id)
+except ApiException as e:
+    print("Exception when calling Class2faApi->deleteSecondFactorsById: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + + + +
NameDescription
uid* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
id* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 204 - Successful modification

+ +
    +
+ +
+
+ +

Status: 404 - The specified resource was not found

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+
+

deleteSecondFactorsByType

+

Delete all second factors of a given type for a user

+
+
+
+

+

+

+
+ 
/api/v1/secondFactor/{uid}/type/{type}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X DELETE "/api/v1/api/v1/secondFactor/{uid}/type/{type}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.Class2faApi;
+
+import java.io.File;
+import java.util.*;
+
+public class Class2faApiExample {
+
+    public static void main(String[] args) {
+        
+        Class2faApi apiInstance = new Class2faApi();
+        String uid = uid_example; // String | 
+        String type = type_example; // String | 
+        try {
+            apiInstance.deleteSecondFactorsByType(uid, type);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling Class2faApi#deleteSecondFactorsByType");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.Class2faApi;
+
+public class Class2faApiExample {
+
+    public static void main(String[] args) {
+        Class2faApi apiInstance = new Class2faApi();
+        String uid = uid_example; // String | 
+        String type = type_example; // String | 
+        try {
+            apiInstance.deleteSecondFactorsByType(uid, type);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling Class2faApi#deleteSecondFactorsByType");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
String *uid = uid_example; // 
+String *type = type_example; // 
+
+Class2faApi *apiInstance = [[Class2faApi alloc] init];
+
+// Delete all second factors of a given type for a user
+[apiInstance deleteSecondFactorsByTypeWith:uid
+    type:type
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.Class2faApi()
+var uid = uid_example; // {{String}} 
+var type = type_example; // {{String}} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.deleteSecondFactorsByType(uid, type, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class deleteSecondFactorsByTypeExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new Class2faApi();
+            var uid = uid_example;  // String | 
+            var type = type_example;  // String | 
+
+            try
+            {
+                // Delete all second factors of a given type for a user
+                apiInstance.deleteSecondFactorsByType(uid, type);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling Class2faApi.deleteSecondFactorsByType: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiClass2faApi();
+$uid = uid_example; // String | 
+$type = type_example; // String | 
+
+try {
+    $api_instance->deleteSecondFactorsByType($uid, $type);
+} catch (Exception $e) {
+    echo 'Exception when calling Class2faApi->deleteSecondFactorsByType: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::Class2faApi;
+
+my $api_instance = WWW::SwaggerClient::Class2faApi->new();
+my $uid = uid_example; # String | 
+my $type = type_example; # String | 
+
+eval { 
+    $api_instance->deleteSecondFactorsByType(uid => $uid, type => $type);
+};
+if ($@) {
+    warn "Exception when calling Class2faApi->deleteSecondFactorsByType: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.Class2faApi()
+uid = uid_example # String | 
+type = type_example # String | 
+
+try: 
+    # Delete all second factors of a given type for a user
+    api_instance.delete_second_factors_by_type(uid, type)
+except ApiException as e:
+    print("Exception when calling Class2faApi->deleteSecondFactorsByType: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + + + +
NameDescription
uid* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
type* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 204 - Successful modification

+ +
    +
+ +
+
+ +

Status: 404 - The specified resource was not found

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+
+

getSecondFactors

+

List second factors for a user

+
+
+
+

+

+

+
+ 
/api/v1/secondFactor/{uid}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET "/api/v1/api/v1/secondFactor/{uid}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.Class2faApi;
+
+import java.io.File;
+import java.util.*;
+
+public class Class2faApiExample {
+
+    public static void main(String[] args) {
+        
+        Class2faApi apiInstance = new Class2faApi();
+        String uid = uid_example; // String | 
+        try {
+            SecondFactors result = apiInstance.getSecondFactors(uid);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling Class2faApi#getSecondFactors");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.Class2faApi;
+
+public class Class2faApiExample {
+
+    public static void main(String[] args) {
+        Class2faApi apiInstance = new Class2faApi();
+        String uid = uid_example; // String | 
+        try {
+            SecondFactors result = apiInstance.getSecondFactors(uid);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling Class2faApi#getSecondFactors");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
String *uid = uid_example; // 
+
+Class2faApi *apiInstance = [[Class2faApi alloc] init];
+
+// List second factors for a user
+[apiInstance getSecondFactorsWith:uid
+              completionHandler: ^(SecondFactors output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.Class2faApi()
+var uid = uid_example; // {{String}} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getSecondFactors(uid, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class getSecondFactorsExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new Class2faApi();
+            var uid = uid_example;  // String | 
+
+            try
+            {
+                // List second factors for a user
+                SecondFactors result = apiInstance.getSecondFactors(uid);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling Class2faApi.getSecondFactors: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiClass2faApi();
+$uid = uid_example; // String | 
+
+try {
+    $result = $api_instance->getSecondFactors($uid);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling Class2faApi->getSecondFactors: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::Class2faApi;
+
+my $api_instance = WWW::SwaggerClient::Class2faApi->new();
+my $uid = uid_example; # String | 
+
+eval { 
+    my $result = $api_instance->getSecondFactors(uid => $uid);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling Class2faApi->getSecondFactors: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.Class2faApi()
+uid = uid_example # String | 
+
+try: 
+    # List second factors for a user
+    api_response = api_instance.get_second_factors(uid)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling Class2faApi->getSecondFactors: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + +
NameDescription
uid* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 200 - Return a list of second factors

+ + + +
+
+
+ +
+ +
+
+ +

Status: 404 - The specified resource was not found

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+
+

getSecondFactorsById

+

Get second factors for a user given its ID

+
+
+
+

+

+

+
+ 
/api/v1/secondFactor/{uid}/id/{id}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET "/api/v1/api/v1/secondFactor/{uid}/id/{id}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.Class2faApi;
+
+import java.io.File;
+import java.util.*;
+
+public class Class2faApiExample {
+
+    public static void main(String[] args) {
+        
+        Class2faApi apiInstance = new Class2faApi();
+        String uid = uid_example; // String | 
+        String id = id_example; // String | 
+        try {
+            SecondFactors result = apiInstance.getSecondFactorsById(uid, id);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling Class2faApi#getSecondFactorsById");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.Class2faApi;
+
+public class Class2faApiExample {
+
+    public static void main(String[] args) {
+        Class2faApi apiInstance = new Class2faApi();
+        String uid = uid_example; // String | 
+        String id = id_example; // String | 
+        try {
+            SecondFactors result = apiInstance.getSecondFactorsById(uid, id);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling Class2faApi#getSecondFactorsById");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
String *uid = uid_example; // 
+String *id = id_example; // 
+
+Class2faApi *apiInstance = [[Class2faApi alloc] init];
+
+// Get second factors for a user given its ID
+[apiInstance getSecondFactorsByIdWith:uid
+    id:id
+              completionHandler: ^(SecondFactors output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.Class2faApi()
+var uid = uid_example; // {{String}} 
+var id = id_example; // {{String}} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getSecondFactorsById(uid, id, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class getSecondFactorsByIdExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new Class2faApi();
+            var uid = uid_example;  // String | 
+            var id = id_example;  // String | 
+
+            try
+            {
+                // Get second factors for a user given its ID
+                SecondFactors result = apiInstance.getSecondFactorsById(uid, id);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling Class2faApi.getSecondFactorsById: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiClass2faApi();
+$uid = uid_example; // String | 
+$id = id_example; // String | 
+
+try {
+    $result = $api_instance->getSecondFactorsById($uid, $id);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling Class2faApi->getSecondFactorsById: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::Class2faApi;
+
+my $api_instance = WWW::SwaggerClient::Class2faApi->new();
+my $uid = uid_example; # String | 
+my $id = id_example; # String | 
+
+eval { 
+    my $result = $api_instance->getSecondFactorsById(uid => $uid, id => $id);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling Class2faApi->getSecondFactorsById: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.Class2faApi()
+uid = uid_example # String | 
+id = id_example # String | 
+
+try: 
+    # Get second factors for a user given its ID
+    api_response = api_instance.get_second_factors_by_id(uid, id)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling Class2faApi->getSecondFactorsById: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + + + +
NameDescription
uid* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
id* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 200 - Return a list of second factors

+ + + +
+
+
+ +
+ +
+
+ +

Status: 404 - The specified resource was not found

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+
+

getSecondFactorsByType

+

List second factors for a user given its type

+
+
+
+

+

+

+
+ 
/api/v1/secondFactor/{uid}/type/{type}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET "/api/v1/api/v1/secondFactor/{uid}/type/{type}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.Class2faApi;
+
+import java.io.File;
+import java.util.*;
+
+public class Class2faApiExample {
+
+    public static void main(String[] args) {
+        
+        Class2faApi apiInstance = new Class2faApi();
+        String uid = uid_example; // String | 
+        String type = type_example; // String | 
+        try {
+            SecondFactors result = apiInstance.getSecondFactorsByType(uid, type);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling Class2faApi#getSecondFactorsByType");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.Class2faApi;
+
+public class Class2faApiExample {
+
+    public static void main(String[] args) {
+        Class2faApi apiInstance = new Class2faApi();
+        String uid = uid_example; // String | 
+        String type = type_example; // String | 
+        try {
+            SecondFactors result = apiInstance.getSecondFactorsByType(uid, type);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling Class2faApi#getSecondFactorsByType");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
String *uid = uid_example; // 
+String *type = type_example; // 
+
+Class2faApi *apiInstance = [[Class2faApi alloc] init];
+
+// List second factors for a user given its type
+[apiInstance getSecondFactorsByTypeWith:uid
+    type:type
+              completionHandler: ^(SecondFactors output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.Class2faApi()
+var uid = uid_example; // {{String}} 
+var type = type_example; // {{String}} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getSecondFactorsByType(uid, type, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class getSecondFactorsByTypeExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new Class2faApi();
+            var uid = uid_example;  // String | 
+            var type = type_example;  // String | 
+
+            try
+            {
+                // List second factors for a user given its type
+                SecondFactors result = apiInstance.getSecondFactorsByType(uid, type);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling Class2faApi.getSecondFactorsByType: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiClass2faApi();
+$uid = uid_example; // String | 
+$type = type_example; // String | 
+
+try {
+    $result = $api_instance->getSecondFactorsByType($uid, $type);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling Class2faApi->getSecondFactorsByType: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::Class2faApi;
+
+my $api_instance = WWW::SwaggerClient::Class2faApi->new();
+my $uid = uid_example; # String | 
+my $type = type_example; # String | 
+
+eval { 
+    my $result = $api_instance->getSecondFactorsByType(uid => $uid, type => $type);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling Class2faApi->getSecondFactorsByType: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.Class2faApi()
+uid = uid_example # String | 
+type = type_example # String | 
+
+try: 
+    # List second factors for a user given its type
+    api_response = api_instance.get_second_factors_by_type(uid, type)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling Class2faApi->getSecondFactorsByType: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + + + +
NameDescription
uid* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
type* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 200 - Return a list of second factors

+ + + +
+
+
+ +
+ +
+
+ +

Status: 404 - The specified resource was not found

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+

Oidcrp

+
+
+
+

addoidcrp

+

Create a new OpenID Connect Relaying Party

+
+
+
+

+

+

+
+ 
/api/v1/providers/oidc/rp
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X POST "/api/v1/api/v1/providers/oidc/rp"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.OidcrpApi;
+
+import java.io.File;
+import java.util.*;
+
+public class OidcrpApiExample {
+
+    public static void main(String[] args) {
+        
+        OidcrpApi apiInstance = new OidcrpApi();
+        OidcRp body = ; // OidcRp | OpenID Connect Relaying Party to add
+        try {
+            apiInstance.addoidcrp(body);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling OidcrpApi#addoidcrp");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.OidcrpApi;
+
+public class OidcrpApiExample {
+
+    public static void main(String[] args) {
+        OidcrpApi apiInstance = new OidcrpApi();
+        OidcRp body = ; // OidcRp | OpenID Connect Relaying Party to add
+        try {
+            apiInstance.addoidcrp(body);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling OidcrpApi#addoidcrp");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
OidcRp *body = ; // OpenID Connect Relaying Party to add
+
+OidcrpApi *apiInstance = [[OidcrpApi alloc] init];
+
+// Create a new OpenID Connect Relaying Party
+[apiInstance addoidcrpWith:body
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.OidcrpApi()
+var body = ; // {{OidcRp}} OpenID Connect Relaying Party to add
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.addoidcrp(body, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class addoidcrpExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new OidcrpApi();
+            var body = new OidcRp(); // OidcRp | OpenID Connect Relaying Party to add
+
+            try
+            {
+                // Create a new OpenID Connect Relaying Party
+                apiInstance.addoidcrp(body);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling OidcrpApi.addoidcrp: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiOidcrpApi();
+$body = ; // OidcRp | OpenID Connect Relaying Party to add
+
+try {
+    $api_instance->addoidcrp($body);
+} catch (Exception $e) {
+    echo 'Exception when calling OidcrpApi->addoidcrp: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::OidcrpApi;
+
+my $api_instance = WWW::SwaggerClient::OidcrpApi->new();
+my $body = WWW::SwaggerClient::Object::OidcRp->new(); # OidcRp | OpenID Connect Relaying Party to add
+
+eval { 
+    $api_instance->addoidcrp(body => $body);
+};
+if ($@) {
+    warn "Exception when calling OidcrpApi->addoidcrp: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.OidcrpApi()
+body =  # OidcRp | OpenID Connect Relaying Party to add
+
+try: 
+    # Create a new OpenID Connect Relaying Party
+    api_instance.addoidcrp(body)
+except ApiException as e:
+    print("Exception when calling OidcrpApi->addoidcrp: %s\n" % e)
+
+
+ +

Parameters

+ + + +
Body parameters
+ + + + + + + + +
NameDescription
body * + + + +
+
+ + + +

Responses

+

Status: 201 - Successful creation

+ +
    +
+ +
+
+ +

Status: 400 - An error was encountered when processing the request

+ + + +
+
+
+ +
+ +
+
+ +

Status: 409 - The specified object could not be created because its configuration key, client_id or entityID already exists

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+
+

deleteOidcRp

+

Deletes a OpenID Connect Relaying Party

+
+
+
+

+

+

+
+ 
/api/v1/providers/oidc/rp/{confKey}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X DELETE "/api/v1/api/v1/providers/oidc/rp/{confKey}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.OidcrpApi;
+
+import java.io.File;
+import java.util.*;
+
+public class OidcrpApiExample {
+
+    public static void main(String[] args) {
+        
+        OidcrpApi apiInstance = new OidcrpApi();
+        confKey confKey = ; // confKey | Configuration key of OpenID Connect Relaying Party to delete
+        try {
+            apiInstance.deleteOidcRp(confKey);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling OidcrpApi#deleteOidcRp");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.OidcrpApi;
+
+public class OidcrpApiExample {
+
+    public static void main(String[] args) {
+        OidcrpApi apiInstance = new OidcrpApi();
+        confKey confKey = ; // confKey | Configuration key of OpenID Connect Relaying Party to delete
+        try {
+            apiInstance.deleteOidcRp(confKey);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling OidcrpApi#deleteOidcRp");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
confKey *confKey = ; // Configuration key of OpenID Connect Relaying Party to delete
+
+OidcrpApi *apiInstance = [[OidcrpApi alloc] init];
+
+// Deletes a OpenID Connect Relaying Party
+[apiInstance deleteOidcRpWith:confKey
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.OidcrpApi()
+var confKey = ; // {{confKey}} Configuration key of OpenID Connect Relaying Party to delete
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.deleteOidcRp(confKey, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class deleteOidcRpExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new OidcrpApi();
+            var confKey = new confKey(); // confKey | Configuration key of OpenID Connect Relaying Party to delete
+
+            try
+            {
+                // Deletes a OpenID Connect Relaying Party
+                apiInstance.deleteOidcRp(confKey);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling OidcrpApi.deleteOidcRp: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiOidcrpApi();
+$confKey = ; // confKey | Configuration key of OpenID Connect Relaying Party to delete
+
+try {
+    $api_instance->deleteOidcRp($confKey);
+} catch (Exception $e) {
+    echo 'Exception when calling OidcrpApi->deleteOidcRp: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::OidcrpApi;
+
+my $api_instance = WWW::SwaggerClient::OidcrpApi->new();
+my $confKey = ; # confKey | Configuration key of OpenID Connect Relaying Party to delete
+
+eval { 
+    $api_instance->deleteOidcRp(confKey => $confKey);
+};
+if ($@) {
+    warn "Exception when calling OidcrpApi->deleteOidcRp: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.OidcrpApi()
+confKey =  # confKey | Configuration key of OpenID Connect Relaying Party to delete
+
+try: 
+    # Deletes a OpenID Connect Relaying Party
+    api_instance.delete_oidc_rp(confKey)
+except ApiException as e:
+    print("Exception when calling OidcrpApi->deleteOidcRp: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + +
NameDescription
confKey* + + +
+
+
+ + confKey + + +
+ Configuration key of OpenID Connect Relaying Party to delete +
+
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 204 - Successful modification

+ +
    +
+ +
+
+ +

Status: 400 - An error was encountered when processing the request

+ + + +
+
+
+ +
+ +
+
+ +

Status: 404 - The specified resource was not found

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+
+

findOidcRpByClientId

+

Finds OpenID Connect Relaying Party by Client ID

+
+
+
+

+

+

+
+ 
/api/v1/providers/oidc/rp/findByClientId
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET "/api/v1/api/v1/providers/oidc/rp/findByClientId?clientId="
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.OidcrpApi;
+
+import java.io.File;
+import java.util.*;
+
+public class OidcrpApiExample {
+
+    public static void main(String[] args) {
+        
+        OidcrpApi apiInstance = new OidcrpApi();
+        String clientId = clientId_example; // String | Client ID to search
+        try {
+            OidcRp result = apiInstance.findOidcRpByClientId(clientId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling OidcrpApi#findOidcRpByClientId");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.OidcrpApi;
+
+public class OidcrpApiExample {
+
+    public static void main(String[] args) {
+        OidcrpApi apiInstance = new OidcrpApi();
+        String clientId = clientId_example; // String | Client ID to search
+        try {
+            OidcRp result = apiInstance.findOidcRpByClientId(clientId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling OidcrpApi#findOidcRpByClientId");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
String *clientId = clientId_example; // Client ID to search
+
+OidcrpApi *apiInstance = [[OidcrpApi alloc] init];
+
+// Finds OpenID Connect Relaying Party by Client ID
+[apiInstance findOidcRpByClientIdWith:clientId
+              completionHandler: ^(OidcRp output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.OidcrpApi()
+var clientId = clientId_example; // {{String}} Client ID to search
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.findOidcRpByClientId(clientId, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class findOidcRpByClientIdExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new OidcrpApi();
+            var clientId = clientId_example;  // String | Client ID to search
+
+            try
+            {
+                // Finds OpenID Connect Relaying Party by Client ID
+                OidcRp result = apiInstance.findOidcRpByClientId(clientId);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling OidcrpApi.findOidcRpByClientId: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiOidcrpApi();
+$clientId = clientId_example; // String | Client ID to search
+
+try {
+    $result = $api_instance->findOidcRpByClientId($clientId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling OidcrpApi->findOidcRpByClientId: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::OidcrpApi;
+
+my $api_instance = WWW::SwaggerClient::OidcrpApi->new();
+my $clientId = clientId_example; # String | Client ID to search
+
+eval { 
+    my $result = $api_instance->findOidcRpByClientId(clientId => $clientId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling OidcrpApi->findOidcRpByClientId: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.OidcrpApi()
+clientId = clientId_example # String | Client ID to search
+
+try: 
+    # Finds OpenID Connect Relaying Party by Client ID
+    api_response = api_instance.find_oidc_rp_by_client_id(clientId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling OidcrpApi->findOidcRpByClientId: %s\n" % e)
+
+
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + +
NameDescription
clientId* + + +
+
+
+ + String + + +
+ Client ID to search +
+
+
+ Required +
+
+
+
+ +

Responses

+

Status: 200 - Return an OpenID Connect Provider

+ + + +
+
+
+ +
+ +
+
+ +

Status: 400 - An error was encountered when processing the request

+ + + +
+
+
+ +
+ +
+
+ +

Status: 404 - The specified resource was not found

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+
+

findOidcRpByConfKey

+

Finds OpenID Connect Relaying Partys by configuration key

+
+
+
+

+

Takes a search pattern to be tested against existing service providers

+

+
+ 
/api/v1/providers/oidc/rp/findByConfKey
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET "/api/v1/api/v1/providers/oidc/rp/findByConfKey?pattern="
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.OidcrpApi;
+
+import java.io.File;
+import java.util.*;
+
+public class OidcrpApiExample {
+
+    public static void main(String[] args) {
+        
+        OidcrpApi apiInstance = new OidcrpApi();
+        confKey pattern = ; // confKey | Search pattern
+        try {
+            array[OidcRp] result = apiInstance.findOidcRpByConfKey(pattern);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling OidcrpApi#findOidcRpByConfKey");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.OidcrpApi;
+
+public class OidcrpApiExample {
+
+    public static void main(String[] args) {
+        OidcrpApi apiInstance = new OidcrpApi();
+        confKey pattern = ; // confKey | Search pattern
+        try {
+            array[OidcRp] result = apiInstance.findOidcRpByConfKey(pattern);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling OidcrpApi#findOidcRpByConfKey");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
confKey *pattern = ; // Search pattern
+
+OidcrpApi *apiInstance = [[OidcrpApi alloc] init];
+
+// Finds OpenID Connect Relaying Partys by configuration key
+[apiInstance findOidcRpByConfKeyWith:pattern
+              completionHandler: ^(array[OidcRp] output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.OidcrpApi()
+var pattern = ; // {{confKey}} Search pattern
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.findOidcRpByConfKey(pattern, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class findOidcRpByConfKeyExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new OidcrpApi();
+            var pattern = new confKey(); // confKey | Search pattern
+
+            try
+            {
+                // Finds OpenID Connect Relaying Partys by configuration key
+                array[OidcRp] result = apiInstance.findOidcRpByConfKey(pattern);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling OidcrpApi.findOidcRpByConfKey: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiOidcrpApi();
+$pattern = ; // confKey | Search pattern
+
+try {
+    $result = $api_instance->findOidcRpByConfKey($pattern);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling OidcrpApi->findOidcRpByConfKey: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::OidcrpApi;
+
+my $api_instance = WWW::SwaggerClient::OidcrpApi->new();
+my $pattern = ; # confKey | Search pattern
+
+eval { 
+    my $result = $api_instance->findOidcRpByConfKey(pattern => $pattern);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling OidcrpApi->findOidcRpByConfKey: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.OidcrpApi()
+pattern =  # confKey | Search pattern
+
+try: 
+    # Finds OpenID Connect Relaying Partys by configuration key
+    api_response = api_instance.find_oidc_rp_by_conf_key(pattern)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling OidcrpApi->findOidcRpByConfKey: %s\n" % e)
+
+
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + +
NameDescription
pattern* + + +
+
+
+ + confKey + + +
+ Search pattern +
+
+
+ Required +
+
+
+
+ +

Responses

+

Status: 200 - Return a list of OpenID Connect Providers

+ + + +
+
+
+ +
+ +
+
+ +

Status: 400 - An error was encountered when processing the request

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+
+

getOidcRpByConfKey

+

Get OpenID Connect Relaying Party by configuration key

+
+
+
+

+

Returns a single Service Provider

+

+
+ 
/api/v1/providers/oidc/rp/{confKey}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET "/api/v1/api/v1/providers/oidc/rp/{confKey}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.OidcrpApi;
+
+import java.io.File;
+import java.util.*;
+
+public class OidcrpApiExample {
+
+    public static void main(String[] args) {
+        
+        OidcrpApi apiInstance = new OidcrpApi();
+        confKey confKey = ; // confKey | Configuration key of OpenID Connect Relaying Party
+        try {
+            OidcRp result = apiInstance.getOidcRpByConfKey(confKey);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling OidcrpApi#getOidcRpByConfKey");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.OidcrpApi;
+
+public class OidcrpApiExample {
+
+    public static void main(String[] args) {
+        OidcrpApi apiInstance = new OidcrpApi();
+        confKey confKey = ; // confKey | Configuration key of OpenID Connect Relaying Party
+        try {
+            OidcRp result = apiInstance.getOidcRpByConfKey(confKey);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling OidcrpApi#getOidcRpByConfKey");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
confKey *confKey = ; // Configuration key of OpenID Connect Relaying Party
+
+OidcrpApi *apiInstance = [[OidcrpApi alloc] init];
+
+// Get OpenID Connect Relaying Party by configuration key
+[apiInstance getOidcRpByConfKeyWith:confKey
+              completionHandler: ^(OidcRp output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.OidcrpApi()
+var confKey = ; // {{confKey}} Configuration key of OpenID Connect Relaying Party
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getOidcRpByConfKey(confKey, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class getOidcRpByConfKeyExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new OidcrpApi();
+            var confKey = new confKey(); // confKey | Configuration key of OpenID Connect Relaying Party
+
+            try
+            {
+                // Get OpenID Connect Relaying Party by configuration key
+                OidcRp result = apiInstance.getOidcRpByConfKey(confKey);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling OidcrpApi.getOidcRpByConfKey: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiOidcrpApi();
+$confKey = ; // confKey | Configuration key of OpenID Connect Relaying Party
+
+try {
+    $result = $api_instance->getOidcRpByConfKey($confKey);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling OidcrpApi->getOidcRpByConfKey: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::OidcrpApi;
+
+my $api_instance = WWW::SwaggerClient::OidcrpApi->new();
+my $confKey = ; # confKey | Configuration key of OpenID Connect Relaying Party
+
+eval { 
+    my $result = $api_instance->getOidcRpByConfKey(confKey => $confKey);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling OidcrpApi->getOidcRpByConfKey: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.OidcrpApi()
+confKey =  # confKey | Configuration key of OpenID Connect Relaying Party
+
+try: 
+    # Get OpenID Connect Relaying Party by configuration key
+    api_response = api_instance.get_oidc_rp_by_conf_key(confKey)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling OidcrpApi->getOidcRpByConfKey: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + +
NameDescription
confKey* + + +
+
+
+ + confKey + + +
+ Configuration key of OpenID Connect Relaying Party +
+
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 200 - Return an OpenID Connect Provider

+ + + +
+
+
+ +
+ +
+
+ +

Status: 400 - An error was encountered when processing the request

+ + + +
+
+
+ +
+ +
+
+ +

Status: 404 - The specified resource was not found

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+
+

replaceOidcRp

+

Replaces an OpenID Connect Relaying Party

+
+
+
+

+

+

+
+ 
/api/v1/providers/oidc/rp/{confKey}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X PUT "/api/v1/api/v1/providers/oidc/rp/{confKey}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.OidcrpApi;
+
+import java.io.File;
+import java.util.*;
+
+public class OidcrpApiExample {
+
+    public static void main(String[] args) {
+        
+        OidcrpApi apiInstance = new OidcrpApi();
+        confKey confKey = ; // confKey | Configuration key of OpenID Connect Relaying Party that needs to be replaced
+        OidcRp body = ; // OidcRp | 
+        try {
+            apiInstance.replaceOidcRp(confKey, body);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling OidcrpApi#replaceOidcRp");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.OidcrpApi;
+
+public class OidcrpApiExample {
+
+    public static void main(String[] args) {
+        OidcrpApi apiInstance = new OidcrpApi();
+        confKey confKey = ; // confKey | Configuration key of OpenID Connect Relaying Party that needs to be replaced
+        OidcRp body = ; // OidcRp | 
+        try {
+            apiInstance.replaceOidcRp(confKey, body);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling OidcrpApi#replaceOidcRp");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
confKey *confKey = ; // Configuration key of OpenID Connect Relaying Party that needs to be replaced
+OidcRp *body = ; //  (optional)
+
+OidcrpApi *apiInstance = [[OidcrpApi alloc] init];
+
+// Replaces an OpenID Connect Relaying Party
+[apiInstance replaceOidcRpWith:confKey
+    body:body
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.OidcrpApi()
+var confKey = ; // {{confKey}} Configuration key of OpenID Connect Relaying Party that needs to be replaced
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.replaceOidcRp(confKey, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class replaceOidcRpExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new OidcrpApi();
+            var confKey = new confKey(); // confKey | Configuration key of OpenID Connect Relaying Party that needs to be replaced
+            var body = new OidcRp(); // OidcRp |  (optional) 
+
+            try
+            {
+                // Replaces an OpenID Connect Relaying Party
+                apiInstance.replaceOidcRp(confKey, body);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling OidcrpApi.replaceOidcRp: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiOidcrpApi();
+$confKey = ; // confKey | Configuration key of OpenID Connect Relaying Party that needs to be replaced
+$body = ; // OidcRp | 
+
+try {
+    $api_instance->replaceOidcRp($confKey, $body);
+} catch (Exception $e) {
+    echo 'Exception when calling OidcrpApi->replaceOidcRp: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::OidcrpApi;
+
+my $api_instance = WWW::SwaggerClient::OidcrpApi->new();
+my $confKey = ; # confKey | Configuration key of OpenID Connect Relaying Party that needs to be replaced
+my $body = WWW::SwaggerClient::Object::OidcRp->new(); # OidcRp | 
+
+eval { 
+    $api_instance->replaceOidcRp(confKey => $confKey, body => $body);
+};
+if ($@) {
+    warn "Exception when calling OidcrpApi->replaceOidcRp: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.OidcrpApi()
+confKey =  # confKey | Configuration key of OpenID Connect Relaying Party that needs to be replaced
+body =  # OidcRp |  (optional)
+
+try: 
+    # Replaces an OpenID Connect Relaying Party
+    api_instance.replace_oidc_rp(confKey, body=body)
+except ApiException as e:
+    print("Exception when calling OidcrpApi->replaceOidcRp: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + +
NameDescription
confKey* + + +
+
+
+ + confKey + + +
+ Configuration key of OpenID Connect Relaying Party that needs to be replaced +
+
+
+ Required +
+
+
+
+ + +
Body parameters
+ + + + + + + + +
NameDescription
body + + + +
+
+ + + +

Responses

+

Status: 204 - Successful modification

+ +
    +
+ +
+
+ +

Status: 400 - An error was encountered when processing the request

+ + + +
+
+
+ +
+ +
+
+ +

Status: 404 - The specified resource was not found

+ + + +
+
+
+ +
+ +
+
+ +

Status: 409 - The specified object could not be created because its configuration key, client_id or entityID already exists

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+
+

updateOidcRp

+

Updates an OpenID Connect Relaying Party

+
+
+
+

+

+

+
+ 
/api/v1/providers/oidc/rp/{confKey}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X PATCH "/api/v1/api/v1/providers/oidc/rp/{confKey}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.OidcrpApi;
+
+import java.io.File;
+import java.util.*;
+
+public class OidcrpApiExample {
+
+    public static void main(String[] args) {
+        
+        OidcrpApi apiInstance = new OidcrpApi();
+        confKey confKey = ; // confKey | Configuration key of OpenID Connect Relaying Party that needs to be updated
+        OidcRpUpdate body = ; // OidcRpUpdate | 
+        try {
+            apiInstance.updateOidcRp(confKey, body);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling OidcrpApi#updateOidcRp");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.OidcrpApi;
+
+public class OidcrpApiExample {
+
+    public static void main(String[] args) {
+        OidcrpApi apiInstance = new OidcrpApi();
+        confKey confKey = ; // confKey | Configuration key of OpenID Connect Relaying Party that needs to be updated
+        OidcRpUpdate body = ; // OidcRpUpdate | 
+        try {
+            apiInstance.updateOidcRp(confKey, body);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling OidcrpApi#updateOidcRp");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
confKey *confKey = ; // Configuration key of OpenID Connect Relaying Party that needs to be updated
+OidcRpUpdate *body = ; //  (optional)
+
+OidcrpApi *apiInstance = [[OidcrpApi alloc] init];
+
+// Updates an OpenID Connect Relaying Party
+[apiInstance updateOidcRpWith:confKey
+    body:body
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.OidcrpApi()
+var confKey = ; // {{confKey}} Configuration key of OpenID Connect Relaying Party that needs to be updated
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.updateOidcRp(confKey, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class updateOidcRpExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new OidcrpApi();
+            var confKey = new confKey(); // confKey | Configuration key of OpenID Connect Relaying Party that needs to be updated
+            var body = new OidcRpUpdate(); // OidcRpUpdate |  (optional) 
+
+            try
+            {
+                // Updates an OpenID Connect Relaying Party
+                apiInstance.updateOidcRp(confKey, body);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling OidcrpApi.updateOidcRp: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiOidcrpApi();
+$confKey = ; // confKey | Configuration key of OpenID Connect Relaying Party that needs to be updated
+$body = ; // OidcRpUpdate | 
+
+try {
+    $api_instance->updateOidcRp($confKey, $body);
+} catch (Exception $e) {
+    echo 'Exception when calling OidcrpApi->updateOidcRp: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::OidcrpApi;
+
+my $api_instance = WWW::SwaggerClient::OidcrpApi->new();
+my $confKey = ; # confKey | Configuration key of OpenID Connect Relaying Party that needs to be updated
+my $body = WWW::SwaggerClient::Object::OidcRpUpdate->new(); # OidcRpUpdate | 
+
+eval { 
+    $api_instance->updateOidcRp(confKey => $confKey, body => $body);
+};
+if ($@) {
+    warn "Exception when calling OidcrpApi->updateOidcRp: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.OidcrpApi()
+confKey =  # confKey | Configuration key of OpenID Connect Relaying Party that needs to be updated
+body =  # OidcRpUpdate |  (optional)
+
+try: 
+    # Updates an OpenID Connect Relaying Party
+    api_instance.update_oidc_rp(confKey, body=body)
+except ApiException as e:
+    print("Exception when calling OidcrpApi->updateOidcRp: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + +
NameDescription
confKey* + + +
+
+
+ + confKey + + +
+ Configuration key of OpenID Connect Relaying Party that needs to be updated +
+
+
+ Required +
+
+
+
+ + +
Body parameters
+ + + + + + + + +
NameDescription
body + + + +
+
+ + + +

Responses

+

Status: 204 - Successful modification

+ +
    +
+ +
+
+ +

Status: 400 - An error was encountered when processing the request

+ + + +
+
+
+ +
+ +
+
+ +

Status: 404 - The specified resource was not found

+ + + +
+
+
+ +
+ +
+
+ +

Status: 409 - The specified object could not be created because its configuration key, client_id or entityID already exists

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+

Samlsp

+
+
+
+

addsamlsp

+

Create a new SAML Service provider

+
+
+
+

+

+

+
+ 
/api/v1/providers/saml/sp
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X POST "/api/v1/api/v1/providers/saml/sp"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.SamlspApi;
+
+import java.io.File;
+import java.util.*;
+
+public class SamlspApiExample {
+
+    public static void main(String[] args) {
+        
+        SamlspApi apiInstance = new SamlspApi();
+        SamlSp body = ; // SamlSp | SAML Service provider to add
+        try {
+            apiInstance.addsamlsp(body);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling SamlspApi#addsamlsp");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.SamlspApi;
+
+public class SamlspApiExample {
+
+    public static void main(String[] args) {
+        SamlspApi apiInstance = new SamlspApi();
+        SamlSp body = ; // SamlSp | SAML Service provider to add
+        try {
+            apiInstance.addsamlsp(body);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling SamlspApi#addsamlsp");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
SamlSp *body = ; // SAML Service provider to add
+
+SamlspApi *apiInstance = [[SamlspApi alloc] init];
+
+// Create a new SAML Service provider
+[apiInstance addsamlspWith:body
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.SamlspApi()
+var body = ; // {{SamlSp}} SAML Service provider to add
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.addsamlsp(body, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class addsamlspExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new SamlspApi();
+            var body = new SamlSp(); // SamlSp | SAML Service provider to add
+
+            try
+            {
+                // Create a new SAML Service provider
+                apiInstance.addsamlsp(body);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling SamlspApi.addsamlsp: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiSamlspApi();
+$body = ; // SamlSp | SAML Service provider to add
+
+try {
+    $api_instance->addsamlsp($body);
+} catch (Exception $e) {
+    echo 'Exception when calling SamlspApi->addsamlsp: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::SamlspApi;
+
+my $api_instance = WWW::SwaggerClient::SamlspApi->new();
+my $body = WWW::SwaggerClient::Object::SamlSp->new(); # SamlSp | SAML Service provider to add
+
+eval { 
+    $api_instance->addsamlsp(body => $body);
+};
+if ($@) {
+    warn "Exception when calling SamlspApi->addsamlsp: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.SamlspApi()
+body =  # SamlSp | SAML Service provider to add
+
+try: 
+    # Create a new SAML Service provider
+    api_instance.addsamlsp(body)
+except ApiException as e:
+    print("Exception when calling SamlspApi->addsamlsp: %s\n" % e)
+
+
+ +

Parameters

+ + + +
Body parameters
+ + + + + + + + +
NameDescription
body * + + + +
+
+ + + +

Responses

+

Status: 201 - Successful creation

+ +
    +
+ +
+
+ +

Status: 400 - An error was encountered when processing the request

+ + + +
+
+
+ +
+ +
+
+ +

Status: 409 - The specified object could not be created because its configuration key, client_id or entityID already exists

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+
+

deleteSamlSp

+

Deletes a SAML Service Provider

+
+
+
+

+

+

+
+ 
/api/v1/providers/saml/sp/{confKey}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X DELETE "/api/v1/api/v1/providers/saml/sp/{confKey}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.SamlspApi;
+
+import java.io.File;
+import java.util.*;
+
+public class SamlspApiExample {
+
+    public static void main(String[] args) {
+        
+        SamlspApi apiInstance = new SamlspApi();
+        confKey confKey = ; // confKey | Configuration key of SAML Service Provider to delete
+        try {
+            apiInstance.deleteSamlSp(confKey);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling SamlspApi#deleteSamlSp");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.SamlspApi;
+
+public class SamlspApiExample {
+
+    public static void main(String[] args) {
+        SamlspApi apiInstance = new SamlspApi();
+        confKey confKey = ; // confKey | Configuration key of SAML Service Provider to delete
+        try {
+            apiInstance.deleteSamlSp(confKey);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling SamlspApi#deleteSamlSp");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
confKey *confKey = ; // Configuration key of SAML Service Provider to delete
+
+SamlspApi *apiInstance = [[SamlspApi alloc] init];
+
+// Deletes a SAML Service Provider
+[apiInstance deleteSamlSpWith:confKey
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.SamlspApi()
+var confKey = ; // {{confKey}} Configuration key of SAML Service Provider to delete
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.deleteSamlSp(confKey, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class deleteSamlSpExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new SamlspApi();
+            var confKey = new confKey(); // confKey | Configuration key of SAML Service Provider to delete
+
+            try
+            {
+                // Deletes a SAML Service Provider
+                apiInstance.deleteSamlSp(confKey);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling SamlspApi.deleteSamlSp: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiSamlspApi();
+$confKey = ; // confKey | Configuration key of SAML Service Provider to delete
+
+try {
+    $api_instance->deleteSamlSp($confKey);
+} catch (Exception $e) {
+    echo 'Exception when calling SamlspApi->deleteSamlSp: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::SamlspApi;
+
+my $api_instance = WWW::SwaggerClient::SamlspApi->new();
+my $confKey = ; # confKey | Configuration key of SAML Service Provider to delete
+
+eval { 
+    $api_instance->deleteSamlSp(confKey => $confKey);
+};
+if ($@) {
+    warn "Exception when calling SamlspApi->deleteSamlSp: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.SamlspApi()
+confKey =  # confKey | Configuration key of SAML Service Provider to delete
+
+try: 
+    # Deletes a SAML Service Provider
+    api_instance.delete_saml_sp(confKey)
+except ApiException as e:
+    print("Exception when calling SamlspApi->deleteSamlSp: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + +
NameDescription
confKey* + + +
+
+
+ + confKey + + +
+ Configuration key of SAML Service Provider to delete +
+
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 204 - Successful modification

+ +
    +
+ +
+
+ +

Status: 400 - An error was encountered when processing the request

+ + + +
+
+
+ +
+ +
+
+ +

Status: 404 - The specified resource was not found

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+
+

findSamlSpByConfKey

+

Finds SAML Service providers by configuration key

+
+
+
+

+

Takes a search pattern to be tested against existing service providers

+

+
+ 
/api/v1/providers/saml/sp/findByConfKey
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET "/api/v1/api/v1/providers/saml/sp/findByConfKey?pattern="
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.SamlspApi;
+
+import java.io.File;
+import java.util.*;
+
+public class SamlspApiExample {
+
+    public static void main(String[] args) {
+        
+        SamlspApi apiInstance = new SamlspApi();
+        String pattern = pattern_example; // String | Search pattern
+        try {
+            array[SamlSp] result = apiInstance.findSamlSpByConfKey(pattern);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling SamlspApi#findSamlSpByConfKey");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.SamlspApi;
+
+public class SamlspApiExample {
+
+    public static void main(String[] args) {
+        SamlspApi apiInstance = new SamlspApi();
+        String pattern = pattern_example; // String | Search pattern
+        try {
+            array[SamlSp] result = apiInstance.findSamlSpByConfKey(pattern);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling SamlspApi#findSamlSpByConfKey");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
String *pattern = pattern_example; // Search pattern
+
+SamlspApi *apiInstance = [[SamlspApi alloc] init];
+
+// Finds SAML Service providers by configuration key
+[apiInstance findSamlSpByConfKeyWith:pattern
+              completionHandler: ^(array[SamlSp] output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.SamlspApi()
+var pattern = pattern_example; // {{String}} Search pattern
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.findSamlSpByConfKey(pattern, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class findSamlSpByConfKeyExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new SamlspApi();
+            var pattern = pattern_example;  // String | Search pattern
+
+            try
+            {
+                // Finds SAML Service providers by configuration key
+                array[SamlSp] result = apiInstance.findSamlSpByConfKey(pattern);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling SamlspApi.findSamlSpByConfKey: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiSamlspApi();
+$pattern = pattern_example; // String | Search pattern
+
+try {
+    $result = $api_instance->findSamlSpByConfKey($pattern);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling SamlspApi->findSamlSpByConfKey: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::SamlspApi;
+
+my $api_instance = WWW::SwaggerClient::SamlspApi->new();
+my $pattern = pattern_example; # String | Search pattern
+
+eval { 
+    my $result = $api_instance->findSamlSpByConfKey(pattern => $pattern);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling SamlspApi->findSamlSpByConfKey: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.SamlspApi()
+pattern = pattern_example # String | Search pattern
+
+try: 
+    # Finds SAML Service providers by configuration key
+    api_response = api_instance.find_saml_sp_by_conf_key(pattern)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling SamlspApi->findSamlSpByConfKey: %s\n" % e)
+
+
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + +
NameDescription
pattern* + + +
+
+
+ + String + + +
+ Search pattern +
+
+
+ Required +
+
+
+
+ +

Responses

+

Status: 200 - Return a list of SAML Providers

+ + + +
+
+
+ +
+ +
+
+ +

Status: 400 - An error was encountered when processing the request

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+
+

findSamlSpByEntityId

+

Finds SAML Service Provider by Entity ID

+
+
+
+

+

+

+
+ 
/api/v1/providers/saml/sp/findByEntityId
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET "/api/v1/api/v1/providers/saml/sp/findByEntityId?entityId="
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.SamlspApi;
+
+import java.io.File;
+import java.util.*;
+
+public class SamlspApiExample {
+
+    public static void main(String[] args) {
+        
+        SamlspApi apiInstance = new SamlspApi();
+        String entityId = entityId_example; // String | Entity ID to search
+        try {
+            SamlSp result = apiInstance.findSamlSpByEntityId(entityId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling SamlspApi#findSamlSpByEntityId");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.SamlspApi;
+
+public class SamlspApiExample {
+
+    public static void main(String[] args) {
+        SamlspApi apiInstance = new SamlspApi();
+        String entityId = entityId_example; // String | Entity ID to search
+        try {
+            SamlSp result = apiInstance.findSamlSpByEntityId(entityId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling SamlspApi#findSamlSpByEntityId");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
String *entityId = entityId_example; // Entity ID to search
+
+SamlspApi *apiInstance = [[SamlspApi alloc] init];
+
+// Finds SAML Service Provider by Entity ID
+[apiInstance findSamlSpByEntityIdWith:entityId
+              completionHandler: ^(SamlSp output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.SamlspApi()
+var entityId = entityId_example; // {{String}} Entity ID to search
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.findSamlSpByEntityId(entityId, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class findSamlSpByEntityIdExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new SamlspApi();
+            var entityId = entityId_example;  // String | Entity ID to search
+
+            try
+            {
+                // Finds SAML Service Provider by Entity ID
+                SamlSp result = apiInstance.findSamlSpByEntityId(entityId);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling SamlspApi.findSamlSpByEntityId: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiSamlspApi();
+$entityId = entityId_example; // String | Entity ID to search
+
+try {
+    $result = $api_instance->findSamlSpByEntityId($entityId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling SamlspApi->findSamlSpByEntityId: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::SamlspApi;
+
+my $api_instance = WWW::SwaggerClient::SamlspApi->new();
+my $entityId = entityId_example; # String | Entity ID to search
+
+eval { 
+    my $result = $api_instance->findSamlSpByEntityId(entityId => $entityId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling SamlspApi->findSamlSpByEntityId: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.SamlspApi()
+entityId = entityId_example # String | Entity ID to search
+
+try: 
+    # Finds SAML Service Provider by Entity ID
+    api_response = api_instance.find_saml_sp_by_entity_id(entityId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling SamlspApi->findSamlSpByEntityId: %s\n" % e)
+
+
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + +
NameDescription
entityId* + + +
+
+
+ + String + + +
+ Entity ID to search +
+
+
+ Required +
+
+
+
+ +

Responses

+

Status: 200 - Return a SAML Provider

+ + + +
+
+
+ +
+ +
+
+ +

Status: 400 - An error was encountered when processing the request

+ + + +
+
+
+ +
+ +
+
+ +

Status: 404 - The specified resource was not found

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+
+

getSamlSpByConfKey

+

Get SAML Service Provider by configuration key

+
+
+
+

+

Returns a single Service Provider

+

+
+ 
/api/v1/providers/saml/sp/{confKey}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET "/api/v1/api/v1/providers/saml/sp/{confKey}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.SamlspApi;
+
+import java.io.File;
+import java.util.*;
+
+public class SamlspApiExample {
+
+    public static void main(String[] args) {
+        
+        SamlspApi apiInstance = new SamlspApi();
+        confKey confKey = ; // confKey | Configuration key of SAML Service Provider
+        try {
+            SamlSp result = apiInstance.getSamlSpByConfKey(confKey);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling SamlspApi#getSamlSpByConfKey");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.SamlspApi;
+
+public class SamlspApiExample {
+
+    public static void main(String[] args) {
+        SamlspApi apiInstance = new SamlspApi();
+        confKey confKey = ; // confKey | Configuration key of SAML Service Provider
+        try {
+            SamlSp result = apiInstance.getSamlSpByConfKey(confKey);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling SamlspApi#getSamlSpByConfKey");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
confKey *confKey = ; // Configuration key of SAML Service Provider
+
+SamlspApi *apiInstance = [[SamlspApi alloc] init];
+
+// Get SAML Service Provider by configuration key
+[apiInstance getSamlSpByConfKeyWith:confKey
+              completionHandler: ^(SamlSp output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.SamlspApi()
+var confKey = ; // {{confKey}} Configuration key of SAML Service Provider
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getSamlSpByConfKey(confKey, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class getSamlSpByConfKeyExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new SamlspApi();
+            var confKey = new confKey(); // confKey | Configuration key of SAML Service Provider
+
+            try
+            {
+                // Get SAML Service Provider by configuration key
+                SamlSp result = apiInstance.getSamlSpByConfKey(confKey);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling SamlspApi.getSamlSpByConfKey: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiSamlspApi();
+$confKey = ; // confKey | Configuration key of SAML Service Provider
+
+try {
+    $result = $api_instance->getSamlSpByConfKey($confKey);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling SamlspApi->getSamlSpByConfKey: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::SamlspApi;
+
+my $api_instance = WWW::SwaggerClient::SamlspApi->new();
+my $confKey = ; # confKey | Configuration key of SAML Service Provider
+
+eval { 
+    my $result = $api_instance->getSamlSpByConfKey(confKey => $confKey);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling SamlspApi->getSamlSpByConfKey: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.SamlspApi()
+confKey =  # confKey | Configuration key of SAML Service Provider
+
+try: 
+    # Get SAML Service Provider by configuration key
+    api_response = api_instance.get_saml_sp_by_conf_key(confKey)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling SamlspApi->getSamlSpByConfKey: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + +
NameDescription
confKey* + + +
+
+
+ + confKey + + +
+ Configuration key of SAML Service Provider +
+
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 200 - Return a SAML Provider

+ + + +
+
+
+ +
+ +
+
+ +

Status: 400 - An error was encountered when processing the request

+ + + +
+
+
+ +
+ +
+
+ +

Status: 404 - The specified resource was not found

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+
+

replaceSamlSp

+

Replaces a SAML Service

+
+
+
+

+

+

+
+ 
/api/v1/providers/saml/sp/{confKey}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X PUT "/api/v1/api/v1/providers/saml/sp/{confKey}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.SamlspApi;
+
+import java.io.File;
+import java.util.*;
+
+public class SamlspApiExample {
+
+    public static void main(String[] args) {
+        
+        SamlspApi apiInstance = new SamlspApi();
+        confKey confKey = ; // confKey | Configuration key of SAML Service Provider that needs to be replaced
+        SamlSp body = ; // SamlSp | 
+        try {
+            apiInstance.replaceSamlSp(confKey, body);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling SamlspApi#replaceSamlSp");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.SamlspApi;
+
+public class SamlspApiExample {
+
+    public static void main(String[] args) {
+        SamlspApi apiInstance = new SamlspApi();
+        confKey confKey = ; // confKey | Configuration key of SAML Service Provider that needs to be replaced
+        SamlSp body = ; // SamlSp | 
+        try {
+            apiInstance.replaceSamlSp(confKey, body);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling SamlspApi#replaceSamlSp");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
confKey *confKey = ; // Configuration key of SAML Service Provider that needs to be replaced
+SamlSp *body = ; //  (optional)
+
+SamlspApi *apiInstance = [[SamlspApi alloc] init];
+
+// Replaces a SAML Service
+[apiInstance replaceSamlSpWith:confKey
+    body:body
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.SamlspApi()
+var confKey = ; // {{confKey}} Configuration key of SAML Service Provider that needs to be replaced
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.replaceSamlSp(confKey, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class replaceSamlSpExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new SamlspApi();
+            var confKey = new confKey(); // confKey | Configuration key of SAML Service Provider that needs to be replaced
+            var body = new SamlSp(); // SamlSp |  (optional) 
+
+            try
+            {
+                // Replaces a SAML Service
+                apiInstance.replaceSamlSp(confKey, body);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling SamlspApi.replaceSamlSp: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiSamlspApi();
+$confKey = ; // confKey | Configuration key of SAML Service Provider that needs to be replaced
+$body = ; // SamlSp | 
+
+try {
+    $api_instance->replaceSamlSp($confKey, $body);
+} catch (Exception $e) {
+    echo 'Exception when calling SamlspApi->replaceSamlSp: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::SamlspApi;
+
+my $api_instance = WWW::SwaggerClient::SamlspApi->new();
+my $confKey = ; # confKey | Configuration key of SAML Service Provider that needs to be replaced
+my $body = WWW::SwaggerClient::Object::SamlSp->new(); # SamlSp | 
+
+eval { 
+    $api_instance->replaceSamlSp(confKey => $confKey, body => $body);
+};
+if ($@) {
+    warn "Exception when calling SamlspApi->replaceSamlSp: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.SamlspApi()
+confKey =  # confKey | Configuration key of SAML Service Provider that needs to be replaced
+body =  # SamlSp |  (optional)
+
+try: 
+    # Replaces a SAML Service
+    api_instance.replace_saml_sp(confKey, body=body)
+except ApiException as e:
+    print("Exception when calling SamlspApi->replaceSamlSp: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + +
NameDescription
confKey* + + +
+
+
+ + confKey + + +
+ Configuration key of SAML Service Provider that needs to be replaced +
+
+
+ Required +
+
+
+
+ + +
Body parameters
+ + + + + + + + +
NameDescription
body + + + +
+
+ + + +

Responses

+

Status: 204 - Successful modification

+ +
    +
+ +
+
+ +

Status: 400 - An error was encountered when processing the request

+ + + +
+
+
+ +
+ +
+
+ +

Status: 404 - The specified resource was not found

+ + + +
+
+
+ +
+ +
+
+ +

Status: 409 - The specified object could not be created because its configuration key, client_id or entityID already exists

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+
+

updateSamlSp

+

Updates a SAML Service.

+
+
+
+

+

+

+
+ 
/api/v1/providers/saml/sp/{confKey}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X PATCH "/api/v1/api/v1/providers/saml/sp/{confKey}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.SamlspApi;
+
+import java.io.File;
+import java.util.*;
+
+public class SamlspApiExample {
+
+    public static void main(String[] args) {
+        
+        SamlspApi apiInstance = new SamlspApi();
+        confKey confKey = ; // confKey | Configuration key of SAML Service Provider that needs to be updated
+        SamlSpUpdate body = ; // SamlSpUpdate | 
+        try {
+            apiInstance.updateSamlSp(confKey, body);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling SamlspApi#updateSamlSp");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.SamlspApi;
+
+public class SamlspApiExample {
+
+    public static void main(String[] args) {
+        SamlspApi apiInstance = new SamlspApi();
+        confKey confKey = ; // confKey | Configuration key of SAML Service Provider that needs to be updated
+        SamlSpUpdate body = ; // SamlSpUpdate | 
+        try {
+            apiInstance.updateSamlSp(confKey, body);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling SamlspApi#updateSamlSp");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
confKey *confKey = ; // Configuration key of SAML Service Provider that needs to be updated
+SamlSpUpdate *body = ; //  (optional)
+
+SamlspApi *apiInstance = [[SamlspApi alloc] init];
+
+// Updates a SAML Service.
+[apiInstance updateSamlSpWith:confKey
+    body:body
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var LemonLdapngManagerApi = require('lemon_ldapng_manager_api');
+
+var api = new LemonLdapngManagerApi.SamlspApi()
+var confKey = ; // {{confKey}} Configuration key of SAML Service Provider that needs to be updated
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.updateSamlSp(confKey, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class updateSamlSpExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new SamlspApi();
+            var confKey = new confKey(); // confKey | Configuration key of SAML Service Provider that needs to be updated
+            var body = new SamlSpUpdate(); // SamlSpUpdate |  (optional) 
+
+            try
+            {
+                // Updates a SAML Service.
+                apiInstance.updateSamlSp(confKey, body);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling SamlspApi.updateSamlSp: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiSamlspApi();
+$confKey = ; // confKey | Configuration key of SAML Service Provider that needs to be updated
+$body = ; // SamlSpUpdate | 
+
+try {
+    $api_instance->updateSamlSp($confKey, $body);
+} catch (Exception $e) {
+    echo 'Exception when calling SamlspApi->updateSamlSp: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::SamlspApi;
+
+my $api_instance = WWW::SwaggerClient::SamlspApi->new();
+my $confKey = ; # confKey | Configuration key of SAML Service Provider that needs to be updated
+my $body = WWW::SwaggerClient::Object::SamlSpUpdate->new(); # SamlSpUpdate | 
+
+eval { 
+    $api_instance->updateSamlSp(confKey => $confKey, body => $body);
+};
+if ($@) {
+    warn "Exception when calling SamlspApi->updateSamlSp: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.SamlspApi()
+confKey =  # confKey | Configuration key of SAML Service Provider that needs to be updated
+body =  # SamlSpUpdate |  (optional)
+
+try: 
+    # Updates a SAML Service.
+    api_instance.update_saml_sp(confKey, body=body)
+except ApiException as e:
+    print("Exception when calling SamlspApi->updateSamlSp: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + +
NameDescription
confKey* + + +
+
+
+ + confKey + + +
+ Configuration key of SAML Service Provider that needs to be updated +
+
+
+ Required +
+
+
+
+ + +
Body parameters
+ + + + + + + + +
NameDescription
body + + + +
+
+ + + +

Responses

+

Status: 204 - Successful modification

+ +
    +
+ +
+
+ +

Status: 400 - An error was encountered when processing the request

+ + + +
+
+
+ +
+ +
+
+ +

Status: 404 - The specified resource was not found

+ + + +
+
+
+ +
+ +
+
+ +

Status: 409 - The specified object could not be created because its configuration key, client_id or entityID already exists

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+ +
+
+
+ + + + + + + + + diff --git a/doc/sources/manager-api/config-codegen.json b/doc/sources/manager-api/config-codegen.json new file mode 100644 index 000000000..3be0cff73 --- /dev/null +++ b/doc/sources/manager-api/config-codegen.json @@ -0,0 +1,6 @@ +{ "appName": "LemonLDAP::NG", + "appDescription": "API documentation for the LemonLDAP::NG Manager API", + "infoUrl": "https://lemonldap-ng.org/", + "infoEmail": "" +} + diff --git a/doc/sources/manager-api/openapi-spec.yaml b/doc/sources/manager-api/openapi-spec.yaml new file mode 100644 index 000000000..f703f04c5 --- /dev/null +++ b/doc/sources/manager-api/openapi-spec.yaml @@ -0,0 +1,785 @@ +openapi: 3.0.1 +info: + title: LemonLDAP::NG Manager API + description: The Manager API allows an administrator to modify the LemonLDAP::NG configuration programmatically. It is not meant to be accessed by end users. + version: 2.0.8 +servers: + - url: /api/v1 +tags: +- name: samlsp + description: SAML Service Providers +- name: oidcrp + description: OpenID Connect Relaying Parties +- name: 2fa + description: Registered Second Factors + +paths: + /api/v1/providers/saml/sp: + post: + tags: + - samlsp + summary: Create a new SAML Service provider + operationId: addsamlsp + requestBody: + description: SAML Service provider to add + content: + application/json: + schema: + $ref: '#/components/schemas/SamlSp' + required: true + responses: + 201: + $ref: '#/components/responses/Created' + 400: + $ref: '#/components/responses/Error' + 409: + $ref: '#/components/responses/Conflict' + + /api/v1/providers/saml/sp/findByConfKey: + get: + tags: + - samlsp + summary: Finds SAML Service providers by configuration key + description: Takes a search pattern to be tested against existing service providers + operationId: findSamlSpByConfKey + parameters: + - name: pattern + in: query + description: Search pattern + required: true + schema: + type: "string" + examples: + any: + summary: Any value + value: "*" + prefix: + summary: Given prefix + value: "zone1-*" + anywhere: + summary: Substring + value: "something" + responses: + 200: + $ref: '#/components/responses/ManySamlSp' + 400: + $ref: '#/components/responses/Error' + + /api/v1/providers/saml/sp/findByEntityId: + get: + tags: + - samlsp + summary: Finds SAML Service Provider by Entity ID + operationId: findSamlSpByEntityId + parameters: + - name: entityId + in: query + description: Entity ID to search + required: true + schema: + type: "string" + example: http://mysp.example.com/saml/metadata + responses: + 200: + $ref: '#/components/responses/OneSamlSp' + 400: + $ref: '#/components/responses/Error' + 404: + $ref: '#/components/responses/NotFound' + + /api/v1/providers/saml/sp/{confKey}: + get: + tags: + - samlsp + summary: Get SAML Service Provider by configuration key + description: Returns a single Service Provider + operationId: getSamlSpByConfKey + parameters: + - name: confKey + in: path + description: Configuration key of SAML Service Provider + required: true + schema: + $ref: '#/components/schemas/confKey' + responses: + 200: + $ref: '#/components/responses/OneSamlSp' + 400: + $ref: '#/components/responses/Error' + 404: + $ref: '#/components/responses/NotFound' + + put: + tags: + - samlsp + summary: Replaces a SAML Service + operationId: replaceSamlSp + parameters: + - name: confKey + in: path + description: Configuration key of SAML Service Provider that needs to be replaced + required: true + schema: + $ref: '#/components/schemas/confKey' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SamlSp' + responses: + 204: + $ref: '#/components/responses/NoContent' + 400: + $ref: '#/components/responses/Error' + 404: + $ref: '#/components/responses/NotFound' + 409: + $ref: '#/components/responses/Conflict' + patch: + tags: + - samlsp + summary: Updates a SAML Service. + operationId: updateSamlSp + parameters: + - name: confKey + in: path + description: Configuration key of SAML Service Provider that needs to be updated + required: true + schema: + $ref: '#/components/schemas/confKey' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SamlSpUpdate' + responses: + 204: + $ref: '#/components/responses/NoContent' + 400: + $ref: '#/components/responses/Error' + 404: + $ref: '#/components/responses/NotFound' + 409: + $ref: '#/components/responses/Conflict' + + delete: + tags: + - samlsp + summary: Deletes a SAML Service Provider + operationId: deleteSamlSp + parameters: + - name: confKey + in: path + description: Configuration key of SAML Service Provider to delete + required: true + schema: + $ref: '#/components/schemas/confKey' + responses: + 204: + $ref: '#/components/responses/NoContent' + 400: + $ref: '#/components/responses/Error' + 404: + $ref: '#/components/responses/NotFound' + + /api/v1/providers/oidc/rp: + post: + tags: + - oidcrp + summary: Create a new OpenID Connect Relaying Party + operationId: addoidcrp + requestBody: + description: OpenID Connect Relaying Party to add + content: + application/json: + schema: + $ref: '#/components/schemas/OidcRp' + required: true + responses: + 201: + $ref: '#/components/responses/Created' + 400: + $ref: '#/components/responses/Error' + 409: + $ref: '#/components/responses/Conflict' + /api/v1/providers/oidc/rp/findByConfKey: + get: + tags: + - oidcrp + summary: Finds OpenID Connect Relaying Partys by configuration key + description: Takes a search pattern to be tested against existing service providers + operationId: findOidcRpByConfKey + parameters: + - name: pattern + in: query + description: Search pattern + required: true + schema: + $ref: '#/components/schemas/confKey' + examples: + any: + summary: Any value + value: "*" + prefix: + summary: Given prefix + value: "zone1-*" + anywhere: + summary: Substring + value: "something" + responses: + 200: + $ref: '#/components/responses/ManyOidcRp' + 400: + $ref: '#/components/responses/Error' + + /api/v1/providers/oidc/rp/findByClientId: + get: + tags: + - oidcrp + summary: Finds OpenID Connect Relaying Party by Client ID + operationId: findOidcRpByClientId + parameters: + - name: clientId + in: query + description: Client ID to search + required: true + schema: + type: "string" + example: my_client_id + responses: + 200: + $ref: '#/components/responses/OneOidcRp' + 400: + $ref: '#/components/responses/Error' + 404: + $ref: '#/components/responses/NotFound' + /api/v1/providers/oidc/rp/{confKey}: + get: + tags: + - oidcrp + summary: Get OpenID Connect Relaying Party by configuration key + description: Returns a single Service Provider + operationId: getOidcRpByConfKey + parameters: + - name: confKey + in: path + description: Configuration key of OpenID Connect Relaying Party + required: true + schema: + $ref: '#/components/schemas/confKey' + responses: + 200: + $ref: '#/components/responses/OneOidcRp' + 400: + $ref: '#/components/responses/Error' + 404: + $ref: '#/components/responses/NotFound' + + patch: + tags: + - oidcrp + summary: Updates an OpenID Connect Relaying Party + operationId: updateOidcRp + parameters: + - name: confKey + in: path + description: Configuration key of OpenID Connect Relaying Party that needs to be updated + required: true + schema: + $ref: '#/components/schemas/confKey' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OidcRpUpdate' + responses: + 204: + $ref: '#/components/responses/NoContent' + 400: + $ref: '#/components/responses/Error' + 404: + $ref: '#/components/responses/NotFound' + 409: + $ref: '#/components/responses/Conflict' + put: + tags: + - oidcrp + summary: Replaces an OpenID Connect Relaying Party + operationId: replaceOidcRp + parameters: + - name: confKey + in: path + description: Configuration key of OpenID Connect Relaying Party that needs to be replaced + required: true + schema: + $ref: '#/components/schemas/confKey' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OidcRp' + responses: + 204: + $ref: '#/components/responses/NoContent' + 400: + $ref: '#/components/responses/Error' + 404: + $ref: '#/components/responses/NotFound' + 409: + $ref: '#/components/responses/Conflict' + + delete: + tags: + - oidcrp + summary: Deletes a OpenID Connect Relaying Party + operationId: deleteOidcRp + parameters: + - name: confKey + in: path + description: Configuration key of OpenID Connect Relaying Party to delete + required: true + schema: + $ref: '#/components/schemas/confKey' + responses: + 204: + $ref: '#/components/responses/NoContent' + 400: + $ref: '#/components/responses/Error' + 404: + $ref: '#/components/responses/NotFound' + + '/api/v1/secondFactor/{uid}': + description: Second factors for a particular user + parameters: + - name: uid + in: path + required: true + schema: + type: string + get: + summary: List second factors for a user + description: '' + tags: + - 2fa + operationId: getSecondFactors + responses: + 200: + $ref: '#/components/responses/SecondFactors' + 404: + $ref: '#/components/responses/NotFound' + + delete: + summary: Delete all second factors for a user + description: '' + tags: + - 2fa + operationId: deleteSecondFactors + responses: + 204: + $ref: '#/components/responses/NoContent' + 404: + $ref: '#/components/responses/NotFound' + + + '/api/v1/secondFactor/{uid}/type/{type}': + description: Second factors of a given type for a particular user + parameters: + - name: uid + in: path + required: true + schema: + type: string + - name: type + in: path + required: true + schema: + type: string + get: + summary: List second factors for a user given its type + description: '' + tags: + - 2fa + operationId: getSecondFactorsByType + responses: + 200: + $ref: '#/components/responses/SecondFactors' + 404: + $ref: '#/components/responses/NotFound' + + + delete: + summary: Delete all second factors of a given type for a user + description: '' + tags: + - 2fa + operationId: deleteSecondFactorsByType + responses: + 204: + $ref: '#/components/responses/NoContent' + 404: + $ref: '#/components/responses/NotFound' + + + '/api/v1/secondFactor/{uid}/id/{id}': + description: Second factors of a given id for a particular user + parameters: + - name: uid + in: path + required: true + schema: + type: string + - name: id + in: path + required: true + schema: + type: string + get: + summary: Get second factors for a user given its ID + description: '' + tags: + - 2fa + operationId: getSecondFactorsById + responses: + 200: + $ref: '#/components/responses/SecondFactors' + 404: + $ref: '#/components/responses/NotFound' + + + delete: + summary: Delete a second factors for a user + description: '' + tags: + - 2fa + operationId: deleteSecondFactorsById + responses: + 204: + $ref: '#/components/responses/NoContent' + 404: + $ref: '#/components/responses/NotFound' + + +components: + schemas: + confKey: + type: string + pattern: '^\w[\w\.\-]*$' + Error: + type: object + properties: + error: + type: string + required: + - error + SamlSp: + required: + - confKey + - metadata + type: object + properties: + confKey: + $ref: '#/components/schemas/confKey' + metadata: + type: string + example: ' + + LemonLDAP::NG Manager API + + + +
+

LemonLDAP::NG Manager API

+
+ API Reference +
+ + +