OpenWiFi User Portal

Authentication

getAccessToken

Get access token - to be used as Bearer token header for all other API requests.


/oauth2

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16006/api/v1/oauth2?newPassword=newPassword_example&forgotPassword=true&requirements=true&resendMFACode=true&completeMFAChallenge=true&grant_type=refresh_token" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthenticationApi;

import java.io.File;
import java.util.*;

public class AuthenticationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AuthenticationApi apiInstance = new AuthenticationApi();
        GetAccessTokenRequest getAccessTokenRequest = ; // GetAccessTokenRequest | 
        String newPassword = newPassword_example; // String | used when a user is trying to change her password. This will be the new password.
        Boolean forgotPassword = true; // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
        Boolean requirements = true; // Boolean | A user forgot her password. This will provided the password requirements.
        Boolean resendMFACode = true; // Boolean | 
        Boolean completeMFAChallenge = true; // Boolean | 
        String grantType = refresh_token; // String | 

        try {
            getAccessToken_200_response result = apiInstance.getAccessToken(getAccessTokenRequest, newPassword, forgotPassword, requirements, resendMFACode, completeMFAChallenge, grantType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#getAccessToken");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthenticationApi;

public class AuthenticationApiExample {
    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        GetAccessTokenRequest getAccessTokenRequest = ; // GetAccessTokenRequest | 
        String newPassword = newPassword_example; // String | used when a user is trying to change her password. This will be the new password.
        Boolean forgotPassword = true; // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
        Boolean requirements = true; // Boolean | A user forgot her password. This will provided the password requirements.
        Boolean resendMFACode = true; // Boolean | 
        Boolean completeMFAChallenge = true; // Boolean | 
        String grantType = refresh_token; // String | 

        try {
            getAccessToken_200_response result = apiInstance.getAccessToken(getAccessTokenRequest, newPassword, forgotPassword, requirements, resendMFACode, completeMFAChallenge, grantType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#getAccessToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];
GetAccessTokenRequest *getAccessTokenRequest = ; // 
String *newPassword = newPassword_example; // used when a user is trying to change her password. This will be the new password. (optional) (default to null)
Boolean *forgotPassword = true; // A user forgot her password. She needs to present her e-mail address in the userId and set this to true (optional) (default to null)
Boolean *requirements = true; // A user forgot her password. This will provided the password requirements. (optional) (default to null)
Boolean *resendMFACode = true; //  (optional) (default to null)
Boolean *completeMFAChallenge = true; //  (optional) (default to null)
String *grantType = refresh_token; //  (optional) (default to null)

// Get access token - to be used as Bearer token header for all other API requests.
[apiInstance getAccessTokenWith:getAccessTokenRequest
    newPassword:newPassword
    forgotPassword:forgotPassword
    requirements:requirements
    resendMFACode:resendMFACode
    completeMFAChallenge:completeMFAChallenge
    grantType:grantType
              completionHandler: ^(getAccessToken_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.AuthenticationApi()
var getAccessTokenRequest = ; // {GetAccessTokenRequest} 
var opts = {
  'newPassword': newPassword_example, // {String} used when a user is trying to change her password. This will be the new password.
  'forgotPassword': true, // {Boolean} A user forgot her password. She needs to present her e-mail address in the userId and set this to true
  'requirements': true, // {Boolean} A user forgot her password. This will provided the password requirements.
  'resendMFACode': true, // {Boolean} 
  'completeMFAChallenge': true, // {Boolean} 
  'grantType': refresh_token // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccessToken(getAccessTokenRequest, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAccessTokenExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AuthenticationApi();
            var getAccessTokenRequest = new GetAccessTokenRequest(); // GetAccessTokenRequest | 
            var newPassword = newPassword_example;  // String | used when a user is trying to change her password. This will be the new password. (optional)  (default to null)
            var forgotPassword = true;  // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true (optional)  (default to null)
            var requirements = true;  // Boolean | A user forgot her password. This will provided the password requirements. (optional)  (default to null)
            var resendMFACode = true;  // Boolean |  (optional)  (default to null)
            var completeMFAChallenge = true;  // Boolean |  (optional)  (default to null)
            var grantType = refresh_token;  // String |  (optional)  (default to null)

            try {
                // Get access token - to be used as Bearer token header for all other API requests.
                getAccessToken_200_response result = apiInstance.getAccessToken(getAccessTokenRequest, newPassword, forgotPassword, requirements, resendMFACode, completeMFAChallenge, grantType);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthenticationApi.getAccessToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthenticationApi();
$getAccessTokenRequest = ; // GetAccessTokenRequest | 
$newPassword = newPassword_example; // String | used when a user is trying to change her password. This will be the new password.
$forgotPassword = true; // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
$requirements = true; // Boolean | A user forgot her password. This will provided the password requirements.
$resendMFACode = true; // Boolean | 
$completeMFAChallenge = true; // Boolean | 
$grantType = refresh_token; // String | 

try {
    $result = $api_instance->getAccessToken($getAccessTokenRequest, $newPassword, $forgotPassword, $requirements, $resendMFACode, $completeMFAChallenge, $grantType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->getAccessToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthenticationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthenticationApi->new();
my $getAccessTokenRequest = WWW::OPenAPIClient::Object::GetAccessTokenRequest->new(); # GetAccessTokenRequest | 
my $newPassword = newPassword_example; # String | used when a user is trying to change her password. This will be the new password.
my $forgotPassword = true; # Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
my $requirements = true; # Boolean | A user forgot her password. This will provided the password requirements.
my $resendMFACode = true; # Boolean | 
my $completeMFAChallenge = true; # Boolean | 
my $grantType = refresh_token; # String | 

eval {
    my $result = $api_instance->getAccessToken(getAccessTokenRequest => $getAccessTokenRequest, newPassword => $newPassword, forgotPassword => $forgotPassword, requirements => $requirements, resendMFACode => $resendMFACode, completeMFAChallenge => $completeMFAChallenge, grantType => $grantType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticationApi->getAccessToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AuthenticationApi()
getAccessTokenRequest =  # GetAccessTokenRequest | 
newPassword = newPassword_example # String | used when a user is trying to change her password. This will be the new password. (optional) (default to null)
forgotPassword = true # Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true (optional) (default to null)
requirements = true # Boolean | A user forgot her password. This will provided the password requirements. (optional) (default to null)
resendMFACode = true # Boolean |  (optional) (default to null)
completeMFAChallenge = true # Boolean |  (optional) (default to null)
grantType = refresh_token # String |  (optional) (default to null)

try:
    # Get access token - to be used as Bearer token header for all other API requests.
    api_response = api_instance.get_access_token(getAccessTokenRequest, newPassword=newPassword, forgotPassword=forgotPassword, requirements=requirements, resendMFACode=resendMFACode, completeMFAChallenge=completeMFAChallenge, grantType=grantType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->getAccessToken: %s\n" % e)
extern crate AuthenticationApi;

pub fn main() {
    let getAccessTokenRequest = ; // GetAccessTokenRequest
    let newPassword = newPassword_example; // String
    let forgotPassword = true; // Boolean
    let requirements = true; // Boolean
    let resendMFACode = true; // Boolean
    let completeMFAChallenge = true; // Boolean
    let grantType = refresh_token; // String

    let mut context = AuthenticationApi::Context::default();
    let result = client.getAccessToken(getAccessTokenRequest, newPassword, forgotPassword, requirements, resendMFACode, completeMFAChallenge, grantType, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
getAccessTokenRequest *

User id and password

Query parameters
Name Description
newPassword
String
used when a user is trying to change her password. This will be the new password.
forgotPassword
Boolean
A user forgot her password. She needs to present her e-mail address in the userId and set this to true
requirements
Boolean
A user forgot her password. This will provided the password requirements.
resendMFACode
Boolean
completeMFAChallenge
Boolean
grant_type
String

Responses


removeAccessToken

Revoke a token.


/oauth2/{token}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16006/api/v1/oauth2/{token}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthenticationApi;

import java.io.File;
import java.util.*;

public class AuthenticationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AuthenticationApi apiInstance = new AuthenticationApi();
        String token = token_example; // String | 

        try {
            Success result = apiInstance.removeAccessToken(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#removeAccessToken");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthenticationApi;

public class AuthenticationApiExample {
    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        String token = token_example; // String | 

        try {
            Success result = apiInstance.removeAccessToken(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#removeAccessToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];
String *token = token_example; //  (default to null)

// Revoke a token.
[apiInstance removeAccessTokenWith:token
              completionHandler: ^(Success output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.AuthenticationApi()
var token = token_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeAccessToken(token, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class removeAccessTokenExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AuthenticationApi();
            var token = token_example;  // String |  (default to null)

            try {
                // Revoke a token.
                Success result = apiInstance.removeAccessToken(token);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthenticationApi.removeAccessToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthenticationApi();
$token = token_example; // String | 

try {
    $result = $api_instance->removeAccessToken($token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->removeAccessToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthenticationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthenticationApi->new();
my $token = token_example; # String | 

eval {
    my $result = $api_instance->removeAccessToken(token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticationApi->removeAccessToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AuthenticationApi()
token = token_example # String |  (default to null)

try:
    # Revoke a token.
    api_response = api_instance.remove_access_token(token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->removeAccessToken: %s\n" % e)
extern crate AuthenticationApi;

pub fn main() {
    let token = token_example; // String

    let mut context = AuthenticationApi::Context::default();
    let result = client.removeAccessToken(token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
token*
String
Required

Responses


Clients

getWiredClients

Get the list of wired clients


/wiredclients

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16006/api/v1/wiredclients?serialNumber=serialNumber_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientsApi;

import java.io.File;
import java.util.*;

public class ClientsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ClientsApi apiInstance = new ClientsApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            ClientList result = apiInstance.getWiredClients(serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientsApi#getWiredClients");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ClientsApi;

public class ClientsApiExample {
    public static void main(String[] args) {
        ClientsApi apiInstance = new ClientsApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            ClientList result = apiInstance.getWiredClients(serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientsApi#getWiredClients");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ClientsApi *apiInstance = [[ClientsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)

// Get the list of wired clients
[apiInstance getWiredClientsWith:serialNumber
              completionHandler: ^(ClientList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.ClientsApi()
var serialNumber = serialNumber_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWiredClients(serialNumber, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getWiredClientsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ClientsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)

            try {
                // Get the list of wired clients
                ClientList result = apiInstance.getWiredClients(serialNumber);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClientsApi.getWiredClients: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClientsApi();
$serialNumber = serialNumber_example; // String | 

try {
    $result = $api_instance->getWiredClients($serialNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClientsApi->getWiredClients: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ClientsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClientsApi->new();
my $serialNumber = serialNumber_example; # String | 

eval {
    my $result = $api_instance->getWiredClients(serialNumber => $serialNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientsApi->getWiredClients: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ClientsApi()
serialNumber = serialNumber_example # String |  (default to null)

try:
    # Get the list of wired clients
    api_response = api_instance.get_wired_clients(serialNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientsApi->getWiredClients: %s\n" % e)
extern crate ClientsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String

    let mut context = ClientsApi::Context::default();
    let result = client.getWiredClients(serialNumber, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
serialNumber*
String
Required

Responses


DeviceCommands

performAnAction

Sending different commands to a device


/action

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16006/api/v1/action?action=action_example" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DeviceCommandsApi;

import java.io.File;
import java.util.*;

public class DeviceCommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        DeviceCommandsApi apiInstance = new DeviceCommandsApi();
        String action = action_example; // String | 
        PerformAnActionRequest performAnActionRequest = ; // PerformAnActionRequest | 

        try {
            apiInstance.performAnAction(action, performAnActionRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceCommandsApi#performAnAction");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DeviceCommandsApi;

public class DeviceCommandsApiExample {
    public static void main(String[] args) {
        DeviceCommandsApi apiInstance = new DeviceCommandsApi();
        String action = action_example; // String | 
        PerformAnActionRequest performAnActionRequest = ; // PerformAnActionRequest | 

        try {
            apiInstance.performAnAction(action, performAnActionRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceCommandsApi#performAnAction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
DeviceCommandsApi *apiInstance = [[DeviceCommandsApi alloc] init];
String *action = action_example; //  (optional) (default to null)
PerformAnActionRequest *performAnActionRequest = ; //  (optional)

// Sending different commands to a device
[apiInstance performAnActionWith:action
    performAnActionRequest:performAnActionRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.DeviceCommandsApi()
var opts = {
  'action': action_example, // {String} 
  'performAnActionRequest':  // {PerformAnActionRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.performAnAction(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class performAnActionExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DeviceCommandsApi();
            var action = action_example;  // String |  (optional)  (default to null)
            var performAnActionRequest = new PerformAnActionRequest(); // PerformAnActionRequest |  (optional) 

            try {
                // Sending different commands to a device
                apiInstance.performAnAction(action, performAnActionRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling DeviceCommandsApi.performAnAction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DeviceCommandsApi();
$action = action_example; // String | 
$performAnActionRequest = ; // PerformAnActionRequest | 

try {
    $api_instance->performAnAction($action, $performAnActionRequest);
} catch (Exception $e) {
    echo 'Exception when calling DeviceCommandsApi->performAnAction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DeviceCommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DeviceCommandsApi->new();
my $action = action_example; # String | 
my $performAnActionRequest = WWW::OPenAPIClient::Object::PerformAnActionRequest->new(); # PerformAnActionRequest | 

eval {
    $api_instance->performAnAction(action => $action, performAnActionRequest => $performAnActionRequest);
};
if ($@) {
    warn "Exception when calling DeviceCommandsApi->performAnAction: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DeviceCommandsApi()
action = action_example # String |  (optional) (default to null)
performAnActionRequest =  # PerformAnActionRequest |  (optional)

try:
    # Sending different commands to a device
    api_instance.perform_an_action(action=action, performAnActionRequest=performAnActionRequest)
except ApiException as e:
    print("Exception when calling DeviceCommandsApi->performAnAction: %s\n" % e)
extern crate DeviceCommandsApi;

pub fn main() {
    let action = action_example; // String
    let performAnActionRequest = ; // PerformAnActionRequest

    let mut context = DeviceCommandsApi::Context::default();
    let result = client.performAnAction(action, performAnActionRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
performAnActionRequest

Query parameters
Name Description
action
String

Responses


DeviceStatistics

getStats

Get a list of statistics about the MAC address inout/output in terms of bytes


/stats/{mac}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16006/api/v1/stats/{mac}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DeviceStatisticsApi;

import java.io.File;
import java.util.*;

public class DeviceStatisticsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        DeviceStatisticsApi apiInstance = new DeviceStatisticsApi();
        String mac = mac_example; // String | 

        try {
            apiInstance.getStats(mac);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceStatisticsApi#getStats");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DeviceStatisticsApi;

public class DeviceStatisticsApiExample {
    public static void main(String[] args) {
        DeviceStatisticsApi apiInstance = new DeviceStatisticsApi();
        String mac = mac_example; // String | 

        try {
            apiInstance.getStats(mac);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceStatisticsApi#getStats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
DeviceStatisticsApi *apiInstance = [[DeviceStatisticsApi alloc] init];
String *mac = mac_example; //  (default to null)

// Get a list of statistics about the MAC address inout/output in terms of bytes
[apiInstance getStatsWith:mac
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.DeviceStatisticsApi()
var mac = mac_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getStats(mac, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getStatsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DeviceStatisticsApi();
            var mac = mac_example;  // String |  (default to null)

            try {
                // Get a list of statistics about the MAC address inout/output in terms of bytes
                apiInstance.getStats(mac);
            } catch (Exception e) {
                Debug.Print("Exception when calling DeviceStatisticsApi.getStats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DeviceStatisticsApi();
$mac = mac_example; // String | 

try {
    $api_instance->getStats($mac);
} catch (Exception $e) {
    echo 'Exception when calling DeviceStatisticsApi->getStats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DeviceStatisticsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DeviceStatisticsApi->new();
my $mac = mac_example; # String | 

eval {
    $api_instance->getStats(mac => $mac);
};
if ($@) {
    warn "Exception when calling DeviceStatisticsApi->getStats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DeviceStatisticsApi()
mac = mac_example # String |  (default to null)

try:
    # Get a list of statistics about the MAC address inout/output in terms of bytes
    api_instance.get_stats(mac)
except ApiException as e:
    print("Exception when calling DeviceStatisticsApi->getStats: %s\n" % e)
extern crate DeviceStatisticsApi;

pub fn main() {
    let mac = mac_example; // String

    let mut context = DeviceStatisticsApi::Context::default();
    let result = client.getStats(mac, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
mac*
String
Required

Responses


MFA

getMFS

Retrieve the current setting for MFA


/submfa

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16006/api/v1/submfa"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MFAApi;

import java.io.File;
import java.util.*;

public class MFAApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        MFAApi apiInstance = new MFAApi();

        try {
            apiInstance.getMFS();
        } catch (ApiException e) {
            System.err.println("Exception when calling MFAApi#getMFS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MFAApi;

public class MFAApiExample {
    public static void main(String[] args) {
        MFAApi apiInstance = new MFAApi();

        try {
            apiInstance.getMFS();
        } catch (ApiException e) {
            System.err.println("Exception when calling MFAApi#getMFS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
MFAApi *apiInstance = [[MFAApi alloc] init];

// Retrieve the current setting for MFA
[apiInstance getMFSWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.MFAApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getMFS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMFSExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new MFAApi();

            try {
                // Retrieve the current setting for MFA
                apiInstance.getMFS();
            } catch (Exception e) {
                Debug.Print("Exception when calling MFAApi.getMFS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MFAApi();

try {
    $api_instance->getMFS();
} catch (Exception $e) {
    echo 'Exception when calling MFAApi->getMFS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MFAApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MFAApi->new();

eval {
    $api_instance->getMFS();
};
if ($@) {
    warn "Exception when calling MFAApi->getMFS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.MFAApi()

try:
    # Retrieve the current setting for MFA
    api_instance.get_mfs()
except ApiException as e:
    print("Exception when calling MFAApi->getMFS: %s\n" % e)
extern crate MFAApi;

pub fn main() {

    let mut context = MFAApi::Context::default();
    let result = client.getMFS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


modifyMFS

Retrieve the current setting for MFA


/submfa

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16006/api/v1/submfa?startValidation=true&completeValidation=true&challengeCode=challengeCode_example" \
 -d '{
  "sms" : "sms",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : "disabled",
  "email" : "email"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MFAApi;

import java.io.File;
import java.util.*;

public class MFAApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        MFAApi apiInstance = new MFAApi();
        Boolean startValidation = true; // Boolean | 
        Boolean completeValidation = true; // Boolean | 
        String challengeCode = challengeCode_example; // String | 
        SubMfaConfig subMfaConfig = ; // SubMfaConfig | 

        try {
            apiInstance.modifyMFS(startValidation, completeValidation, challengeCode, subMfaConfig);
        } catch (ApiException e) {
            System.err.println("Exception when calling MFAApi#modifyMFS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MFAApi;

public class MFAApiExample {
    public static void main(String[] args) {
        MFAApi apiInstance = new MFAApi();
        Boolean startValidation = true; // Boolean | 
        Boolean completeValidation = true; // Boolean | 
        String challengeCode = challengeCode_example; // String | 
        SubMfaConfig subMfaConfig = ; // SubMfaConfig | 

        try {
            apiInstance.modifyMFS(startValidation, completeValidation, challengeCode, subMfaConfig);
        } catch (ApiException e) {
            System.err.println("Exception when calling MFAApi#modifyMFS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
MFAApi *apiInstance = [[MFAApi alloc] init];
Boolean *startValidation = true; //  (optional) (default to null)
Boolean *completeValidation = true; //  (optional) (default to null)
String *challengeCode = challengeCode_example; //  (optional) (default to null)
SubMfaConfig *subMfaConfig = ; //  (optional)

// Retrieve the current setting for MFA
[apiInstance modifyMFSWith:startValidation
    completeValidation:completeValidation
    challengeCode:challengeCode
    subMfaConfig:subMfaConfig
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.MFAApi()
var opts = {
  'startValidation': true, // {Boolean} 
  'completeValidation': true, // {Boolean} 
  'challengeCode': challengeCode_example, // {String} 
  'subMfaConfig':  // {SubMfaConfig} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.modifyMFS(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyMFSExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new MFAApi();
            var startValidation = true;  // Boolean |  (optional)  (default to null)
            var completeValidation = true;  // Boolean |  (optional)  (default to null)
            var challengeCode = challengeCode_example;  // String |  (optional)  (default to null)
            var subMfaConfig = new SubMfaConfig(); // SubMfaConfig |  (optional) 

            try {
                // Retrieve the current setting for MFA
                apiInstance.modifyMFS(startValidation, completeValidation, challengeCode, subMfaConfig);
            } catch (Exception e) {
                Debug.Print("Exception when calling MFAApi.modifyMFS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MFAApi();
$startValidation = true; // Boolean | 
$completeValidation = true; // Boolean | 
$challengeCode = challengeCode_example; // String | 
$subMfaConfig = ; // SubMfaConfig | 

try {
    $api_instance->modifyMFS($startValidation, $completeValidation, $challengeCode, $subMfaConfig);
} catch (Exception $e) {
    echo 'Exception when calling MFAApi->modifyMFS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MFAApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MFAApi->new();
my $startValidation = true; # Boolean | 
my $completeValidation = true; # Boolean | 
my $challengeCode = challengeCode_example; # String | 
my $subMfaConfig = WWW::OPenAPIClient::Object::SubMfaConfig->new(); # SubMfaConfig | 

eval {
    $api_instance->modifyMFS(startValidation => $startValidation, completeValidation => $completeValidation, challengeCode => $challengeCode, subMfaConfig => $subMfaConfig);
};
if ($@) {
    warn "Exception when calling MFAApi->modifyMFS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.MFAApi()
startValidation = true # Boolean |  (optional) (default to null)
completeValidation = true # Boolean |  (optional) (default to null)
challengeCode = challengeCode_example # String |  (optional) (default to null)
subMfaConfig =  # SubMfaConfig |  (optional)

try:
    # Retrieve the current setting for MFA
    api_instance.modify_mfs(startValidation=startValidation, completeValidation=completeValidation, challengeCode=challengeCode, subMfaConfig=subMfaConfig)
except ApiException as e:
    print("Exception when calling MFAApi->modifyMFS: %s\n" % e)
extern crate MFAApi;

pub fn main() {
    let startValidation = true; // Boolean
    let completeValidation = true; // Boolean
    let challengeCode = challengeCode_example; // String
    let subMfaConfig = ; // SubMfaConfig

    let mut context = MFAApi::Context::default();
    let result = client.modifyMFS(startValidation, completeValidation, challengeCode, subMfaConfig, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
subMfaConfig

Query parameters
Name Description
startValidation
Boolean
completeValidation
Boolean
challengeCode
String

Responses


SubscriberInformation

deleteSubscriberInfo

Remove the subscriber from the DB


/subscriber

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16006/api/v1/subscriber"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriberInformationApi;

import java.io.File;
import java.util.*;

public class SubscriberInformationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubscriberInformationApi apiInstance = new SubscriberInformationApi();

        try {
            apiInstance.deleteSubscriberInfo();
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberInformationApi#deleteSubscriberInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriberInformationApi;

public class SubscriberInformationApiExample {
    public static void main(String[] args) {
        SubscriberInformationApi apiInstance = new SubscriberInformationApi();

        try {
            apiInstance.deleteSubscriberInfo();
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberInformationApi#deleteSubscriberInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubscriberInformationApi *apiInstance = [[SubscriberInformationApi alloc] init];

// Remove the subscriber from the DB
[apiInstance deleteSubscriberInfoWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.SubscriberInformationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteSubscriberInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteSubscriberInfoExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubscriberInformationApi();

            try {
                // Remove the subscriber from the DB
                apiInstance.deleteSubscriberInfo();
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriberInformationApi.deleteSubscriberInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscriberInformationApi();

try {
    $api_instance->deleteSubscriberInfo();
} catch (Exception $e) {
    echo 'Exception when calling SubscriberInformationApi->deleteSubscriberInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriberInformationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscriberInformationApi->new();

eval {
    $api_instance->deleteSubscriberInfo();
};
if ($@) {
    warn "Exception when calling SubscriberInformationApi->deleteSubscriberInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubscriberInformationApi()

try:
    # Remove the subscriber from the DB
    api_instance.delete_subscriber_info()
except ApiException as e:
    print("Exception when calling SubscriberInformationApi->deleteSubscriberInfo: %s\n" % e)
extern crate SubscriberInformationApi;

pub fn main() {

    let mut context = SubscriberInformationApi::Context::default();
    let result = client.deleteSubscriberInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getSubscriberInfo

Get the information about the subscriber


/subscriber

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16006/api/v1/subscriber"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriberInformationApi;

import java.io.File;
import java.util.*;

public class SubscriberInformationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubscriberInformationApi apiInstance = new SubscriberInformationApi();

        try {
            apiInstance.getSubscriberInfo();
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberInformationApi#getSubscriberInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriberInformationApi;

public class SubscriberInformationApiExample {
    public static void main(String[] args) {
        SubscriberInformationApi apiInstance = new SubscriberInformationApi();

        try {
            apiInstance.getSubscriberInfo();
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberInformationApi#getSubscriberInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubscriberInformationApi *apiInstance = [[SubscriberInformationApi alloc] init];

// Get the information about the subscriber
[apiInstance getSubscriberInfoWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.SubscriberInformationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getSubscriberInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSubscriberInfoExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubscriberInformationApi();

            try {
                // Get the information about the subscriber
                apiInstance.getSubscriberInfo();
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriberInformationApi.getSubscriberInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscriberInformationApi();

try {
    $api_instance->getSubscriberInfo();
} catch (Exception $e) {
    echo 'Exception when calling SubscriberInformationApi->getSubscriberInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriberInformationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscriberInformationApi->new();

eval {
    $api_instance->getSubscriberInfo();
};
if ($@) {
    warn "Exception when calling SubscriberInformationApi->getSubscriberInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubscriberInformationApi()

try:
    # Get the information about the subscriber
    api_instance.get_subscriber_info()
except ApiException as e:
    print("Exception when calling SubscriberInformationApi->getSubscriberInfo: %s\n" % e)
extern crate SubscriberInformationApi;

pub fn main() {

    let mut context = SubscriberInformationApi::Context::default();
    let result = client.getSubscriberInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


modifySubscriberInfo

Modify the information stored about the subscriber


/subscriber

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16006/api/v1/subscriber?configChanged=true&applyConfigOnly=true" \
 -d '{
  "firstName" : "firstName",
  "lastName" : "lastName",
  "phoneNumber" : "phoneNumber",
  "secondaryEmail" : "secondaryEmail",
  "initials" : "initials",
  "created" : 2,
  "serviceAddress" : {
    "buildingName" : "buildingName",
    "country" : "country",
    "city" : "city",
    "mobiles" : [ "mobiles", "mobiles" ],
    "phones" : [ "phones", "phones" ],
    "addressLines" : [ "addressLines", "addressLines" ],
    "state" : "state",
    "postal" : "postal"
  },
  "modified" : 6,
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "accessPoints" : {
    "list" : [ {
      "deviceType" : "deviceType",
      "wifiNetworks" : {
        "created" : 4,
        "modified" : 7,
        "networks" : [ {
          "password" : "password",
          "encryption" : "wpa2-personal",
          "name" : "name",
          "type" : "main",
          "bands" : [ "all", "all" ]
        }, {
          "password" : "password",
          "encryption" : "wpa2-personal",
          "name" : "name",
          "type" : "main",
          "bands" : [ "all", "all" ]
        } ]
      },
      "serialNumber" : "serialNumber",
      "address" : {
        "buildingName" : "buildingName",
        "country" : "country",
        "city" : "city",
        "mobiles" : [ "mobiles", "mobiles" ],
        "phones" : [ "phones", "phones" ],
        "addressLines" : [ "addressLines", "addressLines" ],
        "state" : "state",
        "postal" : "postal"
      },
      "currentFirmware" : "currentFirmware",
      "internetConnection" : {
        "primaryDns" : "primaryDns",
        "created" : 1,
        "ipAddress" : "ipAddress",
        "secondaryDnsV6" : "secondaryDnsV6",
        "type" : "manual",
        "subnetMask" : "subnetMask",
        "ipAddressV6" : "ipAddressV6",
        "defaultGateway" : "defaultGateway",
        "primaryDnsV6" : "primaryDnsV6",
        "password" : "password",
        "defaultGatewayV6" : "defaultGatewayV6",
        "modified" : 1,
        "secondaryDns" : "secondaryDns",
        "subnetMaskV6" : 1,
        "ipV6Support" : false,
        "username" : "username"
      },
      "ipReservations" : {
        "reservations" : [ {
          "macAddress" : "macAddress",
          "nickname" : "nickname",
          "ipAddress" : "maybe IPv4 or IPv6"
        }, {
          "macAddress" : "macAddress",
          "nickname" : "nickname",
          "ipAddress" : "maybe IPv4 or IPv6"
        } ],
        "created" : 3,
        "modified" : 2
      },
      "macAddress" : "macAddress",
      "latestFirmware" : "latestFirmware",
      "automaticUpgrade" : true,
      "newFirmwareAvailable" : true,
      "deviceMode" : {
        "endIP" : "endIP",
        "subnet" : "subnet",
        "leaseTime" : "leaseTime",
        "startIP" : "startIP",
        "subnetV6" : "subnetV6",
        "created" : 1,
        "type" : "automatic",
        "subnetMask" : 6,
        "endIPV6" : "endIPV6",
        "startIPV6" : "startIPV6",
        "modified" : 4,
        "subnetMaskV6" : 7,
        "ipV6Support" : false,
        "enableLEDS" : true
      },
      "radios" : [ {
        "country" : "country",
        "bandwidth" : 5,
        "rates" : {
          "beacon" : 9,
          "multicast" : 6
        },
        "dtimPeriod" : 223,
        "rawInfo" : [ "rawInfo", "rawInfo" ],
        "legacyRates" : false,
        "requireMode" : "HT",
        "txPower" : 28,
        "channelMode" : "HE",
        "channelWidth" : 9,
        "beaconInterval" : 43805,
        "band" : "2G",
        "he" : {
          "bssColor" : 3,
          "multipleBSSID" : false,
          "ema" : false
        }
      }, {
        "country" : "country",
        "bandwidth" : 5,
        "rates" : {
          "beacon" : 9,
          "multicast" : 6
        },
        "dtimPeriod" : 223,
        "rawInfo" : [ "rawInfo", "rawInfo" ],
        "legacyRates" : false,
        "requireMode" : "HT",
        "txPower" : 28,
        "channelMode" : "HE",
        "channelWidth" : 9,
        "beaconInterval" : 43805,
        "band" : "2G",
        "he" : {
          "bssColor" : 3,
          "multipleBSSID" : false,
          "ema" : false
        }
      } ],
      "subscriberDevices" : {
        "devices" : [ {
          "created" : 5,
          "ip" : "ip",
          "icon" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "description" : "description",
          "suspended" : true,
          "manufacturer" : "manufacturer",
          "firstContact" : 1,
          "lastContact" : 5,
          "schedule" : {
            "schedule" : [ {
              "rangeList" : [ "rangeList", "rangeList" ],
              "description" : "description",
              "day" : "day"
            }, {
              "rangeList" : [ "rangeList", "rangeList" ],
              "description" : "description",
              "day" : "day"
            } ],
            "created" : 7,
            "description" : "description",
            "modified" : 9
          },
          "macAddress" : "macAddress",
          "name" : "name",
          "modified" : 2,
          "group" : "group"
        }, {
          "created" : 5,
          "ip" : "ip",
          "icon" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "description" : "description",
          "suspended" : true,
          "manufacturer" : "manufacturer",
          "firstContact" : 1,
          "lastContact" : 5,
          "schedule" : {
            "schedule" : [ {
              "rangeList" : [ "rangeList", "rangeList" ],
              "description" : "description",
              "day" : "day"
            }, {
              "rangeList" : [ "rangeList", "rangeList" ],
              "description" : "description",
              "day" : "day"
            } ],
            "created" : 7,
            "description" : "description",
            "modified" : 9
          },
          "macAddress" : "macAddress",
          "name" : "name",
          "modified" : 2,
          "group" : "group"
        } ],
        "created" : 0,
        "modified" : 6
      },
      "name" : "name",
      "configurationUUID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "dnsConfiguration" : {
        "secondary" : "secondary",
        "primaryV6" : "primaryV6",
        "ISP" : true,
        "custom" : true,
        "secondaryV6" : "secondaryV6",
        "primary" : "primary"
      },
      "latestFirmwareDate" : 1,
      "currentFirmwareDate" : 6
    }, {
      "deviceType" : "deviceType",
      "wifiNetworks" : {
        "created" : 4,
        "modified" : 7,
        "networks" : [ {
          "password" : "password",
          "encryption" : "wpa2-personal",
          "name" : "name",
          "type" : "main",
          "bands" : [ "all", "all" ]
        }, {
          "password" : "password",
          "encryption" : "wpa2-personal",
          "name" : "name",
          "type" : "main",
          "bands" : [ "all", "all" ]
        } ]
      },
      "serialNumber" : "serialNumber",
      "address" : {
        "buildingName" : "buildingName",
        "country" : "country",
        "city" : "city",
        "mobiles" : [ "mobiles", "mobiles" ],
        "phones" : [ "phones", "phones" ],
        "addressLines" : [ "addressLines", "addressLines" ],
        "state" : "state",
        "postal" : "postal"
      },
      "currentFirmware" : "currentFirmware",
      "internetConnection" : {
        "primaryDns" : "primaryDns",
        "created" : 1,
        "ipAddress" : "ipAddress",
        "secondaryDnsV6" : "secondaryDnsV6",
        "type" : "manual",
        "subnetMask" : "subnetMask",
        "ipAddressV6" : "ipAddressV6",
        "defaultGateway" : "defaultGateway",
        "primaryDnsV6" : "primaryDnsV6",
        "password" : "password",
        "defaultGatewayV6" : "defaultGatewayV6",
        "modified" : 1,
        "secondaryDns" : "secondaryDns",
        "subnetMaskV6" : 1,
        "ipV6Support" : false,
        "username" : "username"
      },
      "ipReservations" : {
        "reservations" : [ {
          "macAddress" : "macAddress",
          "nickname" : "nickname",
          "ipAddress" : "maybe IPv4 or IPv6"
        }, {
          "macAddress" : "macAddress",
          "nickname" : "nickname",
          "ipAddress" : "maybe IPv4 or IPv6"
        } ],
        "created" : 3,
        "modified" : 2
      },
      "macAddress" : "macAddress",
      "latestFirmware" : "latestFirmware",
      "automaticUpgrade" : true,
      "newFirmwareAvailable" : true,
      "deviceMode" : {
        "endIP" : "endIP",
        "subnet" : "subnet",
        "leaseTime" : "leaseTime",
        "startIP" : "startIP",
        "subnetV6" : "subnetV6",
        "created" : 1,
        "type" : "automatic",
        "subnetMask" : 6,
        "endIPV6" : "endIPV6",
        "startIPV6" : "startIPV6",
        "modified" : 4,
        "subnetMaskV6" : 7,
        "ipV6Support" : false,
        "enableLEDS" : true
      },
      "radios" : [ {
        "country" : "country",
        "bandwidth" : 5,
        "rates" : {
          "beacon" : 9,
          "multicast" : 6
        },
        "dtimPeriod" : 223,
        "rawInfo" : [ "rawInfo", "rawInfo" ],
        "legacyRates" : false,
        "requireMode" : "HT",
        "txPower" : 28,
        "channelMode" : "HE",
        "channelWidth" : 9,
        "beaconInterval" : 43805,
        "band" : "2G",
        "he" : {
          "bssColor" : 3,
          "multipleBSSID" : false,
          "ema" : false
        }
      }, {
        "country" : "country",
        "bandwidth" : 5,
        "rates" : {
          "beacon" : 9,
          "multicast" : 6
        },
        "dtimPeriod" : 223,
        "rawInfo" : [ "rawInfo", "rawInfo" ],
        "legacyRates" : false,
        "requireMode" : "HT",
        "txPower" : 28,
        "channelMode" : "HE",
        "channelWidth" : 9,
        "beaconInterval" : 43805,
        "band" : "2G",
        "he" : {
          "bssColor" : 3,
          "multipleBSSID" : false,
          "ema" : false
        }
      } ],
      "subscriberDevices" : {
        "devices" : [ {
          "created" : 5,
          "ip" : "ip",
          "icon" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "description" : "description",
          "suspended" : true,
          "manufacturer" : "manufacturer",
          "firstContact" : 1,
          "lastContact" : 5,
          "schedule" : {
            "schedule" : [ {
              "rangeList" : [ "rangeList", "rangeList" ],
              "description" : "description",
              "day" : "day"
            }, {
              "rangeList" : [ "rangeList", "rangeList" ],
              "description" : "description",
              "day" : "day"
            } ],
            "created" : 7,
            "description" : "description",
            "modified" : 9
          },
          "macAddress" : "macAddress",
          "name" : "name",
          "modified" : 2,
          "group" : "group"
        }, {
          "created" : 5,
          "ip" : "ip",
          "icon" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "description" : "description",
          "suspended" : true,
          "manufacturer" : "manufacturer",
          "firstContact" : 1,
          "lastContact" : 5,
          "schedule" : {
            "schedule" : [ {
              "rangeList" : [ "rangeList", "rangeList" ],
              "description" : "description",
              "day" : "day"
            }, {
              "rangeList" : [ "rangeList", "rangeList" ],
              "description" : "description",
              "day" : "day"
            } ],
            "created" : 7,
            "description" : "description",
            "modified" : 9
          },
          "macAddress" : "macAddress",
          "name" : "name",
          "modified" : 2,
          "group" : "group"
        } ],
        "created" : 0,
        "modified" : 6
      },
      "name" : "name",
      "configurationUUID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "dnsConfiguration" : {
        "secondary" : "secondary",
        "primaryV6" : "primaryV6",
        "ISP" : true,
        "custom" : true,
        "secondaryV6" : "secondaryV6",
        "primary" : "primary"
      },
      "latestFirmwareDate" : 1,
      "currentFirmwareDate" : 6
    } ]
  },
  "billingAddress" : {
    "buildingName" : "buildingName",
    "country" : "country",
    "city" : "city",
    "mobiles" : [ "mobiles", "mobiles" ],
    "phones" : [ "phones", "phones" ],
    "addressLines" : [ "addressLines", "addressLines" ],
    "state" : "state",
    "postal" : "postal"
  },
  "userId" : "userId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriberInformationApi;

import java.io.File;
import java.util.*;

public class SubscriberInformationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubscriberInformationApi apiInstance = new SubscriberInformationApi();
        Boolean configChanged = true; // Boolean | 
        Boolean applyConfigOnly = true; // Boolean | 
        SubscriberInfo subscriberInfo = ; // SubscriberInfo | 

        try {
            apiInstance.modifySubscriberInfo(configChanged, applyConfigOnly, subscriberInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberInformationApi#modifySubscriberInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriberInformationApi;

public class SubscriberInformationApiExample {
    public static void main(String[] args) {
        SubscriberInformationApi apiInstance = new SubscriberInformationApi();
        Boolean configChanged = true; // Boolean | 
        Boolean applyConfigOnly = true; // Boolean | 
        SubscriberInfo subscriberInfo = ; // SubscriberInfo | 

        try {
            apiInstance.modifySubscriberInfo(configChanged, applyConfigOnly, subscriberInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberInformationApi#modifySubscriberInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubscriberInformationApi *apiInstance = [[SubscriberInformationApi alloc] init];
Boolean *configChanged = true; //  (optional) (default to false)
Boolean *applyConfigOnly = true; //  (optional) (default to false)
SubscriberInfo *subscriberInfo = ; //  (optional)

// Modify the information stored about the subscriber
[apiInstance modifySubscriberInfoWith:configChanged
    applyConfigOnly:applyConfigOnly
    subscriberInfo:subscriberInfo
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.SubscriberInformationApi()
var opts = {
  'configChanged': true, // {Boolean} 
  'applyConfigOnly': true, // {Boolean} 
  'subscriberInfo':  // {SubscriberInfo} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.modifySubscriberInfo(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifySubscriberInfoExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubscriberInformationApi();
            var configChanged = true;  // Boolean |  (optional)  (default to false)
            var applyConfigOnly = true;  // Boolean |  (optional)  (default to false)
            var subscriberInfo = new SubscriberInfo(); // SubscriberInfo |  (optional) 

            try {
                // Modify the information stored about the subscriber
                apiInstance.modifySubscriberInfo(configChanged, applyConfigOnly, subscriberInfo);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriberInformationApi.modifySubscriberInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscriberInformationApi();
$configChanged = true; // Boolean | 
$applyConfigOnly = true; // Boolean | 
$subscriberInfo = ; // SubscriberInfo | 

try {
    $api_instance->modifySubscriberInfo($configChanged, $applyConfigOnly, $subscriberInfo);
} catch (Exception $e) {
    echo 'Exception when calling SubscriberInformationApi->modifySubscriberInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriberInformationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscriberInformationApi->new();
my $configChanged = true; # Boolean | 
my $applyConfigOnly = true; # Boolean | 
my $subscriberInfo = WWW::OPenAPIClient::Object::SubscriberInfo->new(); # SubscriberInfo | 

eval {
    $api_instance->modifySubscriberInfo(configChanged => $configChanged, applyConfigOnly => $applyConfigOnly, subscriberInfo => $subscriberInfo);
};
if ($@) {
    warn "Exception when calling SubscriberInformationApi->modifySubscriberInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubscriberInformationApi()
configChanged = true # Boolean |  (optional) (default to false)
applyConfigOnly = true # Boolean |  (optional) (default to false)
subscriberInfo =  # SubscriberInfo |  (optional)

try:
    # Modify the information stored about the subscriber
    api_instance.modify_subscriber_info(configChanged=configChanged, applyConfigOnly=applyConfigOnly, subscriberInfo=subscriberInfo)
except ApiException as e:
    print("Exception when calling SubscriberInformationApi->modifySubscriberInfo: %s\n" % e)
extern crate SubscriberInformationApi;

pub fn main() {
    let configChanged = true; // Boolean
    let applyConfigOnly = true; // Boolean
    let subscriberInfo = ; // SubscriberInfo

    let mut context = SubscriberInformationApi::Context::default();
    let result = client.modifySubscriberInfo(configChanged, applyConfigOnly, subscriberInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
subscriberInfo

Query parameters
Name Description
configChanged
Boolean
applyConfigOnly
Boolean

Responses


SubscriberRegistration

deleteSignup

This call allows someone to get the status of a signup.


/signup

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16006/api/v1/signup?email=email_example&macAddress=macAddress_example&signupUUID=38400000-8cf0-11bd-b23e-10b96e4ef00d&deviceID=deviceID_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriberRegistrationApi;

import java.io.File;
import java.util.*;

public class SubscriberRegistrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        String email = email_example; // String | 
        String macAddress = macAddress_example; // String | 
        UUID signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String deviceID = deviceID_example; // String | 

        try {
            apiInstance.deleteSignup(email, macAddress, signupUUID, deviceID);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#deleteSignup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriberRegistrationApi;

public class SubscriberRegistrationApiExample {
    public static void main(String[] args) {
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        String email = email_example; // String | 
        String macAddress = macAddress_example; // String | 
        UUID signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String deviceID = deviceID_example; // String | 

        try {
            apiInstance.deleteSignup(email, macAddress, signupUUID, deviceID);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#deleteSignup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubscriberRegistrationApi *apiInstance = [[SubscriberRegistrationApi alloc] init];
String *email = email_example; //  (optional) (default to null)
String *macAddress = macAddress_example; //  (optional) (default to null)
UUID *signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (optional) (default to null)
String *deviceID = deviceID_example; //  (optional) (default to null)

// This call allows someone to get the status of a signup.
[apiInstance deleteSignupWith:email
    macAddress:macAddress
    signupUUID:signupUUID
    deviceID:deviceID
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.SubscriberRegistrationApi()
var opts = {
  'email': email_example, // {String} 
  'macAddress': macAddress_example, // {String} 
  'signupUUID': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} 
  'deviceID': deviceID_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteSignup(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteSignupExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubscriberRegistrationApi();
            var email = email_example;  // String |  (optional)  (default to null)
            var macAddress = macAddress_example;  // String |  (optional)  (default to null)
            var signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (optional)  (default to null)
            var deviceID = deviceID_example;  // String |  (optional)  (default to null)

            try {
                // This call allows someone to get the status of a signup.
                apiInstance.deleteSignup(email, macAddress, signupUUID, deviceID);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriberRegistrationApi.deleteSignup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscriberRegistrationApi();
$email = email_example; // String | 
$macAddress = macAddress_example; // String | 
$signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$deviceID = deviceID_example; // String | 

try {
    $api_instance->deleteSignup($email, $macAddress, $signupUUID, $deviceID);
} catch (Exception $e) {
    echo 'Exception when calling SubscriberRegistrationApi->deleteSignup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriberRegistrationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscriberRegistrationApi->new();
my $email = email_example; # String | 
my $macAddress = macAddress_example; # String | 
my $signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $deviceID = deviceID_example; # String | 

eval {
    $api_instance->deleteSignup(email => $email, macAddress => $macAddress, signupUUID => $signupUUID, deviceID => $deviceID);
};
if ($@) {
    warn "Exception when calling SubscriberRegistrationApi->deleteSignup: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubscriberRegistrationApi()
email = email_example # String |  (optional) (default to null)
macAddress = macAddress_example # String |  (optional) (default to null)
signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (optional) (default to null)
deviceID = deviceID_example # String |  (optional) (default to null)

try:
    # This call allows someone to get the status of a signup.
    api_instance.delete_signup(email=email, macAddress=macAddress, signupUUID=signupUUID, deviceID=deviceID)
except ApiException as e:
    print("Exception when calling SubscriberRegistrationApi->deleteSignup: %s\n" % e)
extern crate SubscriberRegistrationApi;

pub fn main() {
    let email = email_example; // String
    let macAddress = macAddress_example; // String
    let signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let deviceID = deviceID_example; // String

    let mut context = SubscriberRegistrationApi::Context::default();
    let result = client.deleteSignup(email, macAddress, signupUUID, deviceID, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
email
String (email)
macAddress
String
signupUUID
UUID (uuid)
deviceID
String

Responses


getSignup

This call allows someone to get the status of a signup.


/signup

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16006/api/v1/signup?email=email_example&macAddress=macAddress_example&signupUUID=38400000-8cf0-11bd-b23e-10b96e4ef00d&dashboard=true&deviceID=deviceID_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriberRegistrationApi;

import java.io.File;
import java.util.*;

public class SubscriberRegistrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        String email = email_example; // String | 
        String macAddress = macAddress_example; // String | 
        UUID signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean dashboard = true; // Boolean | 
        String deviceID = deviceID_example; // String | 

        try {
            apiInstance.getSignup(email, macAddress, signupUUID, dashboard, deviceID);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#getSignup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriberRegistrationApi;

public class SubscriberRegistrationApiExample {
    public static void main(String[] args) {
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        String email = email_example; // String | 
        String macAddress = macAddress_example; // String | 
        UUID signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean dashboard = true; // Boolean | 
        String deviceID = deviceID_example; // String | 

        try {
            apiInstance.getSignup(email, macAddress, signupUUID, dashboard, deviceID);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#getSignup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubscriberRegistrationApi *apiInstance = [[SubscriberRegistrationApi alloc] init];
String *email = email_example; //  (optional) (default to null)
String *macAddress = macAddress_example; //  (optional) (default to null)
UUID *signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (optional) (default to null)
Boolean *dashboard = true; //  (optional) (default to false)
String *deviceID = deviceID_example; //  (optional) (default to null)

// This call allows someone to get the status of a signup.
[apiInstance getSignupWith:email
    macAddress:macAddress
    signupUUID:signupUUID
    dashboard:dashboard
    deviceID:deviceID
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.SubscriberRegistrationApi()
var opts = {
  'email': email_example, // {String} 
  'macAddress': macAddress_example, // {String} 
  'signupUUID': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} 
  'dashboard': true, // {Boolean} 
  'deviceID': deviceID_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getSignup(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSignupExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubscriberRegistrationApi();
            var email = email_example;  // String |  (optional)  (default to null)
            var macAddress = macAddress_example;  // String |  (optional)  (default to null)
            var signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (optional)  (default to null)
            var dashboard = true;  // Boolean |  (optional)  (default to false)
            var deviceID = deviceID_example;  // String |  (optional)  (default to null)

            try {
                // This call allows someone to get the status of a signup.
                apiInstance.getSignup(email, macAddress, signupUUID, dashboard, deviceID);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriberRegistrationApi.getSignup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscriberRegistrationApi();
$email = email_example; // String | 
$macAddress = macAddress_example; // String | 
$signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$dashboard = true; // Boolean | 
$deviceID = deviceID_example; // String | 

try {
    $api_instance->getSignup($email, $macAddress, $signupUUID, $dashboard, $deviceID);
} catch (Exception $e) {
    echo 'Exception when calling SubscriberRegistrationApi->getSignup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriberRegistrationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscriberRegistrationApi->new();
my $email = email_example; # String | 
my $macAddress = macAddress_example; # String | 
my $signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $dashboard = true; # Boolean | 
my $deviceID = deviceID_example; # String | 

eval {
    $api_instance->getSignup(email => $email, macAddress => $macAddress, signupUUID => $signupUUID, dashboard => $dashboard, deviceID => $deviceID);
};
if ($@) {
    warn "Exception when calling SubscriberRegistrationApi->getSignup: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubscriberRegistrationApi()
email = email_example # String |  (optional) (default to null)
macAddress = macAddress_example # String |  (optional) (default to null)
signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (optional) (default to null)
dashboard = true # Boolean |  (optional) (default to false)
deviceID = deviceID_example # String |  (optional) (default to null)

try:
    # This call allows someone to get the status of a signup.
    api_instance.get_signup(email=email, macAddress=macAddress, signupUUID=signupUUID, dashboard=dashboard, deviceID=deviceID)
except ApiException as e:
    print("Exception when calling SubscriberRegistrationApi->getSignup: %s\n" % e)
extern crate SubscriberRegistrationApi;

pub fn main() {
    let email = email_example; // String
    let macAddress = macAddress_example; // String
    let signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let dashboard = true; // Boolean
    let deviceID = deviceID_example; // String

    let mut context = SubscriberRegistrationApi::Context::default();
    let result = client.getSignup(email, macAddress, signupUUID, dashboard, deviceID, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
email
String (email)
macAddress
String
signupUUID
UUID (uuid)
dashboard
Boolean
deviceID
String

Responses


modifySignup

modify the signup command in play


/signup

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16006/api/v1/signup?signupUUID=38400000-8cf0-11bd-b23e-10b96e4ef00d&operation=operation_example&deviceID=deviceID_example" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriberRegistrationApi;

import java.io.File;
import java.util.*;

public class SubscriberRegistrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        UUID signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String operation = operation_example; // String | 
        String deviceID = deviceID_example; // String | 
        ModifySignupRequest modifySignupRequest = ; // ModifySignupRequest | 

        try {
            apiInstance.modifySignup(signupUUID, operation, deviceID, modifySignupRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#modifySignup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriberRegistrationApi;

public class SubscriberRegistrationApiExample {
    public static void main(String[] args) {
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        UUID signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String operation = operation_example; // String | 
        String deviceID = deviceID_example; // String | 
        ModifySignupRequest modifySignupRequest = ; // ModifySignupRequest | 

        try {
            apiInstance.modifySignup(signupUUID, operation, deviceID, modifySignupRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#modifySignup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubscriberRegistrationApi *apiInstance = [[SubscriberRegistrationApi alloc] init];
UUID *signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
String *operation = operation_example; //  (default to null)
String *deviceID = deviceID_example; //  (optional) (default to null)
ModifySignupRequest *modifySignupRequest = ; //  (optional)

// modify the signup command in play
[apiInstance modifySignupWith:signupUUID
    operation:operation
    deviceID:deviceID
    modifySignupRequest:modifySignupRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.SubscriberRegistrationApi()
var signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var operation = operation_example; // {String} 
var opts = {
  'deviceID': deviceID_example, // {String} 
  'modifySignupRequest':  // {ModifySignupRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.modifySignup(signupUUID, operation, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifySignupExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubscriberRegistrationApi();
            var signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var operation = operation_example;  // String |  (default to null)
            var deviceID = deviceID_example;  // String |  (optional)  (default to null)
            var modifySignupRequest = new ModifySignupRequest(); // ModifySignupRequest |  (optional) 

            try {
                // modify the signup command in play
                apiInstance.modifySignup(signupUUID, operation, deviceID, modifySignupRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriberRegistrationApi.modifySignup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscriberRegistrationApi();
$signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$operation = operation_example; // String | 
$deviceID = deviceID_example; // String | 
$modifySignupRequest = ; // ModifySignupRequest | 

try {
    $api_instance->modifySignup($signupUUID, $operation, $deviceID, $modifySignupRequest);
} catch (Exception $e) {
    echo 'Exception when calling SubscriberRegistrationApi->modifySignup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriberRegistrationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscriberRegistrationApi->new();
my $signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $operation = operation_example; # String | 
my $deviceID = deviceID_example; # String | 
my $modifySignupRequest = WWW::OPenAPIClient::Object::ModifySignupRequest->new(); # ModifySignupRequest | 

eval {
    $api_instance->modifySignup(signupUUID => $signupUUID, operation => $operation, deviceID => $deviceID, modifySignupRequest => $modifySignupRequest);
};
if ($@) {
    warn "Exception when calling SubscriberRegistrationApi->modifySignup: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubscriberRegistrationApi()
signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
operation = operation_example # String |  (default to null)
deviceID = deviceID_example # String |  (optional) (default to null)
modifySignupRequest =  # ModifySignupRequest |  (optional)

try:
    # modify the signup command in play
    api_instance.modify_signup(signupUUID, operation, deviceID=deviceID, modifySignupRequest=modifySignupRequest)
except ApiException as e:
    print("Exception when calling SubscriberRegistrationApi->modifySignup: %s\n" % e)
extern crate SubscriberRegistrationApi;

pub fn main() {
    let signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let operation = operation_example; // String
    let deviceID = deviceID_example; // String
    let modifySignupRequest = ; // ModifySignupRequest

    let mut context = SubscriberRegistrationApi::Context::default();
    let result = client.modifySignup(signupUUID, operation, deviceID, modifySignupRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
modifySignupRequest

Query parameters
Name Description
signupUUID*
UUID (uuid)
Required
operation*
String
Required
deviceID
String

Responses


postSignup

This call allows a new subscriber to register themselves and their devices.


/signup

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16006/api/v1/signup?email=email_example&macAddress=macAddress_example&deviceID=deviceID_example®istrationId=registrationId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriberRegistrationApi;

import java.io.File;
import java.util.*;

public class SubscriberRegistrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        String email = email_example; // String | 
        String macAddress = macAddress_example; // String | 
        String registrationId = registrationId_example; // String | 
        String deviceID = deviceID_example; // String | 

        try {
            apiInstance.postSignup(email, macAddress, registrationId, deviceID);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#postSignup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriberRegistrationApi;

public class SubscriberRegistrationApiExample {
    public static void main(String[] args) {
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        String email = email_example; // String | 
        String macAddress = macAddress_example; // String | 
        String registrationId = registrationId_example; // String | 
        String deviceID = deviceID_example; // String | 

        try {
            apiInstance.postSignup(email, macAddress, registrationId, deviceID);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#postSignup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubscriberRegistrationApi *apiInstance = [[SubscriberRegistrationApi alloc] init];
String *email = email_example; //  (default to null)
String *macAddress = macAddress_example; //  (default to null)
String *registrationId = registrationId_example; //  (default to null)
String *deviceID = deviceID_example; //  (optional) (default to null)

// This call allows a new subscriber to register themselves and their devices.
[apiInstance postSignupWith:email
    macAddress:macAddress
    registrationId:registrationId
    deviceID:deviceID
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.SubscriberRegistrationApi()
var email = email_example; // {String} 
var macAddress = macAddress_example; // {String} 
var registrationId = registrationId_example; // {String} 
var opts = {
  'deviceID': deviceID_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postSignup(email, macAddress, registrationId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postSignupExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubscriberRegistrationApi();
            var email = email_example;  // String |  (default to null)
            var macAddress = macAddress_example;  // String |  (default to null)
            var registrationId = registrationId_example;  // String |  (default to null)
            var deviceID = deviceID_example;  // String |  (optional)  (default to null)

            try {
                // This call allows a new subscriber to register themselves and their devices.
                apiInstance.postSignup(email, macAddress, registrationId, deviceID);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriberRegistrationApi.postSignup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscriberRegistrationApi();
$email = email_example; // String | 
$macAddress = macAddress_example; // String | 
$registrationId = registrationId_example; // String | 
$deviceID = deviceID_example; // String | 

try {
    $api_instance->postSignup($email, $macAddress, $registrationId, $deviceID);
} catch (Exception $e) {
    echo 'Exception when calling SubscriberRegistrationApi->postSignup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriberRegistrationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscriberRegistrationApi->new();
my $email = email_example; # String | 
my $macAddress = macAddress_example; # String | 
my $registrationId = registrationId_example; # String | 
my $deviceID = deviceID_example; # String | 

eval {
    $api_instance->postSignup(email => $email, macAddress => $macAddress, registrationId => $registrationId, deviceID => $deviceID);
};
if ($@) {
    warn "Exception when calling SubscriberRegistrationApi->postSignup: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubscriberRegistrationApi()
email = email_example # String |  (default to null)
macAddress = macAddress_example # String |  (default to null)
registrationId = registrationId_example # String |  (default to null)
deviceID = deviceID_example # String |  (optional) (default to null)

try:
    # This call allows a new subscriber to register themselves and their devices.
    api_instance.post_signup(email, macAddress, registrationId, deviceID=deviceID)
except ApiException as e:
    print("Exception when calling SubscriberRegistrationApi->postSignup: %s\n" % e)
extern crate SubscriberRegistrationApi;

pub fn main() {
    let email = email_example; // String
    let macAddress = macAddress_example; // String
    let registrationId = registrationId_example; // String
    let deviceID = deviceID_example; // String

    let mut context = SubscriberRegistrationApi::Context::default();
    let result = client.postSignup(email, macAddress, registrationId, deviceID, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
email*
String (email)
Required
macAddress*
String
Required
deviceID
String
registrationId*
String
Required

Responses


SystemCommands

getSystemCommand

Retrieve different values from the running service.


/system

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16006/api/v1/system?command=command_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemCommandsApi;

import java.io.File;
import java.util.*;

public class SystemCommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemCommandsApi apiInstance = new SystemCommandsApi();
        String command = command_example; // String | Get a value

        try {
            apiInstance.getSystemCommand(command);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemCommandsApi#getSystemCommand");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SystemCommandsApi;

public class SystemCommandsApiExample {
    public static void main(String[] args) {
        SystemCommandsApi apiInstance = new SystemCommandsApi();
        String command = command_example; // String | Get a value

        try {
            apiInstance.getSystemCommand(command);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemCommandsApi#getSystemCommand");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemCommandsApi *apiInstance = [[SystemCommandsApi alloc] init];
String *command = command_example; // Get a value (default to null)

// Retrieve different values from the running service.
[apiInstance getSystemCommandWith:command
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.SystemCommandsApi()
var command = command_example; // {String} Get a value

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getSystemCommand(command, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSystemCommandExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemCommandsApi();
            var command = command_example;  // String | Get a value (default to null)

            try {
                // Retrieve different values from the running service.
                apiInstance.getSystemCommand(command);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemCommandsApi.getSystemCommand: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemCommandsApi();
$command = command_example; // String | Get a value

try {
    $api_instance->getSystemCommand($command);
} catch (Exception $e) {
    echo 'Exception when calling SystemCommandsApi->getSystemCommand: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemCommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemCommandsApi->new();
my $command = command_example; # String | Get a value

eval {
    $api_instance->getSystemCommand(command => $command);
};
if ($@) {
    warn "Exception when calling SystemCommandsApi->getSystemCommand: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemCommandsApi()
command = command_example # String | Get a value (default to null)

try:
    # Retrieve different values from the running service.
    api_instance.get_system_command(command)
except ApiException as e:
    print("Exception when calling SystemCommandsApi->getSystemCommand: %s\n" % e)
extern crate SystemCommandsApi;

pub fn main() {
    let command = command_example; // String

    let mut context = SystemCommandsApi::Context::default();
    let result = client.getSystemCommand(command, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
command*
String
Get a value
Required

Responses


systemCommand

Perform some system wide commands.


/system

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16006/api/v1/system" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemCommandsApi;

import java.io.File;
import java.util.*;

public class SystemCommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemCommandsApi apiInstance = new SystemCommandsApi();
        SystemCommandRequest systemCommandRequest = ; // SystemCommandRequest | 

        try {
            systemCommand_200_response result = apiInstance.systemCommand(systemCommandRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemCommandsApi#systemCommand");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SystemCommandsApi;

public class SystemCommandsApiExample {
    public static void main(String[] args) {
        SystemCommandsApi apiInstance = new SystemCommandsApi();
        SystemCommandRequest systemCommandRequest = ; // SystemCommandRequest | 

        try {
            systemCommand_200_response result = apiInstance.systemCommand(systemCommandRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemCommandsApi#systemCommand");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemCommandsApi *apiInstance = [[SystemCommandsApi alloc] init];
SystemCommandRequest *systemCommandRequest = ; //  (optional)

// Perform some system wide commands.
[apiInstance systemCommandWith:systemCommandRequest
              completionHandler: ^(systemCommand_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.SystemCommandsApi()
var opts = {
  'systemCommandRequest':  // {SystemCommandRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.systemCommand(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class systemCommandExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemCommandsApi();
            var systemCommandRequest = new SystemCommandRequest(); // SystemCommandRequest |  (optional) 

            try {
                // Perform some system wide commands.
                systemCommand_200_response result = apiInstance.systemCommand(systemCommandRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemCommandsApi.systemCommand: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemCommandsApi();
$systemCommandRequest = ; // SystemCommandRequest | 

try {
    $result = $api_instance->systemCommand($systemCommandRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemCommandsApi->systemCommand: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemCommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemCommandsApi->new();
my $systemCommandRequest = WWW::OPenAPIClient::Object::SystemCommandRequest->new(); # SystemCommandRequest | 

eval {
    my $result = $api_instance->systemCommand(systemCommandRequest => $systemCommandRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemCommandsApi->systemCommand: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemCommandsApi()
systemCommandRequest =  # SystemCommandRequest |  (optional)

try:
    # Perform some system wide commands.
    api_response = api_instance.system_command(systemCommandRequest=systemCommandRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemCommandsApi->systemCommand: %s\n" % e)
extern crate SystemCommandsApi;

pub fn main() {
    let systemCommandRequest = ; // SystemCommandRequest

    let mut context = SystemCommandsApi::Context::default();
    let result = client.systemCommand(systemCommandRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
systemCommandRequest

Command details

Responses


SystemConfiguration

deleteSystemConfiguration

Delete all additional system configuration


/systemConfiguration

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16006/api/v1/systemConfiguration"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemConfigurationApi;

import java.io.File;
import java.util.*;

public class SystemConfigurationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemConfigurationApi apiInstance = new SystemConfigurationApi();

        try {
            apiInstance.deleteSystemConfiguration();
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemConfigurationApi#deleteSystemConfiguration");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SystemConfigurationApi;

public class SystemConfigurationApiExample {
    public static void main(String[] args) {
        SystemConfigurationApi apiInstance = new SystemConfigurationApi();

        try {
            apiInstance.deleteSystemConfiguration();
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemConfigurationApi#deleteSystemConfiguration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemConfigurationApi *apiInstance = [[SystemConfigurationApi alloc] init];

// Delete all additional system configuration
[apiInstance deleteSystemConfigurationWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.SystemConfigurationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteSystemConfiguration(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteSystemConfigurationExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemConfigurationApi();

            try {
                // Delete all additional system configuration
                apiInstance.deleteSystemConfiguration();
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemConfigurationApi.deleteSystemConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemConfigurationApi();

try {
    $api_instance->deleteSystemConfiguration();
} catch (Exception $e) {
    echo 'Exception when calling SystemConfigurationApi->deleteSystemConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemConfigurationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemConfigurationApi->new();

eval {
    $api_instance->deleteSystemConfiguration();
};
if ($@) {
    warn "Exception when calling SystemConfigurationApi->deleteSystemConfiguration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemConfigurationApi()

try:
    # Delete all additional system configuration
    api_instance.delete_system_configuration()
except ApiException as e:
    print("Exception when calling SystemConfigurationApi->deleteSystemConfiguration: %s\n" % e)
extern crate SystemConfigurationApi;

pub fn main() {

    let mut context = SystemConfigurationApi::Context::default();
    let result = client.deleteSystemConfiguration(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getSystemConfiguration

Retrieve system configuration items


/systemConfiguration

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16006/api/v1/systemConfiguration?entries=["element1","element1,element2,element3"]"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemConfigurationApi;

import java.io.File;
import java.util.*;

public class SystemConfigurationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemConfigurationApi apiInstance = new SystemConfigurationApi();
        String entries = ["element1","element1,element2,element3"]; // String | Which parameters you want to retrieve

        try {
            array[List] result = apiInstance.getSystemConfiguration(entries);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemConfigurationApi#getSystemConfiguration");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SystemConfigurationApi;

public class SystemConfigurationApiExample {
    public static void main(String[] args) {
        SystemConfigurationApi apiInstance = new SystemConfigurationApi();
        String entries = ["element1","element1,element2,element3"]; // String | Which parameters you want to retrieve

        try {
            array[List] result = apiInstance.getSystemConfiguration(entries);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemConfigurationApi#getSystemConfiguration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemConfigurationApi *apiInstance = [[SystemConfigurationApi alloc] init];
String *entries = ["element1","element1,element2,element3"]; // Which parameters you want to retrieve (optional) (default to null)

// Retrieve system configuration items
[apiInstance getSystemConfigurationWith:entries
              completionHandler: ^(array[List] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.SystemConfigurationApi()
var opts = {
  'entries': ["element1","element1,element2,element3"] // {String} Which parameters you want to retrieve
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSystemConfiguration(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSystemConfigurationExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemConfigurationApi();
            var entries = ["element1","element1,element2,element3"];  // String | Which parameters you want to retrieve (optional)  (default to null)

            try {
                // Retrieve system configuration items
                array[List] result = apiInstance.getSystemConfiguration(entries);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemConfigurationApi.getSystemConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemConfigurationApi();
$entries = ["element1","element1,element2,element3"]; // String | Which parameters you want to retrieve

try {
    $result = $api_instance->getSystemConfiguration($entries);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemConfigurationApi->getSystemConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemConfigurationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemConfigurationApi->new();
my $entries = ["element1","element1,element2,element3"]; # String | Which parameters you want to retrieve

eval {
    my $result = $api_instance->getSystemConfiguration(entries => $entries);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemConfigurationApi->getSystemConfiguration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemConfigurationApi()
entries = ["element1","element1,element2,element3"] # String | Which parameters you want to retrieve (optional) (default to null)

try:
    # Retrieve system configuration items
    api_response = api_instance.get_system_configuration(entries=entries)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemConfigurationApi->getSystemConfiguration: %s\n" % e)
extern crate SystemConfigurationApi;

pub fn main() {
    let entries = ["element1","element1,element2,element3"]; // String

    let mut context = SystemConfigurationApi::Context::default();
    let result = client.getSystemConfiguration(entries, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
entries
String
Which parameters you want to retrieve

Responses


setSystemConfiguration

Set some or all system configuration


/systemConfiguration

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16006/api/v1/systemConfiguration" \
 -d '{
  "parameterName" : "parameterName",
  "parameterValue" : "parameterValue"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemConfigurationApi;

import java.io.File;
import java.util.*;

public class SystemConfigurationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemConfigurationApi apiInstance = new SystemConfigurationApi();
        array[ExtraSystemConfiguration_inner] extraSystemConfigurationInner = ; // array[ExtraSystemConfiguration_inner] | 

        try {
            apiInstance.setSystemConfiguration(extraSystemConfigurationInner);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemConfigurationApi#setSystemConfiguration");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SystemConfigurationApi;

public class SystemConfigurationApiExample {
    public static void main(String[] args) {
        SystemConfigurationApi apiInstance = new SystemConfigurationApi();
        array[ExtraSystemConfiguration_inner] extraSystemConfigurationInner = ; // array[ExtraSystemConfiguration_inner] | 

        try {
            apiInstance.setSystemConfiguration(extraSystemConfigurationInner);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemConfigurationApi#setSystemConfiguration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemConfigurationApi *apiInstance = [[SystemConfigurationApi alloc] init];
array[ExtraSystemConfiguration_inner] *extraSystemConfigurationInner = ; //  (optional)

// Set some or all system configuration
[apiInstance setSystemConfigurationWith:extraSystemConfigurationInner
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.SystemConfigurationApi()
var opts = {
  'extraSystemConfigurationInner':  // {array[ExtraSystemConfiguration_inner]} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setSystemConfiguration(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class setSystemConfigurationExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemConfigurationApi();
            var extraSystemConfigurationInner = new array[ExtraSystemConfiguration_inner](); // array[ExtraSystemConfiguration_inner] |  (optional) 

            try {
                // Set some or all system configuration
                apiInstance.setSystemConfiguration(extraSystemConfigurationInner);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemConfigurationApi.setSystemConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemConfigurationApi();
$extraSystemConfigurationInner = ; // array[ExtraSystemConfiguration_inner] | 

try {
    $api_instance->setSystemConfiguration($extraSystemConfigurationInner);
} catch (Exception $e) {
    echo 'Exception when calling SystemConfigurationApi->setSystemConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemConfigurationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemConfigurationApi->new();
my $extraSystemConfigurationInner = [WWW::OPenAPIClient::Object::array[ExtraSystemConfiguration_inner]->new()]; # array[ExtraSystemConfiguration_inner] | 

eval {
    $api_instance->setSystemConfiguration(extraSystemConfigurationInner => $extraSystemConfigurationInner);
};
if ($@) {
    warn "Exception when calling SystemConfigurationApi->setSystemConfiguration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemConfigurationApi()
extraSystemConfigurationInner =  # array[ExtraSystemConfiguration_inner] |  (optional)

try:
    # Set some or all system configuration
    api_instance.set_system_configuration(extraSystemConfigurationInner=extraSystemConfigurationInner)
except ApiException as e:
    print("Exception when calling SystemConfigurationApi->setSystemConfiguration: %s\n" % e)
extern crate SystemConfigurationApi;

pub fn main() {
    let extraSystemConfigurationInner = ; // array[ExtraSystemConfiguration_inner]

    let mut context = SystemConfigurationApi::Context::default();
    let result = client.setSystemConfiguration(extraSystemConfigurationInner, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
extraSystemConfigurationInner

Responses


WiFiClients

getWifiClients

Get the list of wired clients


/wificlients

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16006/api/v1/wificlients?serialNumber=serialNumber_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WiFiClientsApi;

import java.io.File;
import java.util.*;

public class WiFiClientsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        WiFiClientsApi apiInstance = new WiFiClientsApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            AssociationList result = apiInstance.getWifiClients(serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WiFiClientsApi#getWifiClients");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WiFiClientsApi;

public class WiFiClientsApiExample {
    public static void main(String[] args) {
        WiFiClientsApi apiInstance = new WiFiClientsApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            AssociationList result = apiInstance.getWifiClients(serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WiFiClientsApi#getWifiClients");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
WiFiClientsApi *apiInstance = [[WiFiClientsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)

// Get the list of wired clients
[apiInstance getWifiClientsWith:serialNumber
              completionHandler: ^(AssociationList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiUserPortal = require('open_wi_fi_user_portal');
var defaultClient = OpenWiFiUserPortal.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiUserPortal.WiFiClientsApi()
var serialNumber = serialNumber_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWifiClients(serialNumber, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getWifiClientsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new WiFiClientsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)

            try {
                // Get the list of wired clients
                AssociationList result = apiInstance.getWifiClients(serialNumber);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WiFiClientsApi.getWifiClients: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WiFiClientsApi();
$serialNumber = serialNumber_example; // String | 

try {
    $result = $api_instance->getWifiClients($serialNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WiFiClientsApi->getWifiClients: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WiFiClientsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WiFiClientsApi->new();
my $serialNumber = serialNumber_example; # String | 

eval {
    my $result = $api_instance->getWifiClients(serialNumber => $serialNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WiFiClientsApi->getWifiClients: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.WiFiClientsApi()
serialNumber = serialNumber_example # String |  (default to null)

try:
    # Get the list of wired clients
    api_response = api_instance.get_wifi_clients(serialNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WiFiClientsApi->getWifiClients: %s\n" % e)
extern crate WiFiClientsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String

    let mut context = WiFiClientsApi::Context::default();
    let result = client.getWifiClients(serialNumber, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
serialNumber*
String
Required

Responses