scimwebservices API

ScimGroups

createScimGroup

Create group in Commerce

Endpoint to create a scim group in Commerce


/Groups

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/scim/v2/Groups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScimGroupsApi;

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

public class ScimGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ScimGroupsApi apiInstance = new ScimGroupsApi();
        ScimGroup body = ; // ScimGroup | 
        try {
            ScimGroup result = apiInstance.createScimGroup(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimGroupsApi#createScimGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScimGroupsApi;

public class ScimGroupsApiExample {

    public static void main(String[] args) {
        ScimGroupsApi apiInstance = new ScimGroupsApi();
        ScimGroup body = ; // ScimGroup | 
        try {
            ScimGroup result = apiInstance.createScimGroup(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimGroupsApi#createScimGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ScimGroup *body = ; // 

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

// Create group in Commerce
[apiInstance createScimGroupWith:body
              completionHandler: ^(ScimGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScimwebservicesApi = require('scimwebservices_api');
var defaultClient = ScimwebservicesApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new ScimwebservicesApi.ScimGroupsApi()
var body = ; // {{ScimGroup}} 

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScimGroupsApi();
            var body = new ScimGroup(); // ScimGroup | 

            try
            {
                // Create group in Commerce
                ScimGroup result = apiInstance.createScimGroup(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScimGroupsApi.createScimGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScimGroupsApi();
$body = ; // ScimGroup | 

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScimGroupsApi->new();
my $body = WWW::SwaggerClient::Object::ScimGroup->new(); # ScimGroup | 

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScimGroupsApi()
body =  # ScimGroup | 

try: 
    # Create group in Commerce
    api_response = api_instance.create_scim_group(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScimGroupsApi->createScimGroup: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getScimGroup

Get group from Commerce

Endpoint to get the details of scim group along with members from Commerce according to the group-id provided


/Groups/{groupId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json"\
"http://localhost:9001/scim/v2/Groups/{groupId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScimGroupsApi;

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

public class ScimGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ScimGroupsApi apiInstance = new ScimGroupsApi();
        String groupId = groupId_example; // String | Group ID of the Scim Group to fetch.
        try {
            ScimGroup result = apiInstance.getScimGroup(groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimGroupsApi#getScimGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScimGroupsApi;

public class ScimGroupsApiExample {

    public static void main(String[] args) {
        ScimGroupsApi apiInstance = new ScimGroupsApi();
        String groupId = groupId_example; // String | Group ID of the Scim Group to fetch.
        try {
            ScimGroup result = apiInstance.getScimGroup(groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimGroupsApi#getScimGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *groupId = groupId_example; // Group ID of the Scim Group to fetch.

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

// Get group from Commerce
[apiInstance getScimGroupWith:groupId
              completionHandler: ^(ScimGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScimwebservicesApi = require('scimwebservices_api');
var defaultClient = ScimwebservicesApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new ScimwebservicesApi.ScimGroupsApi()
var groupId = groupId_example; // {{String}} Group ID of the Scim Group to fetch.

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScimGroupsApi();
            var groupId = groupId_example;  // String | Group ID of the Scim Group to fetch.

            try
            {
                // Get group from Commerce
                ScimGroup result = apiInstance.getScimGroup(groupId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScimGroupsApi.getScimGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScimGroupsApi();
$groupId = groupId_example; // String | Group ID of the Scim Group to fetch.

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScimGroupsApi->new();
my $groupId = groupId_example; # String | Group ID of the Scim Group to fetch.

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScimGroupsApi()
groupId = groupId_example # String | Group ID of the Scim Group to fetch.

try: 
    # Get group from Commerce
    api_response = api_instance.get_scim_group(groupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScimGroupsApi->getScimGroup: %s\n" % e)

Parameters

Path parameters
Name Description
groupId*
String
Group ID of the Scim Group to fetch.
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getScimGroups

Get all scim groups from commerce

Endpoint to retrieve all existing scim groups along with their members from Commerce.


/Groups

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json"\
"http://localhost:9001/scim/v2/Groups?count=&startIndex="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScimGroupsApi;

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

public class ScimGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ScimGroupsApi apiInstance = new ScimGroupsApi();
        Integer count = 56; // Integer | Total number of scim groups to be fetched from Commerce on a page.
        Integer startIndex = 56; // Integer | The starting point for fetch of scim groups from Commerce on a page.
        try {
            ScimGroupList result = apiInstance.getScimGroups(count, startIndex);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimGroupsApi#getScimGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScimGroupsApi;

public class ScimGroupsApiExample {

    public static void main(String[] args) {
        ScimGroupsApi apiInstance = new ScimGroupsApi();
        Integer count = 56; // Integer | Total number of scim groups to be fetched from Commerce on a page.
        Integer startIndex = 56; // Integer | The starting point for fetch of scim groups from Commerce on a page.
        try {
            ScimGroupList result = apiInstance.getScimGroups(count, startIndex);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimGroupsApi#getScimGroups");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *count = 56; // Total number of scim groups to be fetched from Commerce on a page. (optional) (default to 0)
Integer *startIndex = 56; // The starting point for fetch of scim groups from Commerce on a page. (optional) (default to 1)

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

// Get all scim groups from commerce
[apiInstance getScimGroupsWith:count
    startIndex:startIndex
              completionHandler: ^(ScimGroupList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScimwebservicesApi = require('scimwebservices_api');
var defaultClient = ScimwebservicesApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new ScimwebservicesApi.ScimGroupsApi()
var opts = { 
  'count': 56, // {{Integer}} Total number of scim groups to be fetched from Commerce on a page.
  'startIndex': 56 // {{Integer}} The starting point for fetch of scim groups from Commerce on a page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getScimGroups(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScimGroupsApi();
            var count = 56;  // Integer | Total number of scim groups to be fetched from Commerce on a page. (optional)  (default to 0)
            var startIndex = 56;  // Integer | The starting point for fetch of scim groups from Commerce on a page. (optional)  (default to 1)

            try
            {
                // Get all scim groups from commerce
                ScimGroupList result = apiInstance.getScimGroups(count, startIndex);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScimGroupsApi.getScimGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScimGroupsApi();
$count = 56; // Integer | Total number of scim groups to be fetched from Commerce on a page.
$startIndex = 56; // Integer | The starting point for fetch of scim groups from Commerce on a page.

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScimGroupsApi->new();
my $count = 56; # Integer | Total number of scim groups to be fetched from Commerce on a page.
my $startIndex = 56; # Integer | The starting point for fetch of scim groups from Commerce on a page.

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScimGroupsApi()
count = 56 # Integer | Total number of scim groups to be fetched from Commerce on a page. (optional) (default to 0)
startIndex = 56 # Integer | The starting point for fetch of scim groups from Commerce on a page. (optional) (default to 1)

try: 
    # Get all scim groups from commerce
    api_response = api_instance.get_scim_groups(count=count, startIndex=startIndex)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScimGroupsApi->getScimGroups: %s\n" % e)

Parameters

Query parameters
Name Description
count
Integer (int32)
Total number of scim groups to be fetched from Commerce on a page.
startIndex
Integer (int32)
The starting point for fetch of scim groups from Commerce on a page.

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


removeScimGroup

Delete scim group from Commerce

Endpoint to delete scim group from Commerce for which id is provided


/Groups/{groupId}

Usage and SDK Samples

curl -X DELETE\
\
\
"http://localhost:9001/scim/v2/Groups/{groupId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScimGroupsApi;

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

public class ScimGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ScimGroupsApi apiInstance = new ScimGroupsApi();
        String groupId = groupId_example; // String | Group ID of the Scim Group to delete.
        try {
            apiInstance.removeScimGroup(groupId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimGroupsApi#removeScimGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScimGroupsApi;

public class ScimGroupsApiExample {

    public static void main(String[] args) {
        ScimGroupsApi apiInstance = new ScimGroupsApi();
        String groupId = groupId_example; // String | Group ID of the Scim Group to delete.
        try {
            apiInstance.removeScimGroup(groupId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimGroupsApi#removeScimGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *groupId = groupId_example; // Group ID of the Scim Group to delete.

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

// Delete scim group from Commerce
[apiInstance removeScimGroupWith:groupId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScimwebservicesApi = require('scimwebservices_api');
var defaultClient = ScimwebservicesApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new ScimwebservicesApi.ScimGroupsApi()
var groupId = groupId_example; // {{String}} Group ID of the Scim Group to delete.

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScimGroupsApi();
            var groupId = groupId_example;  // String | Group ID of the Scim Group to delete.

            try
            {
                // Delete scim group from Commerce
                apiInstance.removeScimGroup(groupId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScimGroupsApi.removeScimGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScimGroupsApi();
$groupId = groupId_example; // String | Group ID of the Scim Group to delete.

try {
    $api_instance->removeScimGroup($groupId);
} catch (Exception $e) {
    echo 'Exception when calling ScimGroupsApi->removeScimGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScimGroupsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScimGroupsApi->new();
my $groupId = groupId_example; # String | Group ID of the Scim Group to delete.

eval { 
    $api_instance->removeScimGroup(groupId => $groupId);
};
if ($@) {
    warn "Exception when calling ScimGroupsApi->removeScimGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScimGroupsApi()
groupId = groupId_example # String | Group ID of the Scim Group to delete.

try: 
    # Delete scim group from Commerce
    api_instance.remove_scim_group(groupId)
except ApiException as e:
    print("Exception when calling ScimGroupsApi->removeScimGroup: %s\n" % e)

Parameters

Path parameters
Name Description
groupId*
String
Group ID of the Scim Group to delete.
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


replaceScimGroup

Update group in Commerce

Endpoint to update details of a scim group in Commerce for which Id is provided


/Groups/{groupId}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/scim/v2/Groups/{groupId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScimGroupsApi;

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

public class ScimGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ScimGroupsApi apiInstance = new ScimGroupsApi();
        ScimGroup body = ; // ScimGroup | 
        String groupId = groupId_example; // String | Group ID of the Group
        try {
            ScimGroup result = apiInstance.replaceScimGroup(body, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimGroupsApi#replaceScimGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScimGroupsApi;

public class ScimGroupsApiExample {

    public static void main(String[] args) {
        ScimGroupsApi apiInstance = new ScimGroupsApi();
        ScimGroup body = ; // ScimGroup | 
        String groupId = groupId_example; // String | Group ID of the Group
        try {
            ScimGroup result = apiInstance.replaceScimGroup(body, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimGroupsApi#replaceScimGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ScimGroup *body = ; // 
String *groupId = groupId_example; // Group ID of the Group

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

// Update group in Commerce
[apiInstance replaceScimGroupWith:body
    groupId:groupId
              completionHandler: ^(ScimGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScimwebservicesApi = require('scimwebservices_api');
var defaultClient = ScimwebservicesApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new ScimwebservicesApi.ScimGroupsApi()
var body = ; // {{ScimGroup}} 
var groupId = groupId_example; // {{String}} Group ID of the Group

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScimGroupsApi();
            var body = new ScimGroup(); // ScimGroup | 
            var groupId = groupId_example;  // String | Group ID of the Group

            try
            {
                // Update group in Commerce
                ScimGroup result = apiInstance.replaceScimGroup(body, groupId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScimGroupsApi.replaceScimGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScimGroupsApi();
$body = ; // ScimGroup | 
$groupId = groupId_example; // String | Group ID of the Group

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScimGroupsApi->new();
my $body = WWW::SwaggerClient::Object::ScimGroup->new(); # ScimGroup | 
my $groupId = groupId_example; # String | Group ID of the Group

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScimGroupsApi()
body =  # ScimGroup | 
groupId = groupId_example # String | Group ID of the Group

try: 
    # Update group in Commerce
    api_response = api_instance.replace_scim_group(body, groupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScimGroupsApi->replaceScimGroup: %s\n" % e)

Parameters

Path parameters
Name Description
groupId*
String
Group ID of the Group
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


updateScimGroup

Patch update scim group in commerce

Endpoint to update scim group in Commerce with the details provided


/Groups/{groupId}

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/scim/v2/Groups/{groupId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScimGroupsApi;

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

public class ScimGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ScimGroupsApi apiInstance = new ScimGroupsApi();
        ScimGroup body = ; // ScimGroup | 
        String groupId = groupId_example; // String | Group ID of the Group
        try {
            ScimGroup result = apiInstance.updateScimGroup(body, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimGroupsApi#updateScimGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScimGroupsApi;

public class ScimGroupsApiExample {

    public static void main(String[] args) {
        ScimGroupsApi apiInstance = new ScimGroupsApi();
        ScimGroup body = ; // ScimGroup | 
        String groupId = groupId_example; // String | Group ID of the Group
        try {
            ScimGroup result = apiInstance.updateScimGroup(body, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimGroupsApi#updateScimGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ScimGroup *body = ; // 
String *groupId = groupId_example; // Group ID of the Group

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

// Patch update scim group in commerce
[apiInstance updateScimGroupWith:body
    groupId:groupId
              completionHandler: ^(ScimGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScimwebservicesApi = require('scimwebservices_api');
var defaultClient = ScimwebservicesApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new ScimwebservicesApi.ScimGroupsApi()
var body = ; // {{ScimGroup}} 
var groupId = groupId_example; // {{String}} Group ID of the Group

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScimGroupsApi();
            var body = new ScimGroup(); // ScimGroup | 
            var groupId = groupId_example;  // String | Group ID of the Group

            try
            {
                // Patch update scim group in commerce
                ScimGroup result = apiInstance.updateScimGroup(body, groupId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScimGroupsApi.updateScimGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScimGroupsApi();
$body = ; // ScimGroup | 
$groupId = groupId_example; // String | Group ID of the Group

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScimGroupsApi->new();
my $body = WWW::SwaggerClient::Object::ScimGroup->new(); # ScimGroup | 
my $groupId = groupId_example; # String | Group ID of the Group

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScimGroupsApi()
body =  # ScimGroup | 
groupId = groupId_example # String | Group ID of the Group

try: 
    # Patch update scim group in commerce
    api_response = api_instance.update_scim_group(body, groupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScimGroupsApi->updateScimGroup: %s\n" % e)

Parameters

Path parameters
Name Description
groupId*
String
Group ID of the Group
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


ScimUsers

createUser

Create user in the system


/Users

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/scim/v2/Users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScimUsersApi;

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

public class ScimUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ScimUsersApi apiInstance = new ScimUsersApi();
        ScimUser body = ; // ScimUser | 
        try {
            ScimUser result = apiInstance.createUser(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimUsersApi#createUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScimUsersApi;

public class ScimUsersApiExample {

    public static void main(String[] args) {
        ScimUsersApi apiInstance = new ScimUsersApi();
        ScimUser body = ; // ScimUser | 
        try {
            ScimUser result = apiInstance.createUser(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimUsersApi#createUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ScimUser *body = ; // 

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

// Create user in the system
[apiInstance createUserWith:body
              completionHandler: ^(ScimUser output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScimwebservicesApi = require('scimwebservices_api');
var defaultClient = ScimwebservicesApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new ScimwebservicesApi.ScimUsersApi()
var body = ; // {{ScimUser}} 

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScimUsersApi();
            var body = new ScimUser(); // ScimUser | 

            try
            {
                // Create user in the system
                ScimUser result = apiInstance.createUser(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScimUsersApi.createUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScimUsersApi();
$body = ; // ScimUser | 

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScimUsersApi->new();
my $body = WWW::SwaggerClient::Object::ScimUser->new(); # ScimUser | 

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScimUsersApi()
body =  # ScimUser | 

try: 
    # Create user in the system
    api_response = api_instance.create_user(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScimUsersApi->createUser: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


deleteUser

Delete user from the system


/Users/{userId}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/scim/v2/Users/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScimUsersApi;

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

public class ScimUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ScimUsersApi apiInstance = new ScimUsersApi();
        String userId = userId_example; // String | User ID of the User
        try {
            'Boolean' result = apiInstance.deleteUser(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimUsersApi#deleteUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScimUsersApi;

public class ScimUsersApiExample {

    public static void main(String[] args) {
        ScimUsersApi apiInstance = new ScimUsersApi();
        String userId = userId_example; // String | User ID of the User
        try {
            'Boolean' result = apiInstance.deleteUser(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimUsersApi#deleteUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *userId = userId_example; // User ID of the User

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

// Delete user from the system
[apiInstance deleteUserWith:userId
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScimwebservicesApi = require('scimwebservices_api');
var defaultClient = ScimwebservicesApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new ScimwebservicesApi.ScimUsersApi()
var userId = userId_example; // {{String}} User ID of the User

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScimUsersApi();
            var userId = userId_example;  // String | User ID of the User

            try
            {
                // Delete user from the system
                'Boolean' result = apiInstance.deleteUser(userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScimUsersApi.deleteUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScimUsersApi();
$userId = userId_example; // String | User ID of the User

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScimUsersApi->new();
my $userId = userId_example; # String | User ID of the User

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScimUsersApi()
userId = userId_example # String | User ID of the User

try: 
    # Delete user from the system
    api_response = api_instance.delete_user(userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScimUsersApi->deleteUser: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
User ID of the User
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getUser

Get user from the system


/Users/{userId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/scim/v2/Users/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScimUsersApi;

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

public class ScimUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ScimUsersApi apiInstance = new ScimUsersApi();
        String userId = userId_example; // String | User ID of the User
        try {
            ScimUser result = apiInstance.getUser(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimUsersApi#getUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScimUsersApi;

public class ScimUsersApiExample {

    public static void main(String[] args) {
        ScimUsersApi apiInstance = new ScimUsersApi();
        String userId = userId_example; // String | User ID of the User
        try {
            ScimUser result = apiInstance.getUser(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimUsersApi#getUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *userId = userId_example; // User ID of the User

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

// Get user from the system
[apiInstance getUserWith:userId
              completionHandler: ^(ScimUser output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScimwebservicesApi = require('scimwebservices_api');
var defaultClient = ScimwebservicesApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new ScimwebservicesApi.ScimUsersApi()
var userId = userId_example; // {{String}} User ID of the User

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScimUsersApi();
            var userId = userId_example;  // String | User ID of the User

            try
            {
                // Get user from the system
                ScimUser result = apiInstance.getUser(userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScimUsersApi.getUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScimUsersApi();
$userId = userId_example; // String | User ID of the User

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScimUsersApi->new();
my $userId = userId_example; # String | User ID of the User

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScimUsersApi()
userId = userId_example # String | User ID of the User

try: 
    # Get user from the system
    api_response = api_instance.get_user(userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScimUsersApi->getUser: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
User ID of the User
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getUsers

Get users of type Employee

Endpoint to retrive all users of type Employee from Commerce


/Users

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json"\
"http://localhost:9001/scim/v2/Users?count=&startIndex="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScimUsersApi;

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

public class ScimUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ScimUsersApi apiInstance = new ScimUsersApi();
        Integer count = 56; // Integer | Total number of users to be fetched from Commerce on a page.
        Integer startIndex = 56; // Integer | The starting point for fetch of users from Commerce on a page.
        try {
            ScimUserList result = apiInstance.getUsers(count, startIndex);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimUsersApi#getUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScimUsersApi;

public class ScimUsersApiExample {

    public static void main(String[] args) {
        ScimUsersApi apiInstance = new ScimUsersApi();
        Integer count = 56; // Integer | Total number of users to be fetched from Commerce on a page.
        Integer startIndex = 56; // Integer | The starting point for fetch of users from Commerce on a page.
        try {
            ScimUserList result = apiInstance.getUsers(count, startIndex);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimUsersApi#getUsers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *count = 56; // Total number of users to be fetched from Commerce on a page. (optional) (default to 0)
Integer *startIndex = 56; // The starting point for fetch of users from Commerce on a page. (optional) (default to 1)

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

// Get users of type Employee
[apiInstance getUsersWith:count
    startIndex:startIndex
              completionHandler: ^(ScimUserList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScimwebservicesApi = require('scimwebservices_api');
var defaultClient = ScimwebservicesApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new ScimwebservicesApi.ScimUsersApi()
var opts = { 
  'count': 56, // {{Integer}} Total number of users to be fetched from Commerce on a page.
  'startIndex': 56 // {{Integer}} The starting point for fetch of users from Commerce on a page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUsers(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScimUsersApi();
            var count = 56;  // Integer | Total number of users to be fetched from Commerce on a page. (optional)  (default to 0)
            var startIndex = 56;  // Integer | The starting point for fetch of users from Commerce on a page. (optional)  (default to 1)

            try
            {
                // Get users of type Employee
                ScimUserList result = apiInstance.getUsers(count, startIndex);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScimUsersApi.getUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScimUsersApi();
$count = 56; // Integer | Total number of users to be fetched from Commerce on a page.
$startIndex = 56; // Integer | The starting point for fetch of users from Commerce on a page.

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScimUsersApi->new();
my $count = 56; # Integer | Total number of users to be fetched from Commerce on a page.
my $startIndex = 56; # Integer | The starting point for fetch of users from Commerce on a page.

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScimUsersApi()
count = 56 # Integer | Total number of users to be fetched from Commerce on a page. (optional) (default to 0)
startIndex = 56 # Integer | The starting point for fetch of users from Commerce on a page. (optional) (default to 1)

try: 
    # Get users of type Employee
    api_response = api_instance.get_users(count=count, startIndex=startIndex)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScimUsersApi->getUsers: %s\n" % e)

Parameters

Query parameters
Name Description
count
Integer (int32)
Total number of users to be fetched from Commerce on a page.
startIndex
Integer (int32)
The starting point for fetch of users from Commerce on a page.

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


patchUser

Patch update user in the system


/Users/{userId}

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/scim/v2/Users/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScimUsersApi;

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

public class ScimUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ScimUsersApi apiInstance = new ScimUsersApi();
        ScimUser body = ; // ScimUser | 
        String userId = userId_example; // String | User ID of the User
        try {
            ScimUser result = apiInstance.patchUser(body, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimUsersApi#patchUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScimUsersApi;

public class ScimUsersApiExample {

    public static void main(String[] args) {
        ScimUsersApi apiInstance = new ScimUsersApi();
        ScimUser body = ; // ScimUser | 
        String userId = userId_example; // String | User ID of the User
        try {
            ScimUser result = apiInstance.patchUser(body, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimUsersApi#patchUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ScimUser *body = ; // 
String *userId = userId_example; // User ID of the User

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

// Patch update user in the system
[apiInstance patchUserWith:body
    userId:userId
              completionHandler: ^(ScimUser output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScimwebservicesApi = require('scimwebservices_api');
var defaultClient = ScimwebservicesApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new ScimwebservicesApi.ScimUsersApi()
var body = ; // {{ScimUser}} 
var userId = userId_example; // {{String}} User ID of the User

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScimUsersApi();
            var body = new ScimUser(); // ScimUser | 
            var userId = userId_example;  // String | User ID of the User

            try
            {
                // Patch update user in the system
                ScimUser result = apiInstance.patchUser(body, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScimUsersApi.patchUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScimUsersApi();
$body = ; // ScimUser | 
$userId = userId_example; // String | User ID of the User

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScimUsersApi->new();
my $body = WWW::SwaggerClient::Object::ScimUser->new(); # ScimUser | 
my $userId = userId_example; # String | User ID of the User

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScimUsersApi()
body =  # ScimUser | 
userId = userId_example # String | User ID of the User

try: 
    # Patch update user in the system
    api_response = api_instance.patch_user(body, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScimUsersApi->patchUser: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
User ID of the User
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


updateUser

Update user in the system


/Users/{userId}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/scim/v2/Users/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScimUsersApi;

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

public class ScimUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ScimUsersApi apiInstance = new ScimUsersApi();
        ScimUser body = ; // ScimUser | 
        String userId = userId_example; // String | User ID of the User
        try {
            ScimUser result = apiInstance.updateUser(body, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimUsersApi#updateUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScimUsersApi;

public class ScimUsersApiExample {

    public static void main(String[] args) {
        ScimUsersApi apiInstance = new ScimUsersApi();
        ScimUser body = ; // ScimUser | 
        String userId = userId_example; // String | User ID of the User
        try {
            ScimUser result = apiInstance.updateUser(body, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScimUsersApi#updateUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ScimUser *body = ; // 
String *userId = userId_example; // User ID of the User

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

// Update user in the system
[apiInstance updateUserWith:body
    userId:userId
              completionHandler: ^(ScimUser output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScimwebservicesApi = require('scimwebservices_api');
var defaultClient = ScimwebservicesApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new ScimwebservicesApi.ScimUsersApi()
var body = ; // {{ScimUser}} 
var userId = userId_example; // {{String}} User ID of the User

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScimUsersApi();
            var body = new ScimUser(); // ScimUser | 
            var userId = userId_example;  // String | User ID of the User

            try
            {
                // Update user in the system
                ScimUser result = apiInstance.updateUser(body, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScimUsersApi.updateUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScimUsersApi();
$body = ; // ScimUser | 
$userId = userId_example; // String | User ID of the User

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScimUsersApi->new();
my $body = WWW::SwaggerClient::Object::ScimUser->new(); # ScimUser | 
my $userId = userId_example; # String | User ID of the User

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScimUsersApi()
body =  # ScimUser | 
userId = userId_example # String | User ID of the User

try: 
    # Update user in the system
    api_response = api_instance.update_user(body, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScimUsersApi->updateUser: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
User ID of the User
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found