IAM REST Services

AnnexAffiliations

canEditAffiliate

Can Edit Affiliate

Returns true if IAM is the system of record for the person's data, false otherwise


/iam/resources/affiliates/{affiliateId}/canEditAttributes

Usage and SDK Samples

curl -X GET "BASE_URL/iam/resources/affiliates/{affiliateId}/canEditAttributes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnnexAffiliationsApi;

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

public class AnnexAffiliationsApiExample {

    public static void main(String[] args) {
        
        AnnexAffiliationsApi apiInstance = new AnnexAffiliationsApi();
        String affiliateId = affiliateId_example; // String | The affiliate's id, either ucsbCampusId or person_id
        String ucsbIdentityUit = ucsbIdentityUit_example; // String | User Identity Token
        try {
            'Boolean' result = apiInstance.canEditAffiliate(affiliateId, ucsbIdentityUit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnexAffiliationsApi#canEditAffiliate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnnexAffiliationsApi;

public class AnnexAffiliationsApiExample {

    public static void main(String[] args) {
        AnnexAffiliationsApi apiInstance = new AnnexAffiliationsApi();
        String affiliateId = affiliateId_example; // String | The affiliate's id, either ucsbCampusId or person_id
        String ucsbIdentityUit = ucsbIdentityUit_example; // String | User Identity Token
        try {
            'Boolean' result = apiInstance.canEditAffiliate(affiliateId, ucsbIdentityUit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnexAffiliationsApi#canEditAffiliate");
            e.printStackTrace();
        }
    }
}
String *affiliateId = affiliateId_example; // The affiliate's id, either ucsbCampusId or person_id
String *ucsbIdentityUit = ucsbIdentityUit_example; // User Identity Token (optional)

AnnexAffiliationsApi *apiInstance = [[AnnexAffiliationsApi alloc] init];

// Can Edit Affiliate
[apiInstance canEditAffiliateWith:affiliateId
    ucsbIdentityUit:ucsbIdentityUit
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.AnnexAffiliationsApi()
var affiliateId = affiliateId_example; // {{String}} The affiliate's id, either ucsbCampusId or person_id
var opts = { 
  'ucsbIdentityUit': ucsbIdentityUit_example // {{String}} User Identity Token
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.canEditAffiliate(affiliateId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AnnexAffiliationsApi();
            var affiliateId = affiliateId_example;  // String | The affiliate's id, either ucsbCampusId or person_id
            var ucsbIdentityUit = ucsbIdentityUit_example;  // String | User Identity Token (optional) 

            try
            {
                // Can Edit Affiliate
                'Boolean' result = apiInstance.canEditAffiliate(affiliateId, ucsbIdentityUit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnnexAffiliationsApi.canEditAffiliate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAnnexAffiliationsApi();
$affiliateId = affiliateId_example; // String | The affiliate's id, either ucsbCampusId or person_id
$ucsbIdentityUit = ucsbIdentityUit_example; // String | User Identity Token

try {
    $result = $api_instance->canEditAffiliate($affiliateId, $ucsbIdentityUit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnnexAffiliationsApi->canEditAffiliate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnnexAffiliationsApi;

my $api_instance = WWW::SwaggerClient::AnnexAffiliationsApi->new();
my $affiliateId = affiliateId_example; # String | The affiliate's id, either ucsbCampusId or person_id
my $ucsbIdentityUit = ucsbIdentityUit_example; # String | User Identity Token

eval { 
    my $result = $api_instance->canEditAffiliate(affiliateId => $affiliateId, ucsbIdentityUit => $ucsbIdentityUit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnnexAffiliationsApi->canEditAffiliate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AnnexAffiliationsApi()
affiliateId = affiliateId_example # String | The affiliate's id, either ucsbCampusId or person_id
ucsbIdentityUit = ucsbIdentityUit_example # String | User Identity Token (optional)

try: 
    # Can Edit Affiliate
    api_response = api_instance.can_edit_affiliate(affiliateId, ucsbIdentityUit=ucsbIdentityUit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnnexAffiliationsApi->canEditAffiliate: %s\n" % e)

Parameters

Path parameters
Name Description
affiliateId*
String
The affiliate's id, either ucsbCampusId or person_id
Required
Header parameters
Name Description
ucsb-identity-uit
String
User Identity Token

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getAffiliate

Get Annex Affiliate

Returns the annex affiliate data (one row for each affiliation) with the provided person's id. If this person does not have any annex affiliations an empty list is returned


/iam/resources/affiliates/{affiliateId}

Usage and SDK Samples

curl -X GET "BASE_URL/iam/resources/affiliates/{affiliateId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnnexAffiliationsApi;

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

public class AnnexAffiliationsApiExample {

    public static void main(String[] args) {
        
        AnnexAffiliationsApi apiInstance = new AnnexAffiliationsApi();
        String affiliateId = affiliateId_example; // String | The affiliate's id, either ucsbCampusId or person_id
        String ucsbIdentityUit = ucsbIdentityUit_example; // String | User Identity Token
        try {
            array[Affiliate] result = apiInstance.getAffiliate(affiliateId, ucsbIdentityUit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnexAffiliationsApi#getAffiliate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnnexAffiliationsApi;

public class AnnexAffiliationsApiExample {

    public static void main(String[] args) {
        AnnexAffiliationsApi apiInstance = new AnnexAffiliationsApi();
        String affiliateId = affiliateId_example; // String | The affiliate's id, either ucsbCampusId or person_id
        String ucsbIdentityUit = ucsbIdentityUit_example; // String | User Identity Token
        try {
            array[Affiliate] result = apiInstance.getAffiliate(affiliateId, ucsbIdentityUit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnexAffiliationsApi#getAffiliate");
            e.printStackTrace();
        }
    }
}
String *affiliateId = affiliateId_example; // The affiliate's id, either ucsbCampusId or person_id
String *ucsbIdentityUit = ucsbIdentityUit_example; // User Identity Token (optional)

AnnexAffiliationsApi *apiInstance = [[AnnexAffiliationsApi alloc] init];

// Get Annex Affiliate
[apiInstance getAffiliateWith:affiliateId
    ucsbIdentityUit:ucsbIdentityUit
              completionHandler: ^(array[Affiliate] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.AnnexAffiliationsApi()
var affiliateId = affiliateId_example; // {{String}} The affiliate's id, either ucsbCampusId or person_id
var opts = { 
  'ucsbIdentityUit': ucsbIdentityUit_example // {{String}} User Identity Token
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAffiliate(affiliateId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AnnexAffiliationsApi();
            var affiliateId = affiliateId_example;  // String | The affiliate's id, either ucsbCampusId or person_id
            var ucsbIdentityUit = ucsbIdentityUit_example;  // String | User Identity Token (optional) 

            try
            {
                // Get Annex Affiliate
                array[Affiliate] result = apiInstance.getAffiliate(affiliateId, ucsbIdentityUit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnnexAffiliationsApi.getAffiliate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAnnexAffiliationsApi();
$affiliateId = affiliateId_example; // String | The affiliate's id, either ucsbCampusId or person_id
$ucsbIdentityUit = ucsbIdentityUit_example; // String | User Identity Token

try {
    $result = $api_instance->getAffiliate($affiliateId, $ucsbIdentityUit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnnexAffiliationsApi->getAffiliate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnnexAffiliationsApi;

my $api_instance = WWW::SwaggerClient::AnnexAffiliationsApi->new();
my $affiliateId = affiliateId_example; # String | The affiliate's id, either ucsbCampusId or person_id
my $ucsbIdentityUit = ucsbIdentityUit_example; # String | User Identity Token

eval { 
    my $result = $api_instance->getAffiliate(affiliateId => $affiliateId, ucsbIdentityUit => $ucsbIdentityUit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnnexAffiliationsApi->getAffiliate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AnnexAffiliationsApi()
affiliateId = affiliateId_example # String | The affiliate's id, either ucsbCampusId or person_id
ucsbIdentityUit = ucsbIdentityUit_example # String | User Identity Token (optional)

try: 
    # Get Annex Affiliate
    api_response = api_instance.get_affiliate(affiliateId, ucsbIdentityUit=ucsbIdentityUit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnnexAffiliationsApi->getAffiliate: %s\n" % e)

Parameters

Path parameters
Name Description
affiliateId*
String
The affiliate's id, either ucsbCampusId or person_id
Required
Header parameters
Name Description
ucsb-identity-uit
String
User Identity Token

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getAffiliateOrPerson

Get Annex Affiliate or Person

Returns the annex affiliate data (one row for each affiliation) with the provided person's id. If this person does not have any annex affiliations the person's data is returned with the affilation data being null


/iam/resources/affiliates/affiliateorperson/{affiliateId}

Usage and SDK Samples

curl -X GET "BASE_URL/iam/resources/affiliates/affiliateorperson/{affiliateId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnnexAffiliationsApi;

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

public class AnnexAffiliationsApiExample {

    public static void main(String[] args) {
        
        AnnexAffiliationsApi apiInstance = new AnnexAffiliationsApi();
        String affiliateId = affiliateId_example; // String | The affiliate's id, either ucsbCampusId or person_id
        String ucsbIdentityUit = ucsbIdentityUit_example; // String | User Identity Token
        try {
            array[Affiliate] result = apiInstance.getAffiliateOrPerson(affiliateId, ucsbIdentityUit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnexAffiliationsApi#getAffiliateOrPerson");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnnexAffiliationsApi;

public class AnnexAffiliationsApiExample {

    public static void main(String[] args) {
        AnnexAffiliationsApi apiInstance = new AnnexAffiliationsApi();
        String affiliateId = affiliateId_example; // String | The affiliate's id, either ucsbCampusId or person_id
        String ucsbIdentityUit = ucsbIdentityUit_example; // String | User Identity Token
        try {
            array[Affiliate] result = apiInstance.getAffiliateOrPerson(affiliateId, ucsbIdentityUit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnexAffiliationsApi#getAffiliateOrPerson");
            e.printStackTrace();
        }
    }
}
String *affiliateId = affiliateId_example; // The affiliate's id, either ucsbCampusId or person_id
String *ucsbIdentityUit = ucsbIdentityUit_example; // User Identity Token (optional)

AnnexAffiliationsApi *apiInstance = [[AnnexAffiliationsApi alloc] init];

// Get Annex Affiliate or Person
[apiInstance getAffiliateOrPersonWith:affiliateId
    ucsbIdentityUit:ucsbIdentityUit
              completionHandler: ^(array[Affiliate] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.AnnexAffiliationsApi()
var affiliateId = affiliateId_example; // {{String}} The affiliate's id, either ucsbCampusId or person_id
var opts = { 
  'ucsbIdentityUit': ucsbIdentityUit_example // {{String}} User Identity Token
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAffiliateOrPerson(affiliateId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AnnexAffiliationsApi();
            var affiliateId = affiliateId_example;  // String | The affiliate's id, either ucsbCampusId or person_id
            var ucsbIdentityUit = ucsbIdentityUit_example;  // String | User Identity Token (optional) 

            try
            {
                // Get Annex Affiliate or Person
                array[Affiliate] result = apiInstance.getAffiliateOrPerson(affiliateId, ucsbIdentityUit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnnexAffiliationsApi.getAffiliateOrPerson: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAnnexAffiliationsApi();
$affiliateId = affiliateId_example; // String | The affiliate's id, either ucsbCampusId or person_id
$ucsbIdentityUit = ucsbIdentityUit_example; // String | User Identity Token

try {
    $result = $api_instance->getAffiliateOrPerson($affiliateId, $ucsbIdentityUit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnnexAffiliationsApi->getAffiliateOrPerson: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnnexAffiliationsApi;

my $api_instance = WWW::SwaggerClient::AnnexAffiliationsApi->new();
my $affiliateId = affiliateId_example; # String | The affiliate's id, either ucsbCampusId or person_id
my $ucsbIdentityUit = ucsbIdentityUit_example; # String | User Identity Token

eval { 
    my $result = $api_instance->getAffiliateOrPerson(affiliateId => $affiliateId, ucsbIdentityUit => $ucsbIdentityUit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnnexAffiliationsApi->getAffiliateOrPerson: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AnnexAffiliationsApi()
affiliateId = affiliateId_example # String | The affiliate's id, either ucsbCampusId or person_id
ucsbIdentityUit = ucsbIdentityUit_example # String | User Identity Token (optional)

try: 
    # Get Annex Affiliate or Person
    api_response = api_instance.get_affiliate_or_person(affiliateId, ucsbIdentityUit=ucsbIdentityUit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnnexAffiliationsApi->getAffiliateOrPerson: %s\n" % e)

Parameters

Path parameters
Name Description
affiliateId*
String
The affiliate's id, either ucsbCampusId or person_id
Required
Header parameters
Name Description
ucsb-identity-uit
String
User Identity Token

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


listAffiliates

List Annex Affiliates

Returns a list of annex affiliates


/iam/resources/affiliates

Usage and SDK Samples

curl -X GET "BASE_URL/iam/resources/affiliates?deptCode=&expiryInDaysInterval=&limit=&onlyTheLastLeftAffiliationToExpire=&page=&pattern=&status="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnnexAffiliationsApi;

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

public class AnnexAffiliationsApiExample {

    public static void main(String[] args) {
        
        AnnexAffiliationsApi apiInstance = new AnnexAffiliationsApi();
        array[String] deptCode = ; // array[String] | Department codes to filter on
        Integer expiryInDaysInterval = 56; // Integer | Only return affiliates that have affiliations expiring within this number of days
        Integer limit = 56; // Integer | The maximum number of records to return, default none, return all
        Boolean onlyTheLastLeftAffiliationToExpire = true; // Boolean | Only return affiliates where the expiring affiliation is the last one remaining
        Integer page = 56; // Integer | Page of data to return, default 0 (first page)
        String pattern = pattern_example; // String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
        array[String] status = ; // array[String] | Status codes to filter on
        String ucsbIdentityUit = ucsbIdentityUit_example; // String | User Identity Token
        try {
            array[Affiliate] result = apiInstance.listAffiliates(deptCode, expiryInDaysInterval, limit, onlyTheLastLeftAffiliationToExpire, page, pattern, status, ucsbIdentityUit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnexAffiliationsApi#listAffiliates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnnexAffiliationsApi;

public class AnnexAffiliationsApiExample {

    public static void main(String[] args) {
        AnnexAffiliationsApi apiInstance = new AnnexAffiliationsApi();
        array[String] deptCode = ; // array[String] | Department codes to filter on
        Integer expiryInDaysInterval = 56; // Integer | Only return affiliates that have affiliations expiring within this number of days
        Integer limit = 56; // Integer | The maximum number of records to return, default none, return all
        Boolean onlyTheLastLeftAffiliationToExpire = true; // Boolean | Only return affiliates where the expiring affiliation is the last one remaining
        Integer page = 56; // Integer | Page of data to return, default 0 (first page)
        String pattern = pattern_example; // String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
        array[String] status = ; // array[String] | Status codes to filter on
        String ucsbIdentityUit = ucsbIdentityUit_example; // String | User Identity Token
        try {
            array[Affiliate] result = apiInstance.listAffiliates(deptCode, expiryInDaysInterval, limit, onlyTheLastLeftAffiliationToExpire, page, pattern, status, ucsbIdentityUit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnexAffiliationsApi#listAffiliates");
            e.printStackTrace();
        }
    }
}
array[String] *deptCode = ; // Department codes to filter on (optional)
Integer *expiryInDaysInterval = 56; // Only return affiliates that have affiliations expiring within this number of days (optional)
Integer *limit = 56; // The maximum number of records to return, default none, return all (optional)
Boolean *onlyTheLastLeftAffiliationToExpire = true; // Only return affiliates where the expiring affiliation is the last one remaining (optional)
Integer *page = 56; // Page of data to return, default 0 (first page) (optional)
String *pattern = pattern_example; // The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options (optional)
array[String] *status = ; // Status codes to filter on (optional)
String *ucsbIdentityUit = ucsbIdentityUit_example; // User Identity Token (optional)

AnnexAffiliationsApi *apiInstance = [[AnnexAffiliationsApi alloc] init];

// List Annex Affiliates
[apiInstance listAffiliatesWith:deptCode
    expiryInDaysInterval:expiryInDaysInterval
    limit:limit
    onlyTheLastLeftAffiliationToExpire:onlyTheLastLeftAffiliationToExpire
    page:page
    pattern:pattern
    status:status
    ucsbIdentityUit:ucsbIdentityUit
              completionHandler: ^(array[Affiliate] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.AnnexAffiliationsApi()
var opts = { 
  'deptCode': , // {{array[String]}} Department codes to filter on
  'expiryInDaysInterval': 56, // {{Integer}} Only return affiliates that have affiliations expiring within this number of days
  'limit': 56, // {{Integer}} The maximum number of records to return, default none, return all
  'onlyTheLastLeftAffiliationToExpire': true, // {{Boolean}} Only return affiliates where the expiring affiliation is the last one remaining
  'page': 56, // {{Integer}} Page of data to return, default 0 (first page)
  'pattern': pattern_example, // {{String}} The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
  'status': , // {{array[String]}} Status codes to filter on
  'ucsbIdentityUit': ucsbIdentityUit_example // {{String}} User Identity Token
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAffiliates(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AnnexAffiliationsApi();
            var deptCode = new array[String](); // array[String] | Department codes to filter on (optional) 
            var expiryInDaysInterval = 56;  // Integer | Only return affiliates that have affiliations expiring within this number of days (optional) 
            var limit = 56;  // Integer | The maximum number of records to return, default none, return all (optional) 
            var onlyTheLastLeftAffiliationToExpire = true;  // Boolean | Only return affiliates where the expiring affiliation is the last one remaining (optional) 
            var page = 56;  // Integer | Page of data to return, default 0 (first page) (optional) 
            var pattern = pattern_example;  // String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options (optional) 
            var status = new array[String](); // array[String] | Status codes to filter on (optional) 
            var ucsbIdentityUit = ucsbIdentityUit_example;  // String | User Identity Token (optional) 

            try
            {
                // List Annex Affiliates
                array[Affiliate] result = apiInstance.listAffiliates(deptCode, expiryInDaysInterval, limit, onlyTheLastLeftAffiliationToExpire, page, pattern, status, ucsbIdentityUit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnnexAffiliationsApi.listAffiliates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAnnexAffiliationsApi();
$deptCode = ; // array[String] | Department codes to filter on
$expiryInDaysInterval = 56; // Integer | Only return affiliates that have affiliations expiring within this number of days
$limit = 56; // Integer | The maximum number of records to return, default none, return all
$onlyTheLastLeftAffiliationToExpire = true; // Boolean | Only return affiliates where the expiring affiliation is the last one remaining
$page = 56; // Integer | Page of data to return, default 0 (first page)
$pattern = pattern_example; // String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
$status = ; // array[String] | Status codes to filter on
$ucsbIdentityUit = ucsbIdentityUit_example; // String | User Identity Token

try {
    $result = $api_instance->listAffiliates($deptCode, $expiryInDaysInterval, $limit, $onlyTheLastLeftAffiliationToExpire, $page, $pattern, $status, $ucsbIdentityUit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnnexAffiliationsApi->listAffiliates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnnexAffiliationsApi;

my $api_instance = WWW::SwaggerClient::AnnexAffiliationsApi->new();
my $deptCode = []; # array[String] | Department codes to filter on
my $expiryInDaysInterval = 56; # Integer | Only return affiliates that have affiliations expiring within this number of days
my $limit = 56; # Integer | The maximum number of records to return, default none, return all
my $onlyTheLastLeftAffiliationToExpire = true; # Boolean | Only return affiliates where the expiring affiliation is the last one remaining
my $page = 56; # Integer | Page of data to return, default 0 (first page)
my $pattern = pattern_example; # String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
my $status = []; # array[String] | Status codes to filter on
my $ucsbIdentityUit = ucsbIdentityUit_example; # String | User Identity Token

eval { 
    my $result = $api_instance->listAffiliates(deptCode => $deptCode, expiryInDaysInterval => $expiryInDaysInterval, limit => $limit, onlyTheLastLeftAffiliationToExpire => $onlyTheLastLeftAffiliationToExpire, page => $page, pattern => $pattern, status => $status, ucsbIdentityUit => $ucsbIdentityUit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnnexAffiliationsApi->listAffiliates: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AnnexAffiliationsApi()
deptCode =  # array[String] | Department codes to filter on (optional)
expiryInDaysInterval = 56 # Integer | Only return affiliates that have affiliations expiring within this number of days (optional)
limit = 56 # Integer | The maximum number of records to return, default none, return all (optional)
onlyTheLastLeftAffiliationToExpire = true # Boolean | Only return affiliates where the expiring affiliation is the last one remaining (optional)
page = 56 # Integer | Page of data to return, default 0 (first page) (optional)
pattern = pattern_example # String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options (optional)
status =  # array[String] | Status codes to filter on (optional)
ucsbIdentityUit = ucsbIdentityUit_example # String | User Identity Token (optional)

try: 
    # List Annex Affiliates
    api_response = api_instance.list_affiliates(deptCode=deptCode, expiryInDaysInterval=expiryInDaysInterval, limit=limit, onlyTheLastLeftAffiliationToExpire=onlyTheLastLeftAffiliationToExpire, page=page, pattern=pattern, status=status, ucsbIdentityUit=ucsbIdentityUit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnnexAffiliationsApi->listAffiliates: %s\n" % e)

Parameters

Header parameters
Name Description
ucsb-identity-uit
String
User Identity Token
Query parameters
Name Description
deptCode
array[String]
Department codes to filter on
expiryInDaysInterval
Integer (int32)
Only return affiliates that have affiliations expiring within this number of days
limit
Integer (int32)
The maximum number of records to return, default none, return all
onlyTheLastLeftAffiliationToExpire
Boolean
Only return affiliates where the expiring affiliation is the last one remaining
page
Integer (int32)
Page of data to return, default 0 (first page)
pattern
String
The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
status
array[String]
Status codes to filter on

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


listAnnexAffiliations

List Annex Affiliations

Returns a list of annex affiliations, if a department code is specified it's the annex affiliations for that department


/iam/resources/affiliates/annexAffiliations

Usage and SDK Samples

curl -X GET "BASE_URL/iam/resources/affiliates/annexAffiliations?deptCode="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnnexAffiliationsApi;

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

public class AnnexAffiliationsApiExample {

    public static void main(String[] args) {
        
        AnnexAffiliationsApi apiInstance = new AnnexAffiliationsApi();
        String deptCode = deptCode_example; // String | The department code to filter on
        String ucsbIdentityUit = ucsbIdentityUit_example; // String | User Identity Token
        try {
            array[AnnexAffiliation] result = apiInstance.listAnnexAffiliations(deptCode, ucsbIdentityUit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnexAffiliationsApi#listAnnexAffiliations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnnexAffiliationsApi;

public class AnnexAffiliationsApiExample {

    public static void main(String[] args) {
        AnnexAffiliationsApi apiInstance = new AnnexAffiliationsApi();
        String deptCode = deptCode_example; // String | The department code to filter on
        String ucsbIdentityUit = ucsbIdentityUit_example; // String | User Identity Token
        try {
            array[AnnexAffiliation] result = apiInstance.listAnnexAffiliations(deptCode, ucsbIdentityUit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnexAffiliationsApi#listAnnexAffiliations");
            e.printStackTrace();
        }
    }
}
String *deptCode = deptCode_example; // The department code to filter on (optional)
String *ucsbIdentityUit = ucsbIdentityUit_example; // User Identity Token (optional)

AnnexAffiliationsApi *apiInstance = [[AnnexAffiliationsApi alloc] init];

// List Annex Affiliations
[apiInstance listAnnexAffiliationsWith:deptCode
    ucsbIdentityUit:ucsbIdentityUit
              completionHandler: ^(array[AnnexAffiliation] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.AnnexAffiliationsApi()
var opts = { 
  'deptCode': deptCode_example, // {{String}} The department code to filter on
  'ucsbIdentityUit': ucsbIdentityUit_example // {{String}} User Identity Token
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAnnexAffiliations(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AnnexAffiliationsApi();
            var deptCode = deptCode_example;  // String | The department code to filter on (optional) 
            var ucsbIdentityUit = ucsbIdentityUit_example;  // String | User Identity Token (optional) 

            try
            {
                // List Annex Affiliations
                array[AnnexAffiliation] result = apiInstance.listAnnexAffiliations(deptCode, ucsbIdentityUit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnnexAffiliationsApi.listAnnexAffiliations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAnnexAffiliationsApi();
$deptCode = deptCode_example; // String | The department code to filter on
$ucsbIdentityUit = ucsbIdentityUit_example; // String | User Identity Token

try {
    $result = $api_instance->listAnnexAffiliations($deptCode, $ucsbIdentityUit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnnexAffiliationsApi->listAnnexAffiliations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnnexAffiliationsApi;

my $api_instance = WWW::SwaggerClient::AnnexAffiliationsApi->new();
my $deptCode = deptCode_example; # String | The department code to filter on
my $ucsbIdentityUit = ucsbIdentityUit_example; # String | User Identity Token

eval { 
    my $result = $api_instance->listAnnexAffiliations(deptCode => $deptCode, ucsbIdentityUit => $ucsbIdentityUit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnnexAffiliationsApi->listAnnexAffiliations: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AnnexAffiliationsApi()
deptCode = deptCode_example # String | The department code to filter on (optional)
ucsbIdentityUit = ucsbIdentityUit_example # String | User Identity Token (optional)

try: 
    # List Annex Affiliations
    api_response = api_instance.list_annex_affiliations(deptCode=deptCode, ucsbIdentityUit=ucsbIdentityUit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnnexAffiliationsApi->listAnnexAffiliations: %s\n" % e)

Parameters

Header parameters
Name Description
ucsb-identity-uit
String
User Identity Token
Query parameters
Name Description
deptCode
String
The department code to filter on

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Directory

findAccounts

Find accounts

Returns a list of accounts matching the search criteria and the account types filter


/directory/accounts

Usage and SDK Samples

curl -X GET "BASE_URL/directory/accounts?page=&pageSize=&pattern=&searchAllNames=&types="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DirectoryApi;

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

public class DirectoryApiExample {

    public static void main(String[] args) {
        
        DirectoryApi apiInstance = new DirectoryApi();
        String page = page_example; // String | Page of data to return, default 0 (first page)
        String pageSize = pageSize_example; // String | The maximum number of records to return, default 12
        String pattern = pattern_example; // String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
        Boolean searchAllNames = true; // Boolean | Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false
        String types = types_example; // String | A comma delimited list of account types to search for, e.g. employee or functional. Defaults to searching for employee and functional accounts
        try {
            array[DirectoryEntry] result = apiInstance.findAccounts(page, pageSize, pattern, searchAllNames, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DirectoryApi#findAccounts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DirectoryApi;

public class DirectoryApiExample {

    public static void main(String[] args) {
        DirectoryApi apiInstance = new DirectoryApi();
        String page = page_example; // String | Page of data to return, default 0 (first page)
        String pageSize = pageSize_example; // String | The maximum number of records to return, default 12
        String pattern = pattern_example; // String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
        Boolean searchAllNames = true; // Boolean | Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false
        String types = types_example; // String | A comma delimited list of account types to search for, e.g. employee or functional. Defaults to searching for employee and functional accounts
        try {
            array[DirectoryEntry] result = apiInstance.findAccounts(page, pageSize, pattern, searchAllNames, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DirectoryApi#findAccounts");
            e.printStackTrace();
        }
    }
}
String *page = page_example; // Page of data to return, default 0 (first page) (optional)
String *pageSize = pageSize_example; // The maximum number of records to return, default 12 (optional)
String *pattern = pattern_example; // The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options (optional)
Boolean *searchAllNames = true; // Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false (optional)
String *types = types_example; // A comma delimited list of account types to search for, e.g. employee or functional. Defaults to searching for employee and functional accounts (optional)

DirectoryApi *apiInstance = [[DirectoryApi alloc] init];

// Find accounts
[apiInstance findAccountsWith:page
    pageSize:pageSize
    pattern:pattern
    searchAllNames:searchAllNames
    types:types
              completionHandler: ^(array[DirectoryEntry] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.DirectoryApi()
var opts = { 
  'page': page_example, // {{String}} Page of data to return, default 0 (first page)
  'pageSize': pageSize_example, // {{String}} The maximum number of records to return, default 12
  'pattern': pattern_example, // {{String}} The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
  'searchAllNames': true, // {{Boolean}} Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false
  'types': types_example // {{String}} A comma delimited list of account types to search for, e.g. employee or functional. Defaults to searching for employee and functional accounts
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAccounts(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DirectoryApi();
            var page = page_example;  // String | Page of data to return, default 0 (first page) (optional) 
            var pageSize = pageSize_example;  // String | The maximum number of records to return, default 12 (optional) 
            var pattern = pattern_example;  // String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options (optional) 
            var searchAllNames = true;  // Boolean | Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false (optional) 
            var types = types_example;  // String | A comma delimited list of account types to search for, e.g. employee or functional. Defaults to searching for employee and functional accounts (optional) 

            try
            {
                // Find accounts
                array[DirectoryEntry] result = apiInstance.findAccounts(page, pageSize, pattern, searchAllNames, types);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DirectoryApi.findAccounts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDirectoryApi();
$page = page_example; // String | Page of data to return, default 0 (first page)
$pageSize = pageSize_example; // String | The maximum number of records to return, default 12
$pattern = pattern_example; // String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
$searchAllNames = true; // Boolean | Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false
$types = types_example; // String | A comma delimited list of account types to search for, e.g. employee or functional. Defaults to searching for employee and functional accounts

try {
    $result = $api_instance->findAccounts($page, $pageSize, $pattern, $searchAllNames, $types);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectoryApi->findAccounts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DirectoryApi;

my $api_instance = WWW::SwaggerClient::DirectoryApi->new();
my $page = page_example; # String | Page of data to return, default 0 (first page)
my $pageSize = pageSize_example; # String | The maximum number of records to return, default 12
my $pattern = pattern_example; # String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
my $searchAllNames = true; # Boolean | Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false
my $types = types_example; # String | A comma delimited list of account types to search for, e.g. employee or functional. Defaults to searching for employee and functional accounts

eval { 
    my $result = $api_instance->findAccounts(page => $page, pageSize => $pageSize, pattern => $pattern, searchAllNames => $searchAllNames, types => $types);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DirectoryApi->findAccounts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DirectoryApi()
page = page_example # String | Page of data to return, default 0 (first page) (optional)
pageSize = pageSize_example # String | The maximum number of records to return, default 12 (optional)
pattern = pattern_example # String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options (optional)
searchAllNames = true # Boolean | Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false (optional)
types = types_example # String | A comma delimited list of account types to search for, e.g. employee or functional. Defaults to searching for employee and functional accounts (optional)

try: 
    # Find accounts
    api_response = api_instance.find_accounts(page=page, pageSize=pageSize, pattern=pattern, searchAllNames=searchAllNames, types=types)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DirectoryApi->findAccounts: %s\n" % e)

Parameters

Query parameters
Name Description
page
String
Page of data to return, default 0 (first page)
pageSize
String
The maximum number of records to return, default 12
pattern
String
The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
searchAllNames
Boolean
Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false
types
String
A comma delimited list of account types to search for, e.g. employee or functional. Defaults to searching for employee and functional accounts

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


findDepartmentMembers

Find Department Members

Returns the members of a department


/directory/department/{dept}

Usage and SDK Samples

curl -X GET "BASE_URL/directory/department/{dept}?page=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DirectoryApi;

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

public class DirectoryApiExample {

    public static void main(String[] args) {
        
        DirectoryApi apiInstance = new DirectoryApi();
        String dept = dept_example; // String | The department
        String page = page_example; // String | Page of data to return, default 0 (first page)
        String pageSize = pageSize_example; // String | The maximum number of records to return, default 12
        try {
            array[DirectoryEntry] result = apiInstance.findDepartmentMembers(dept, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DirectoryApi#findDepartmentMembers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DirectoryApi;

public class DirectoryApiExample {

    public static void main(String[] args) {
        DirectoryApi apiInstance = new DirectoryApi();
        String dept = dept_example; // String | The department
        String page = page_example; // String | Page of data to return, default 0 (first page)
        String pageSize = pageSize_example; // String | The maximum number of records to return, default 12
        try {
            array[DirectoryEntry] result = apiInstance.findDepartmentMembers(dept, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DirectoryApi#findDepartmentMembers");
            e.printStackTrace();
        }
    }
}
String *dept = dept_example; // The department
String *page = page_example; // Page of data to return, default 0 (first page) (optional)
String *pageSize = pageSize_example; // The maximum number of records to return, default 12 (optional)

DirectoryApi *apiInstance = [[DirectoryApi alloc] init];

// Find Department Members
[apiInstance findDepartmentMembersWith:dept
    page:page
    pageSize:pageSize
              completionHandler: ^(array[DirectoryEntry] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.DirectoryApi()
var dept = dept_example; // {{String}} The department
var opts = { 
  'page': page_example, // {{String}} Page of data to return, default 0 (first page)
  'pageSize': pageSize_example // {{String}} The maximum number of records to return, default 12
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findDepartmentMembers(dept, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DirectoryApi();
            var dept = dept_example;  // String | The department
            var page = page_example;  // String | Page of data to return, default 0 (first page) (optional) 
            var pageSize = pageSize_example;  // String | The maximum number of records to return, default 12 (optional) 

            try
            {
                // Find Department Members
                array[DirectoryEntry] result = apiInstance.findDepartmentMembers(dept, page, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DirectoryApi.findDepartmentMembers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDirectoryApi();
$dept = dept_example; // String | The department
$page = page_example; // String | Page of data to return, default 0 (first page)
$pageSize = pageSize_example; // String | The maximum number of records to return, default 12

try {
    $result = $api_instance->findDepartmentMembers($dept, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectoryApi->findDepartmentMembers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DirectoryApi;

my $api_instance = WWW::SwaggerClient::DirectoryApi->new();
my $dept = dept_example; # String | The department
my $page = page_example; # String | Page of data to return, default 0 (first page)
my $pageSize = pageSize_example; # String | The maximum number of records to return, default 12

eval { 
    my $result = $api_instance->findDepartmentMembers(dept => $dept, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DirectoryApi->findDepartmentMembers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DirectoryApi()
dept = dept_example # String | The department
page = page_example # String | Page of data to return, default 0 (first page) (optional)
pageSize = pageSize_example # String | The maximum number of records to return, default 12 (optional)

try: 
    # Find Department Members
    api_response = api_instance.find_department_members(dept, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DirectoryApi->findDepartmentMembers: %s\n" % e)

Parameters

Path parameters
Name Description
dept*
String
The department
Required
Query parameters
Name Description
page
String
Page of data to return, default 0 (first page)
pageSize
String
The maximum number of records to return, default 12

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


findEmployees

Find Employees

Returns a list of the employees matching the search criteria


/directory/employees

Usage and SDK Samples

curl -X GET "BASE_URL/directory/employees?page=&pageSize=&pattern=&searchAllNames="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DirectoryApi;

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

public class DirectoryApiExample {

    public static void main(String[] args) {
        
        DirectoryApi apiInstance = new DirectoryApi();
        String page = page_example; // String | Page of data to return, default 0 (first page)
        String pageSize = pageSize_example; // String | The maximum number of records to return, default 12
        String pattern = pattern_example; // String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
        Boolean searchAllNames = true; // Boolean | Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false
        try {
            array[DirectoryEntry] result = apiInstance.findEmployees(page, pageSize, pattern, searchAllNames);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DirectoryApi#findEmployees");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DirectoryApi;

public class DirectoryApiExample {

    public static void main(String[] args) {
        DirectoryApi apiInstance = new DirectoryApi();
        String page = page_example; // String | Page of data to return, default 0 (first page)
        String pageSize = pageSize_example; // String | The maximum number of records to return, default 12
        String pattern = pattern_example; // String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
        Boolean searchAllNames = true; // Boolean | Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false
        try {
            array[DirectoryEntry] result = apiInstance.findEmployees(page, pageSize, pattern, searchAllNames);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DirectoryApi#findEmployees");
            e.printStackTrace();
        }
    }
}
String *page = page_example; // Page of data to return, default 0 (first page) (optional)
String *pageSize = pageSize_example; // The maximum number of records to return, default 12 (optional)
String *pattern = pattern_example; // The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options (optional)
Boolean *searchAllNames = true; // Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false (optional)

DirectoryApi *apiInstance = [[DirectoryApi alloc] init];

// Find Employees
[apiInstance findEmployeesWith:page
    pageSize:pageSize
    pattern:pattern
    searchAllNames:searchAllNames
              completionHandler: ^(array[DirectoryEntry] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.DirectoryApi()
var opts = { 
  'page': page_example, // {{String}} Page of data to return, default 0 (first page)
  'pageSize': pageSize_example, // {{String}} The maximum number of records to return, default 12
  'pattern': pattern_example, // {{String}} The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
  'searchAllNames': true // {{Boolean}} Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findEmployees(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DirectoryApi();
            var page = page_example;  // String | Page of data to return, default 0 (first page) (optional) 
            var pageSize = pageSize_example;  // String | The maximum number of records to return, default 12 (optional) 
            var pattern = pattern_example;  // String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options (optional) 
            var searchAllNames = true;  // Boolean | Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false (optional) 

            try
            {
                // Find Employees
                array[DirectoryEntry] result = apiInstance.findEmployees(page, pageSize, pattern, searchAllNames);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DirectoryApi.findEmployees: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDirectoryApi();
$page = page_example; // String | Page of data to return, default 0 (first page)
$pageSize = pageSize_example; // String | The maximum number of records to return, default 12
$pattern = pattern_example; // String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
$searchAllNames = true; // Boolean | Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false

try {
    $result = $api_instance->findEmployees($page, $pageSize, $pattern, $searchAllNames);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectoryApi->findEmployees: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DirectoryApi;

my $api_instance = WWW::SwaggerClient::DirectoryApi->new();
my $page = page_example; # String | Page of data to return, default 0 (first page)
my $pageSize = pageSize_example; # String | The maximum number of records to return, default 12
my $pattern = pattern_example; # String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
my $searchAllNames = true; # Boolean | Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false

eval { 
    my $result = $api_instance->findEmployees(page => $page, pageSize => $pageSize, pattern => $pattern, searchAllNames => $searchAllNames);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DirectoryApi->findEmployees: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DirectoryApi()
page = page_example # String | Page of data to return, default 0 (first page) (optional)
pageSize = pageSize_example # String | The maximum number of records to return, default 12 (optional)
pattern = pattern_example # String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options (optional)
searchAllNames = true # Boolean | Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false (optional)

try: 
    # Find Employees
    api_response = api_instance.find_employees(page=page, pageSize=pageSize, pattern=pattern, searchAllNames=searchAllNames)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DirectoryApi->findEmployees: %s\n" % e)

Parameters

Query parameters
Name Description
page
String
Page of data to return, default 0 (first page)
pageSize
String
The maximum number of records to return, default 12
pattern
String
The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
searchAllNames
Boolean
Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


listDepartments

List Departments

Returns the departments matching the filter, only departments that have members are returned


/directory/departments

Usage and SDK Samples

curl -X GET "BASE_URL/directory/departments?limit=&pattern="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DirectoryApi;

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

public class DirectoryApiExample {

    public static void main(String[] args) {
        
        DirectoryApi apiInstance = new DirectoryApi();
        Integer limit = 56; // Integer | The maximum number of records to return, default 12
        String pattern = pattern_example; // String | The filter criteria for searching, optional, if empty all departments are returned
        try {
            array[Department] result = apiInstance.listDepartments(limit, pattern);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DirectoryApi#listDepartments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DirectoryApi;

public class DirectoryApiExample {

    public static void main(String[] args) {
        DirectoryApi apiInstance = new DirectoryApi();
        Integer limit = 56; // Integer | The maximum number of records to return, default 12
        String pattern = pattern_example; // String | The filter criteria for searching, optional, if empty all departments are returned
        try {
            array[Department] result = apiInstance.listDepartments(limit, pattern);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DirectoryApi#listDepartments");
            e.printStackTrace();
        }
    }
}
Integer *limit = 56; // The maximum number of records to return, default 12 (optional)
String *pattern = pattern_example; // The filter criteria for searching, optional, if empty all departments are returned (optional)

DirectoryApi *apiInstance = [[DirectoryApi alloc] init];

// List Departments
[apiInstance listDepartmentsWith:limit
    pattern:pattern
              completionHandler: ^(array[Department] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.DirectoryApi()
var opts = { 
  'limit': 56, // {{Integer}} The maximum number of records to return, default 12
  'pattern': pattern_example // {{String}} The filter criteria for searching, optional, if empty all departments are returned
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listDepartments(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DirectoryApi();
            var limit = 56;  // Integer | The maximum number of records to return, default 12 (optional) 
            var pattern = pattern_example;  // String | The filter criteria for searching, optional, if empty all departments are returned (optional) 

            try
            {
                // List Departments
                array[Department] result = apiInstance.listDepartments(limit, pattern);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DirectoryApi.listDepartments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDirectoryApi();
$limit = 56; // Integer | The maximum number of records to return, default 12
$pattern = pattern_example; // String | The filter criteria for searching, optional, if empty all departments are returned

try {
    $result = $api_instance->listDepartments($limit, $pattern);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectoryApi->listDepartments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DirectoryApi;

my $api_instance = WWW::SwaggerClient::DirectoryApi->new();
my $limit = 56; # Integer | The maximum number of records to return, default 12
my $pattern = pattern_example; # String | The filter criteria for searching, optional, if empty all departments are returned

eval { 
    my $result = $api_instance->listDepartments(limit => $limit, pattern => $pattern);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DirectoryApi->listDepartments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DirectoryApi()
limit = 56 # Integer | The maximum number of records to return, default 12 (optional)
pattern = pattern_example # String | The filter criteria for searching, optional, if empty all departments are returned (optional)

try: 
    # List Departments
    api_response = api_instance.list_departments(limit=limit, pattern=pattern)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DirectoryApi->listDepartments: %s\n" % e)

Parameters

Query parameters
Name Description
limit
Integer (int32)
The maximum number of records to return, default 12
pattern
String
The filter criteria for searching, optional, if empty all departments are returned

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


GroupTags

countGroupTagMembers

Count Group Tag Members


/groupTags/{tagId}/members/count

Usage and SDK Samples

curl -X GET "BASE_URL/groupTags/{tagId}/members/count"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupTagsApi;

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

public class GroupTagsApiExample {

    public static void main(String[] args) {
        
        GroupTagsApi apiInstance = new GroupTagsApi();
        Integer tagId = 56; // Integer | The Group Tag id
        try {
            'Integer' result = apiInstance.countGroupTagMembers(tagId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupTagsApi#countGroupTagMembers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupTagsApi;

public class GroupTagsApiExample {

    public static void main(String[] args) {
        GroupTagsApi apiInstance = new GroupTagsApi();
        Integer tagId = 56; // Integer | The Group Tag id
        try {
            'Integer' result = apiInstance.countGroupTagMembers(tagId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupTagsApi#countGroupTagMembers");
            e.printStackTrace();
        }
    }
}
Integer *tagId = 56; // The Group Tag id

GroupTagsApi *apiInstance = [[GroupTagsApi alloc] init];

// Count Group Tag Members
[apiInstance countGroupTagMembersWith:tagId
              completionHandler: ^('Integer' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.GroupTagsApi()
var tagId = 56; // {{Integer}} The Group Tag id

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

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

            var apiInstance = new GroupTagsApi();
            var tagId = 56;  // Integer | The Group Tag id

            try
            {
                // Count Group Tag Members
                'Integer' result = apiInstance.countGroupTagMembers(tagId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupTagsApi.countGroupTagMembers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiGroupTagsApi();
$tagId = 56; // Integer | The Group Tag id

try {
    $result = $api_instance->countGroupTagMembers($tagId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupTagsApi->countGroupTagMembers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupTagsApi;

my $api_instance = WWW::SwaggerClient::GroupTagsApi->new();
my $tagId = 56; # Integer | The Group Tag id

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

# create an instance of the API class
api_instance = swagger_client.GroupTagsApi()
tagId = 56 # Integer | The Group Tag id

try: 
    # Count Group Tag Members
    api_response = api_instance.count_group_tag_members(tagId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupTagsApi->countGroupTagMembers: %s\n" % e)

Parameters

Path parameters
Name Description
tagId*
Integer (int32)
The Group Tag id
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getGroupTagDetails

Get Group Tag

Returns the Group Tag with the given tag id


/groupTags/{tagId}

Usage and SDK Samples

curl -X GET "BASE_URL/groupTags/{tagId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupTagsApi;

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

public class GroupTagsApiExample {

    public static void main(String[] args) {
        
        GroupTagsApi apiInstance = new GroupTagsApi();
        Integer tagId = 56; // Integer | The Group Tag id
        try {
            GroupTag result = apiInstance.getGroupTagDetails(tagId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupTagsApi#getGroupTagDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupTagsApi;

public class GroupTagsApiExample {

    public static void main(String[] args) {
        GroupTagsApi apiInstance = new GroupTagsApi();
        Integer tagId = 56; // Integer | The Group Tag id
        try {
            GroupTag result = apiInstance.getGroupTagDetails(tagId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupTagsApi#getGroupTagDetails");
            e.printStackTrace();
        }
    }
}
Integer *tagId = 56; // The Group Tag id

GroupTagsApi *apiInstance = [[GroupTagsApi alloc] init];

// Get Group Tag
[apiInstance getGroupTagDetailsWith:tagId
              completionHandler: ^(GroupTag output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.GroupTagsApi()
var tagId = 56; // {{Integer}} The Group Tag id

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

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

            var apiInstance = new GroupTagsApi();
            var tagId = 56;  // Integer | The Group Tag id

            try
            {
                // Get Group Tag
                GroupTag result = apiInstance.getGroupTagDetails(tagId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupTagsApi.getGroupTagDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiGroupTagsApi();
$tagId = 56; // Integer | The Group Tag id

try {
    $result = $api_instance->getGroupTagDetails($tagId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupTagsApi->getGroupTagDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupTagsApi;

my $api_instance = WWW::SwaggerClient::GroupTagsApi->new();
my $tagId = 56; # Integer | The Group Tag id

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

# create an instance of the API class
api_instance = swagger_client.GroupTagsApi()
tagId = 56 # Integer | The Group Tag id

try: 
    # Get Group Tag
    api_response = api_instance.get_group_tag_details(tagId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupTagsApi->getGroupTagDetails: %s\n" % e)

Parameters

Path parameters
Name Description
tagId*
Integer (int32)
The Group Tag id
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


listGroupTagMembers

List Group Tag Memebers

Returns a list of the Group Tag members


/groupTags/{tagId}/members

Usage and SDK Samples

curl -X GET "BASE_URL/groupTags/{tagId}/members?limit=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupTagsApi;

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

public class GroupTagsApiExample {

    public static void main(String[] args) {
        
        GroupTagsApi apiInstance = new GroupTagsApi();
        Integer tagId = 56; // Integer | The Group Tag id
        Integer limit = 56; // Integer | The maximum number or records to return, defaults to 40
        Integer offset = 56; // Integer | Offset for data to return, default 0 (first page)
        try {
            array[FoundPersonAttr] result = apiInstance.listGroupTagMembers(tagId, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupTagsApi#listGroupTagMembers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupTagsApi;

public class GroupTagsApiExample {

    public static void main(String[] args) {
        GroupTagsApi apiInstance = new GroupTagsApi();
        Integer tagId = 56; // Integer | The Group Tag id
        Integer limit = 56; // Integer | The maximum number or records to return, defaults to 40
        Integer offset = 56; // Integer | Offset for data to return, default 0 (first page)
        try {
            array[FoundPersonAttr] result = apiInstance.listGroupTagMembers(tagId, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupTagsApi#listGroupTagMembers");
            e.printStackTrace();
        }
    }
}
Integer *tagId = 56; // The Group Tag id
Integer *limit = 56; // The maximum number or records to return, defaults to 40 (optional)
Integer *offset = 56; // Offset for data to return, default 0 (first page) (optional)

GroupTagsApi *apiInstance = [[GroupTagsApi alloc] init];

// List Group Tag Memebers
[apiInstance listGroupTagMembersWith:tagId
    limit:limit
    offset:offset
              completionHandler: ^(array[FoundPersonAttr] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.GroupTagsApi()
var tagId = 56; // {{Integer}} The Group Tag id
var opts = { 
  'limit': 56, // {{Integer}} The maximum number or records to return, defaults to 40
  'offset': 56 // {{Integer}} Offset for data to return, default 0 (first page)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listGroupTagMembers(tagId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new GroupTagsApi();
            var tagId = 56;  // Integer | The Group Tag id
            var limit = 56;  // Integer | The maximum number or records to return, defaults to 40 (optional) 
            var offset = 56;  // Integer | Offset for data to return, default 0 (first page) (optional) 

            try
            {
                // List Group Tag Memebers
                array[FoundPersonAttr] result = apiInstance.listGroupTagMembers(tagId, limit, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupTagsApi.listGroupTagMembers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiGroupTagsApi();
$tagId = 56; // Integer | The Group Tag id
$limit = 56; // Integer | The maximum number or records to return, defaults to 40
$offset = 56; // Integer | Offset for data to return, default 0 (first page)

try {
    $result = $api_instance->listGroupTagMembers($tagId, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupTagsApi->listGroupTagMembers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupTagsApi;

my $api_instance = WWW::SwaggerClient::GroupTagsApi->new();
my $tagId = 56; # Integer | The Group Tag id
my $limit = 56; # Integer | The maximum number or records to return, defaults to 40
my $offset = 56; # Integer | Offset for data to return, default 0 (first page)

eval { 
    my $result = $api_instance->listGroupTagMembers(tagId => $tagId, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupTagsApi->listGroupTagMembers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.GroupTagsApi()
tagId = 56 # Integer | The Group Tag id
limit = 56 # Integer | The maximum number or records to return, defaults to 40 (optional)
offset = 56 # Integer | Offset for data to return, default 0 (first page) (optional)

try: 
    # List Group Tag Memebers
    api_response = api_instance.list_group_tag_members(tagId, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupTagsApi->listGroupTagMembers: %s\n" % e)

Parameters

Path parameters
Name Description
tagId*
Integer (int32)
The Group Tag id
Required
Query parameters
Name Description
limit
Integer (int32)
The maximum number or records to return, defaults to 40
offset
Integer (int32)
Offset for data to return, default 0 (first page)

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


listGroupTags

List Group Tags

Returns the Group Tag's name or description match the pattern passed. If an owner id is included the results only include Group Tags owned by this user


/groupTags

Usage and SDK Samples

curl -X GET "BASE_URL/groupTags?limit=&member=&owner=&pattern="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupTagsApi;

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

public class GroupTagsApiExample {

    public static void main(String[] args) {
        
        GroupTagsApi apiInstance = new GroupTagsApi();
        Integer limit = 56; // Integer | The maximum number or records to return, defaults to 40
        String member = member_example; // String | The member UCSB campus id to filter on
        String owner = owner_example; // String | The owner UCSB campus id to filter on
        String pattern = pattern_example; // String | The short name and description to filter on
        try {
            array[GroupTag] result = apiInstance.listGroupTags(limit, member, owner, pattern);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupTagsApi#listGroupTags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupTagsApi;

public class GroupTagsApiExample {

    public static void main(String[] args) {
        GroupTagsApi apiInstance = new GroupTagsApi();
        Integer limit = 56; // Integer | The maximum number or records to return, defaults to 40
        String member = member_example; // String | The member UCSB campus id to filter on
        String owner = owner_example; // String | The owner UCSB campus id to filter on
        String pattern = pattern_example; // String | The short name and description to filter on
        try {
            array[GroupTag] result = apiInstance.listGroupTags(limit, member, owner, pattern);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupTagsApi#listGroupTags");
            e.printStackTrace();
        }
    }
}
Integer *limit = 56; // The maximum number or records to return, defaults to 40 (optional)
String *member = member_example; // The member UCSB campus id to filter on (optional)
String *owner = owner_example; // The owner UCSB campus id to filter on (optional)
String *pattern = pattern_example; // The short name and description to filter on (optional)

GroupTagsApi *apiInstance = [[GroupTagsApi alloc] init];

// List Group Tags
[apiInstance listGroupTagsWith:limit
    member:member
    owner:owner
    pattern:pattern
              completionHandler: ^(array[GroupTag] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.GroupTagsApi()
var opts = { 
  'limit': 56, // {{Integer}} The maximum number or records to return, defaults to 40
  'member': member_example, // {{String}} The member UCSB campus id to filter on
  'owner': owner_example, // {{String}} The owner UCSB campus id to filter on
  'pattern': pattern_example // {{String}} The short name and description to filter on
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listGroupTags(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new GroupTagsApi();
            var limit = 56;  // Integer | The maximum number or records to return, defaults to 40 (optional) 
            var member = member_example;  // String | The member UCSB campus id to filter on (optional) 
            var owner = owner_example;  // String | The owner UCSB campus id to filter on (optional) 
            var pattern = pattern_example;  // String | The short name and description to filter on (optional) 

            try
            {
                // List Group Tags
                array[GroupTag] result = apiInstance.listGroupTags(limit, member, owner, pattern);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupTagsApi.listGroupTags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiGroupTagsApi();
$limit = 56; // Integer | The maximum number or records to return, defaults to 40
$member = member_example; // String | The member UCSB campus id to filter on
$owner = owner_example; // String | The owner UCSB campus id to filter on
$pattern = pattern_example; // String | The short name and description to filter on

try {
    $result = $api_instance->listGroupTags($limit, $member, $owner, $pattern);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupTagsApi->listGroupTags: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupTagsApi;

my $api_instance = WWW::SwaggerClient::GroupTagsApi->new();
my $limit = 56; # Integer | The maximum number or records to return, defaults to 40
my $member = member_example; # String | The member UCSB campus id to filter on
my $owner = owner_example; # String | The owner UCSB campus id to filter on
my $pattern = pattern_example; # String | The short name and description to filter on

eval { 
    my $result = $api_instance->listGroupTags(limit => $limit, member => $member, owner => $owner, pattern => $pattern);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupTagsApi->listGroupTags: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.GroupTagsApi()
limit = 56 # Integer | The maximum number or records to return, defaults to 40 (optional)
member = member_example # String | The member UCSB campus id to filter on (optional)
owner = owner_example # String | The owner UCSB campus id to filter on (optional)
pattern = pattern_example # String | The short name and description to filter on (optional)

try: 
    # List Group Tags
    api_response = api_instance.list_group_tags(limit=limit, member=member, owner=owner, pattern=pattern)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupTagsApi->listGroupTags: %s\n" % e)

Parameters

Query parameters
Name Description
limit
Integer (int32)
The maximum number or records to return, defaults to 40
member
String
The member UCSB campus id to filter on
owner
String
The owner UCSB campus id to filter on
pattern
String
The short name and description to filter on

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


IAMResources

findDepartments

List Departments

Returns the departments matching the filter


/resources/departments

Usage and SDK Samples

curl -X GET "BASE_URL/resources/departments?limit=&pattern="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IAMResourcesApi;

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

public class IAMResourcesApiExample {

    public static void main(String[] args) {
        
        IAMResourcesApi apiInstance = new IAMResourcesApi();
        Integer limit = 56; // Integer | The maximum number of records to return, default 12
        String pattern = pattern_example; // String | The filter criteria for searching, optional, if empty all departments are returned
        try {
            array[Department] result = apiInstance.findDepartments(limit, pattern);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IAMResourcesApi#findDepartments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IAMResourcesApi;

public class IAMResourcesApiExample {

    public static void main(String[] args) {
        IAMResourcesApi apiInstance = new IAMResourcesApi();
        Integer limit = 56; // Integer | The maximum number of records to return, default 12
        String pattern = pattern_example; // String | The filter criteria for searching, optional, if empty all departments are returned
        try {
            array[Department] result = apiInstance.findDepartments(limit, pattern);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IAMResourcesApi#findDepartments");
            e.printStackTrace();
        }
    }
}
Integer *limit = 56; // The maximum number of records to return, default 12 (optional)
String *pattern = pattern_example; // The filter criteria for searching, optional, if empty all departments are returned (optional)

IAMResourcesApi *apiInstance = [[IAMResourcesApi alloc] init];

// List Departments
[apiInstance findDepartmentsWith:limit
    pattern:pattern
              completionHandler: ^(array[Department] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.IAMResourcesApi()
var opts = { 
  'limit': 56, // {{Integer}} The maximum number of records to return, default 12
  'pattern': pattern_example // {{String}} The filter criteria for searching, optional, if empty all departments are returned
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findDepartments(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new IAMResourcesApi();
            var limit = 56;  // Integer | The maximum number of records to return, default 12 (optional) 
            var pattern = pattern_example;  // String | The filter criteria for searching, optional, if empty all departments are returned (optional) 

            try
            {
                // List Departments
                array[Department] result = apiInstance.findDepartments(limit, pattern);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IAMResourcesApi.findDepartments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiIAMResourcesApi();
$limit = 56; // Integer | The maximum number of records to return, default 12
$pattern = pattern_example; // String | The filter criteria for searching, optional, if empty all departments are returned

try {
    $result = $api_instance->findDepartments($limit, $pattern);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IAMResourcesApi->findDepartments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IAMResourcesApi;

my $api_instance = WWW::SwaggerClient::IAMResourcesApi->new();
my $limit = 56; # Integer | The maximum number of records to return, default 12
my $pattern = pattern_example; # String | The filter criteria for searching, optional, if empty all departments are returned

eval { 
    my $result = $api_instance->findDepartments(limit => $limit, pattern => $pattern);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IAMResourcesApi->findDepartments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.IAMResourcesApi()
limit = 56 # Integer | The maximum number of records to return, default 12 (optional)
pattern = pattern_example # String | The filter criteria for searching, optional, if empty all departments are returned (optional)

try: 
    # List Departments
    api_response = api_instance.find_departments(limit=limit, pattern=pattern)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IAMResourcesApi->findDepartments: %s\n" % e)

Parameters

Query parameters
Name Description
limit
Integer (int32)
The maximum number of records to return, default 12
pattern
String
The filter criteria for searching, optional, if empty all departments are returned

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getDepartmentByCode

Get Department by Code

Returns The department with the given department code


/resources/departments/{code}

Usage and SDK Samples

curl -X GET "BASE_URL/resources/departments/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IAMResourcesApi;

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

public class IAMResourcesApiExample {

    public static void main(String[] args) {
        
        IAMResourcesApi apiInstance = new IAMResourcesApi();
        String code = code_example; // String | The department code to filter on
        try {
            Department result = apiInstance.getDepartmentByCode(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IAMResourcesApi#getDepartmentByCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IAMResourcesApi;

public class IAMResourcesApiExample {

    public static void main(String[] args) {
        IAMResourcesApi apiInstance = new IAMResourcesApi();
        String code = code_example; // String | The department code to filter on
        try {
            Department result = apiInstance.getDepartmentByCode(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IAMResourcesApi#getDepartmentByCode");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // The department code to filter on

IAMResourcesApi *apiInstance = [[IAMResourcesApi alloc] init];

// Get Department by Code
[apiInstance getDepartmentByCodeWith:code
              completionHandler: ^(Department output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.IAMResourcesApi()
var code = code_example; // {{String}} The department code to filter on

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

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

            var apiInstance = new IAMResourcesApi();
            var code = code_example;  // String | The department code to filter on

            try
            {
                // Get Department by Code
                Department result = apiInstance.getDepartmentByCode(code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IAMResourcesApi.getDepartmentByCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiIAMResourcesApi();
$code = code_example; // String | The department code to filter on

try {
    $result = $api_instance->getDepartmentByCode($code);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IAMResourcesApi->getDepartmentByCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IAMResourcesApi;

my $api_instance = WWW::SwaggerClient::IAMResourcesApi->new();
my $code = code_example; # String | The department code to filter on

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

# create an instance of the API class
api_instance = swagger_client.IAMResourcesApi()
code = code_example # String | The department code to filter on

try: 
    # Get Department by Code
    api_response = api_instance.get_department_by_code(code)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IAMResourcesApi->getDepartmentByCode: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
The department code to filter on
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


User

findDDEByDepartmentCode

Get department delegated editors

Returns a list of the delegated department editor for a department


/users/dde/{deptCode}

Usage and SDK Samples

curl -X GET "BASE_URL/users/dde/{deptCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

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

public class UserApiExample {

    public static void main(String[] args) {
        
        UserApi apiInstance = new UserApi();
        String deptCode = deptCode_example; // String | The department code
        try {
            array[FoundPersonAttr] result = apiInstance.findDDEByDepartmentCode(deptCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#findDDEByDepartmentCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String deptCode = deptCode_example; // String | The department code
        try {
            array[FoundPersonAttr] result = apiInstance.findDDEByDepartmentCode(deptCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#findDDEByDepartmentCode");
            e.printStackTrace();
        }
    }
}
String *deptCode = deptCode_example; // The department code

UserApi *apiInstance = [[UserApi alloc] init];

// Get department delegated editors
[apiInstance findDDEByDepartmentCodeWith:deptCode
              completionHandler: ^(array[FoundPersonAttr] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.UserApi()
var deptCode = deptCode_example; // {{String}} The department code

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

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

            var apiInstance = new UserApi();
            var deptCode = deptCode_example;  // String | The department code

            try
            {
                // Get department delegated editors
                array[FoundPersonAttr] result = apiInstance.findDDEByDepartmentCode(deptCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.findDDEByDepartmentCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserApi();
$deptCode = deptCode_example; // String | The department code

try {
    $result = $api_instance->findDDEByDepartmentCode($deptCode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->findDDEByDepartmentCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $deptCode = deptCode_example; # String | The department code

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

# create an instance of the API class
api_instance = swagger_client.UserApi()
deptCode = deptCode_example # String | The department code

try: 
    # Get department delegated editors
    api_response = api_instance.find_dde_by_department_code(deptCode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->findDDEByDepartmentCode: %s\n" % e)

Parameters

Path parameters
Name Description
deptCode*
String
The department code
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


listDDEAuthorizedDepartments

Lists the departments for which the user is a delegated department editor

Returns a list of the department codes for which the user is a delegated department editor


/users/{ucsbCampusId}/dde/departments

Usage and SDK Samples

curl -X GET "BASE_URL/users/{ucsbCampusId}/dde/departments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

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

public class UserApiExample {

    public static void main(String[] args) {
        
        UserApi apiInstance = new UserApi();
        String ucsbCampusId = ucsbCampusId_example; // String | The user's ucsbCampusId
        try {
            array['String'] result = apiInstance.listDDEAuthorizedDepartments(ucsbCampusId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#listDDEAuthorizedDepartments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String ucsbCampusId = ucsbCampusId_example; // String | The user's ucsbCampusId
        try {
            array['String'] result = apiInstance.listDDEAuthorizedDepartments(ucsbCampusId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#listDDEAuthorizedDepartments");
            e.printStackTrace();
        }
    }
}
String *ucsbCampusId = ucsbCampusId_example; // The user's ucsbCampusId

UserApi *apiInstance = [[UserApi alloc] init];

// Lists the departments for which the user is a delegated department editor
[apiInstance listDDEAuthorizedDepartmentsWith:ucsbCampusId
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.UserApi()
var ucsbCampusId = ucsbCampusId_example; // {{String}} The user's ucsbCampusId

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

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

            var apiInstance = new UserApi();
            var ucsbCampusId = ucsbCampusId_example;  // String | The user's ucsbCampusId

            try
            {
                // Lists the departments for which the user is a delegated department editor
                array['String'] result = apiInstance.listDDEAuthorizedDepartments(ucsbCampusId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.listDDEAuthorizedDepartments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserApi();
$ucsbCampusId = ucsbCampusId_example; // String | The user's ucsbCampusId

try {
    $result = $api_instance->listDDEAuthorizedDepartments($ucsbCampusId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->listDDEAuthorizedDepartments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $ucsbCampusId = ucsbCampusId_example; # String | The user's ucsbCampusId

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

# create an instance of the API class
api_instance = swagger_client.UserApi()
ucsbCampusId = ucsbCampusId_example # String | The user's ucsbCampusId

try: 
    # Lists the departments for which the user is a delegated department editor
    api_response = api_instance.list_dde_authorized_departments(ucsbCampusId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->listDDEAuthorizedDepartments: %s\n" % e)

Parameters

Path parameters
Name Description
ucsbCampusId*
String
The user's ucsbCampusId
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


normalizeName

Get normalized name

Takes a name as input and returns the normalized version of it, for example aLIce is normalized to Alice


/users/normalized-name

Usage and SDK Samples

curl -X PUT "BASE_URL/users/normalized-name"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

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

public class UserApiExample {

    public static void main(String[] args) {
        
        UserApi apiInstance = new UserApi();
        Body body = ; // Body | A map containing the name to normalize with "name" as the key
        try {
            Map result = apiInstance.normalizeName(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#normalizeName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        Body body = ; // Body | A map containing the name to normalize with "name" as the key
        try {
            Map result = apiInstance.normalizeName(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#normalizeName");
            e.printStackTrace();
        }
    }
}
Body *body = ; // A map containing the name to normalize with "name" as the key (optional)

UserApi *apiInstance = [[UserApi alloc] init];

// Get normalized name
[apiInstance normalizeNameWith:body
              completionHandler: ^(Map output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.UserApi()

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

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

            var apiInstance = new UserApi();
            var body = new Body(); // Body | A map containing the name to normalize with "name" as the key (optional) 

            try
            {
                // Get normalized name
                Map result = apiInstance.normalizeName(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.normalizeName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserApi();
$body = ; // Body | A map containing the name to normalize with "name" as the key

try {
    $result = $api_instance->normalizeName($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->normalizeName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $body = WWW::SwaggerClient::Object::Body->new(); # Body | A map containing the name to normalize with "name" as the key

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

# create an instance of the API class
api_instance = swagger_client.UserApi()
body =  # Body | A map containing the name to normalize with "name" as the key (optional)

try: 
    # Get normalized name
    api_response = api_instance.normalize_name(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->normalizeName: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


UserAffiliations

listAllAffiliationsRemovedUser

List users that have had all their affiliations removed

Returns a list users that have had all their affiliations removed


/affiliate/readonly/affiliations/removed

Usage and SDK Samples

curl -X GET "BASE_URL/affiliate/readonly/affiliations/removed?dateFilter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserAffiliationsApi;

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

public class UserAffiliationsApiExample {

    public static void main(String[] args) {
        
        UserAffiliationsApi apiInstance = new UserAffiliationsApi();
        String dateFilter = dateFilter_example; // String | Date filter, only returns users that have had their last affiliation removed since this time. Either number of days back to filter on (default 0) which is today, or a date in yyyy-mm-dd format
        try {
            array[LastAffiliationRemoved] result = apiInstance.listAllAffiliationsRemovedUser(dateFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAffiliationsApi#listAllAffiliationsRemovedUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserAffiliationsApi;

public class UserAffiliationsApiExample {

    public static void main(String[] args) {
        UserAffiliationsApi apiInstance = new UserAffiliationsApi();
        String dateFilter = dateFilter_example; // String | Date filter, only returns users that have had their last affiliation removed since this time. Either number of days back to filter on (default 0) which is today, or a date in yyyy-mm-dd format
        try {
            array[LastAffiliationRemoved] result = apiInstance.listAllAffiliationsRemovedUser(dateFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAffiliationsApi#listAllAffiliationsRemovedUser");
            e.printStackTrace();
        }
    }
}
String *dateFilter = dateFilter_example; // Date filter, only returns users that have had their last affiliation removed since this time. Either number of days back to filter on (default 0) which is today, or a date in yyyy-mm-dd format (optional)

UserAffiliationsApi *apiInstance = [[UserAffiliationsApi alloc] init];

// List users that have had all their affiliations removed
[apiInstance listAllAffiliationsRemovedUserWith:dateFilter
              completionHandler: ^(array[LastAffiliationRemoved] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.UserAffiliationsApi()
var opts = { 
  'dateFilter': dateFilter_example // {{String}} Date filter, only returns users that have had their last affiliation removed since this time. Either number of days back to filter on (default 0) which is today, or a date in yyyy-mm-dd format
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllAffiliationsRemovedUser(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UserAffiliationsApi();
            var dateFilter = dateFilter_example;  // String | Date filter, only returns users that have had their last affiliation removed since this time. Either number of days back to filter on (default 0) which is today, or a date in yyyy-mm-dd format (optional) 

            try
            {
                // List users that have had all their affiliations removed
                array[LastAffiliationRemoved] result = apiInstance.listAllAffiliationsRemovedUser(dateFilter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserAffiliationsApi.listAllAffiliationsRemovedUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserAffiliationsApi();
$dateFilter = dateFilter_example; // String | Date filter, only returns users that have had their last affiliation removed since this time. Either number of days back to filter on (default 0) which is today, or a date in yyyy-mm-dd format

try {
    $result = $api_instance->listAllAffiliationsRemovedUser($dateFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserAffiliationsApi->listAllAffiliationsRemovedUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserAffiliationsApi;

my $api_instance = WWW::SwaggerClient::UserAffiliationsApi->new();
my $dateFilter = dateFilter_example; # String | Date filter, only returns users that have had their last affiliation removed since this time. Either number of days back to filter on (default 0) which is today, or a date in yyyy-mm-dd format

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

# create an instance of the API class
api_instance = swagger_client.UserAffiliationsApi()
dateFilter = dateFilter_example # String | Date filter, only returns users that have had their last affiliation removed since this time. Either number of days back to filter on (default 0) which is today, or a date in yyyy-mm-dd format (optional)

try: 
    # List users that have had all their affiliations removed
    api_response = api_instance.list_all_affiliations_removed_user(dateFilter=dateFilter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserAffiliationsApi->listAllAffiliationsRemovedUser: %s\n" % e)

Parameters

Query parameters
Name Description
dateFilter
String
Date filter, only returns users that have had their last affiliation removed since this time. Either number of days back to filter on (default 0) which is today, or a date in yyyy-mm-dd format

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


UserReadonly

findEmployeesUserData

Find Employees User Dat

Returns a list of the employees matching the search criteria


/people/readonly/employees

Usage and SDK Samples

curl -X GET "BASE_URL/people/readonly/employees?page=&pageSize=&pattern=&searchAllNames="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserReadonlyApi;

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

public class UserReadonlyApiExample {

    public static void main(String[] args) {
        
        UserReadonlyApi apiInstance = new UserReadonlyApi();
        String page = page_example; // String | Page of data to return, default 0 (first page)
        String pageSize = pageSize_example; // String | The maximum number of records to return, default 100
        String pattern = pattern_example; // String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
        Boolean searchAllNames = true; // Boolean | Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false
        try {
            array[UserEntry] result = apiInstance.findEmployeesUserData(page, pageSize, pattern, searchAllNames);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserReadonlyApi#findEmployeesUserData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserReadonlyApi;

public class UserReadonlyApiExample {

    public static void main(String[] args) {
        UserReadonlyApi apiInstance = new UserReadonlyApi();
        String page = page_example; // String | Page of data to return, default 0 (first page)
        String pageSize = pageSize_example; // String | The maximum number of records to return, default 100
        String pattern = pattern_example; // String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
        Boolean searchAllNames = true; // Boolean | Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false
        try {
            array[UserEntry] result = apiInstance.findEmployeesUserData(page, pageSize, pattern, searchAllNames);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserReadonlyApi#findEmployeesUserData");
            e.printStackTrace();
        }
    }
}
String *page = page_example; // Page of data to return, default 0 (first page) (optional)
String *pageSize = pageSize_example; // The maximum number of records to return, default 100 (optional)
String *pattern = pattern_example; // The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options (optional)
Boolean *searchAllNames = true; // Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false (optional)

UserReadonlyApi *apiInstance = [[UserReadonlyApi alloc] init];

// Find Employees User Dat
[apiInstance findEmployeesUserDataWith:page
    pageSize:pageSize
    pattern:pattern
    searchAllNames:searchAllNames
              completionHandler: ^(array[UserEntry] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.UserReadonlyApi()
var opts = { 
  'page': page_example, // {{String}} Page of data to return, default 0 (first page)
  'pageSize': pageSize_example, // {{String}} The maximum number of records to return, default 100
  'pattern': pattern_example, // {{String}} The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
  'searchAllNames': true // {{Boolean}} Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findEmployeesUserData(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UserReadonlyApi();
            var page = page_example;  // String | Page of data to return, default 0 (first page) (optional) 
            var pageSize = pageSize_example;  // String | The maximum number of records to return, default 100 (optional) 
            var pattern = pattern_example;  // String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options (optional) 
            var searchAllNames = true;  // Boolean | Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false (optional) 

            try
            {
                // Find Employees User Dat
                array[UserEntry] result = apiInstance.findEmployeesUserData(page, pageSize, pattern, searchAllNames);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserReadonlyApi.findEmployeesUserData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserReadonlyApi();
$page = page_example; // String | Page of data to return, default 0 (first page)
$pageSize = pageSize_example; // String | The maximum number of records to return, default 100
$pattern = pattern_example; // String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
$searchAllNames = true; // Boolean | Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false

try {
    $result = $api_instance->findEmployeesUserData($page, $pageSize, $pattern, $searchAllNames);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserReadonlyApi->findEmployeesUserData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserReadonlyApi;

my $api_instance = WWW::SwaggerClient::UserReadonlyApi->new();
my $page = page_example; # String | Page of data to return, default 0 (first page)
my $pageSize = pageSize_example; # String | The maximum number of records to return, default 100
my $pattern = pattern_example; # String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
my $searchAllNames = true; # Boolean | Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false

eval { 
    my $result = $api_instance->findEmployeesUserData(page => $page, pageSize => $pageSize, pattern => $pattern, searchAllNames => $searchAllNames);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserReadonlyApi->findEmployeesUserData: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UserReadonlyApi()
page = page_example # String | Page of data to return, default 0 (first page) (optional)
pageSize = pageSize_example # String | The maximum number of records to return, default 100 (optional)
pattern = pattern_example # String | The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options (optional)
searchAllNames = true # Boolean | Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false (optional)

try: 
    # Find Employees User Dat
    api_response = api_instance.find_employees_user_data(page=page, pageSize=pageSize, pattern=pattern, searchAllNames=searchAllNames)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserReadonlyApi->findEmployeesUserData: %s\n" % e)

Parameters

Query parameters
Name Description
page
String
Page of data to return, default 0 (first page)
pageSize
String
The maximum number of records to return, default 100
pattern
String
The search pattern, e.g. lastName or lastName,firstName. For all options see Advanced Search Options
searchAllNames
Boolean
Boolean that indicates that a single name should be used to match against any name. Must be true, false or empty, default false

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getUserIdentityStatusByUcsbNetId

Get user identity status by netId

Returns the identity status of the user with a given netId


/people/readonly/{ucsbNetId}/status

Usage and SDK Samples

curl -X GET "BASE_URL/people/readonly/{ucsbNetId}/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserReadonlyApi;

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

public class UserReadonlyApiExample {

    public static void main(String[] args) {
        
        UserReadonlyApi apiInstance = new UserReadonlyApi();
        String ucsbNetId = ucsbNetId_example; // String | The user's ucsbNetId
        try {
            StatusResponse result = apiInstance.getUserIdentityStatusByUcsbNetId(ucsbNetId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserReadonlyApi#getUserIdentityStatusByUcsbNetId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserReadonlyApi;

public class UserReadonlyApiExample {

    public static void main(String[] args) {
        UserReadonlyApi apiInstance = new UserReadonlyApi();
        String ucsbNetId = ucsbNetId_example; // String | The user's ucsbNetId
        try {
            StatusResponse result = apiInstance.getUserIdentityStatusByUcsbNetId(ucsbNetId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserReadonlyApi#getUserIdentityStatusByUcsbNetId");
            e.printStackTrace();
        }
    }
}
String *ucsbNetId = ucsbNetId_example; // The user's ucsbNetId

UserReadonlyApi *apiInstance = [[UserReadonlyApi alloc] init];

// Get user identity status by netId
[apiInstance getUserIdentityStatusByUcsbNetIdWith:ucsbNetId
              completionHandler: ^(StatusResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.UserReadonlyApi()
var ucsbNetId = ucsbNetId_example; // {{String}} The user's ucsbNetId

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

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

            var apiInstance = new UserReadonlyApi();
            var ucsbNetId = ucsbNetId_example;  // String | The user's ucsbNetId

            try
            {
                // Get user identity status by netId
                StatusResponse result = apiInstance.getUserIdentityStatusByUcsbNetId(ucsbNetId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserReadonlyApi.getUserIdentityStatusByUcsbNetId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserReadonlyApi();
$ucsbNetId = ucsbNetId_example; // String | The user's ucsbNetId

try {
    $result = $api_instance->getUserIdentityStatusByUcsbNetId($ucsbNetId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserReadonlyApi->getUserIdentityStatusByUcsbNetId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserReadonlyApi;

my $api_instance = WWW::SwaggerClient::UserReadonlyApi->new();
my $ucsbNetId = ucsbNetId_example; # String | The user's ucsbNetId

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

# create an instance of the API class
api_instance = swagger_client.UserReadonlyApi()
ucsbNetId = ucsbNetId_example # String | The user's ucsbNetId

try: 
    # Get user identity status by netId
    api_response = api_instance.get_user_identity_status_by_ucsb_net_id(ucsbNetId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserReadonlyApi->getUserIdentityStatusByUcsbNetId: %s\n" % e)

Parameters

Path parameters
Name Description
ucsbNetId*
String
The user's ucsbNetId
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getUserRecordByUserId

Get user identity status by netId

Returns the identity status of the user with a given identifier


/people/readonly/{userId}

Usage and SDK Samples

curl -X GET "BASE_URL/people/readonly/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserReadonlyApi;

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

public class UserReadonlyApiExample {

    public static void main(String[] args) {
        
        UserReadonlyApi apiInstance = new UserReadonlyApi();
        String userId = userId_example; // String | An identifier for the user, could be the user's ucsbCampusId, netId or database primary key
        try {
            UserRecord result = apiInstance.getUserRecordByUserId(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserReadonlyApi#getUserRecordByUserId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserReadonlyApi;

public class UserReadonlyApiExample {

    public static void main(String[] args) {
        UserReadonlyApi apiInstance = new UserReadonlyApi();
        String userId = userId_example; // String | An identifier for the user, could be the user's ucsbCampusId, netId or database primary key
        try {
            UserRecord result = apiInstance.getUserRecordByUserId(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserReadonlyApi#getUserRecordByUserId");
            e.printStackTrace();
        }
    }
}
String *userId = userId_example; // An identifier for the user, could be the user's ucsbCampusId, netId or database primary key

UserReadonlyApi *apiInstance = [[UserReadonlyApi alloc] init];

// Get user identity status by netId
[apiInstance getUserRecordByUserIdWith:userId
              completionHandler: ^(UserRecord output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IamRestServices = require('iam_rest_services');

var api = new IamRestServices.UserReadonlyApi()
var userId = userId_example; // {{String}} An identifier for the user, could be the user's ucsbCampusId, netId or database primary key

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

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

            var apiInstance = new UserReadonlyApi();
            var userId = userId_example;  // String | An identifier for the user, could be the user's ucsbCampusId, netId or database primary key

            try
            {
                // Get user identity status by netId
                UserRecord result = apiInstance.getUserRecordByUserId(userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserReadonlyApi.getUserRecordByUserId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserReadonlyApi();
$userId = userId_example; // String | An identifier for the user, could be the user's ucsbCampusId, netId or database primary key

try {
    $result = $api_instance->getUserRecordByUserId($userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserReadonlyApi->getUserRecordByUserId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserReadonlyApi;

my $api_instance = WWW::SwaggerClient::UserReadonlyApi->new();
my $userId = userId_example; # String | An identifier for the user, could be the user's ucsbCampusId, netId or database primary key

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

# create an instance of the API class
api_instance = swagger_client.UserReadonlyApi()
userId = userId_example # String | An identifier for the user, could be the user's ucsbCampusId, netId or database primary key

try: 
    # Get user identity status by netId
    api_response = api_instance.get_user_record_by_user_id(userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserReadonlyApi->getUserRecordByUserId: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
An identifier for the user, could be the user's ucsbCampusId, netId or database primary key
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found