Waterly External User Directory API

Callbacks

roleUpdated

Waterly will call this API when a user's role is updated within Waterly


/roleUpdated

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/roleUpdated" \
 -d '{
  "systemId" : 10,
  "role" : "Operator",
  "systemName" : "Lake Zebra, IL",
  "action" : "Grant",
  "systemURL" : "https://app.waterlyapp.com/accounts/10",
  "userId" : "abc123"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CallbacksApi;

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

public class CallbacksApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        CallbacksApi apiInstance = new CallbacksApi();
        RoleUpdatedCallbackRequest roleUpdatedCallbackRequest = ; // RoleUpdatedCallbackRequest | 

        try {
            apiInstance.roleUpdated(roleUpdatedCallbackRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallbacksApi#roleUpdated");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CallbacksApi;

public class CallbacksApiExample {
    public static void main(String[] args) {
        CallbacksApi apiInstance = new CallbacksApi();
        RoleUpdatedCallbackRequest roleUpdatedCallbackRequest = ; // RoleUpdatedCallbackRequest | 

        try {
            apiInstance.roleUpdated(roleUpdatedCallbackRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallbacksApi#roleUpdated");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CallbacksApi *apiInstance = [[CallbacksApi alloc] init];
RoleUpdatedCallbackRequest *roleUpdatedCallbackRequest = ; //  (optional)

// Waterly will call this API when a user's role is updated within Waterly
[apiInstance roleUpdatedWith:roleUpdatedCallbackRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var WaterlyExternalUserDirectoryApi = require('waterly_external_user_directory_api');

// Create an instance of the API class
var api = new WaterlyExternalUserDirectoryApi.CallbacksApi()
var opts = {
  'roleUpdatedCallbackRequest':  // {RoleUpdatedCallbackRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.roleUpdated(opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class roleUpdatedExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new CallbacksApi();
            var roleUpdatedCallbackRequest = new RoleUpdatedCallbackRequest(); // RoleUpdatedCallbackRequest |  (optional) 

            try {
                // Waterly will call this API when a user's role is updated within Waterly
                apiInstance.roleUpdated(roleUpdatedCallbackRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling CallbacksApi.roleUpdated: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CallbacksApi();
$roleUpdatedCallbackRequest = ; // RoleUpdatedCallbackRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CallbacksApi->new();
my $roleUpdatedCallbackRequest = WWW::OPenAPIClient::Object::RoleUpdatedCallbackRequest->new(); # RoleUpdatedCallbackRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.CallbacksApi()
roleUpdatedCallbackRequest =  # RoleUpdatedCallbackRequest |  (optional)

try:
    # Waterly will call this API when a user's role is updated within Waterly
    api_instance.role_updated(roleUpdatedCallbackRequest=roleUpdatedCallbackRequest)
except ApiException as e:
    print("Exception when calling CallbacksApi->roleUpdated: %s\n" % e)
extern crate CallbacksApi;

pub fn main() {
    let roleUpdatedCallbackRequest = ; // RoleUpdatedCallbackRequest

    let mut context = CallbacksApi::Context::default();
    let result = client.roleUpdated(roleUpdatedCallbackRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
roleUpdatedCallbackRequest

Responses

Queries

lookupUser

Allows a user to lookup a single user by their external Id


/lookupById

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/lookupById" \
 -d '{
  "id" : "abc123"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.QueriesApi;

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

public class QueriesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        QueriesApi apiInstance = new QueriesApi();
        UserLookupRequest userLookupRequest = ; // UserLookupRequest | 

        try {
            User result = apiInstance.lookupUser(userLookupRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueriesApi#lookupUser");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.QueriesApi;

public class QueriesApiExample {
    public static void main(String[] args) {
        QueriesApi apiInstance = new QueriesApi();
        UserLookupRequest userLookupRequest = ; // UserLookupRequest | 

        try {
            User result = apiInstance.lookupUser(userLookupRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueriesApi#lookupUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
QueriesApi *apiInstance = [[QueriesApi alloc] init];
UserLookupRequest *userLookupRequest = ; //  (optional)

// Allows a user to lookup a single user by their external Id
[apiInstance lookupUserWith:userLookupRequest
              completionHandler: ^(User output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var WaterlyExternalUserDirectoryApi = require('waterly_external_user_directory_api');

// Create an instance of the API class
var api = new WaterlyExternalUserDirectoryApi.QueriesApi()
var opts = {
  'userLookupRequest':  // {UserLookupRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.lookupUser(opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class lookupUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new QueriesApi();
            var userLookupRequest = new UserLookupRequest(); // UserLookupRequest |  (optional) 

            try {
                // Allows a user to lookup a single user by their external Id
                User result = apiInstance.lookupUser(userLookupRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling QueriesApi.lookupUser: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\QueriesApi();
$userLookupRequest = ; // UserLookupRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::QueriesApi->new();
my $userLookupRequest = WWW::OPenAPIClient::Object::UserLookupRequest->new(); # UserLookupRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.QueriesApi()
userLookupRequest =  # UserLookupRequest |  (optional)

try:
    # Allows a user to lookup a single user by their external Id
    api_response = api_instance.lookup_user(userLookupRequest=userLookupRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueriesApi->lookupUser: %s\n" % e)
extern crate QueriesApi;

pub fn main() {
    let userLookupRequest = ; // UserLookupRequest

    let mut context = QueriesApi::Context::default();
    let result = client.lookupUser(userLookupRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
userLookupRequest

Responses

searchUsers

Allows a user to search the external user directory


/search

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/search" \
 -d '{
  "searchInput" : "Joe",
  "maxResults" : 10
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.QueriesApi;

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

public class QueriesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        QueriesApi apiInstance = new QueriesApi();
        UserSearchRequest userSearchRequest = ; // UserSearchRequest | 

        try {
            array[User] result = apiInstance.searchUsers(userSearchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueriesApi#searchUsers");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.QueriesApi;

public class QueriesApiExample {
    public static void main(String[] args) {
        QueriesApi apiInstance = new QueriesApi();
        UserSearchRequest userSearchRequest = ; // UserSearchRequest | 

        try {
            array[User] result = apiInstance.searchUsers(userSearchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueriesApi#searchUsers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
QueriesApi *apiInstance = [[QueriesApi alloc] init];
UserSearchRequest *userSearchRequest = ; //  (optional)

// Allows a user to search the external user directory
[apiInstance searchUsersWith:userSearchRequest
              completionHandler: ^(array[User] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var WaterlyExternalUserDirectoryApi = require('waterly_external_user_directory_api');

// Create an instance of the API class
var api = new WaterlyExternalUserDirectoryApi.QueriesApi()
var opts = {
  'userSearchRequest':  // {UserSearchRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchUsers(opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchUsersExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new QueriesApi();
            var userSearchRequest = new UserSearchRequest(); // UserSearchRequest |  (optional) 

            try {
                // Allows a user to search the external user directory
                array[User] result = apiInstance.searchUsers(userSearchRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling QueriesApi.searchUsers: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\QueriesApi();
$userSearchRequest = ; // UserSearchRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::QueriesApi->new();
my $userSearchRequest = WWW::OPenAPIClient::Object::UserSearchRequest->new(); # UserSearchRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.QueriesApi()
userSearchRequest =  # UserSearchRequest |  (optional)

try:
    # Allows a user to search the external user directory
    api_response = api_instance.search_users(userSearchRequest=userSearchRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueriesApi->searchUsers: %s\n" % e)
extern crate QueriesApi;

pub fn main() {
    let userSearchRequest = ; // UserSearchRequest

    let mut context = QueriesApi::Context::default();
    let result = client.searchUsers(userSearchRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
userSearchRequest

Responses