Users Keycloak API

AuthUser

checkIfExistsAuthUserById

Check if AuthUser exists for the specified user ID


/users-keycloak/auth-users/{userId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: text/plain,application/json" \
 "http://localhost:8081/users-keycloak/auth-users/{userId}"

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

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

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

        // Create an instance of the API class
        AuthUserApi apiInstance = new AuthUserApi();
        UUID userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | User ID

        try {
            'String' result = apiInstance.checkIfExistsAuthUserById(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthUserApi#checkIfExistsAuthUserById");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID userId = new UUID(); // UUID | User ID

try {
    final result = await api_instance.checkIfExistsAuthUserById(userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->checkIfExistsAuthUserById: $e\n');
}


import org.openapitools.client.api.AuthUserApi;

public class AuthUserApiExample {
    public static void main(String[] args) {
        AuthUserApi apiInstance = new AuthUserApi();
        UUID userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | User ID

        try {
            'String' result = apiInstance.checkIfExistsAuthUserById(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthUserApi#checkIfExistsAuthUserById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AuthUserApi *apiInstance = [[AuthUserApi alloc] init];
UUID *userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // User ID (default to null)

[apiInstance checkIfExistsAuthUserByIdWith:userId
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.AuthUserApi()
var userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} User ID

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

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

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

            // Create an instance of the API class
            var apiInstance = new AuthUserApi();
            var userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | User ID (default to null)

            try {
                'String' result = apiInstance.checkIfExistsAuthUserById(userId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthUserApi.checkIfExistsAuthUserById: " + e.Message );
            }
        }
    }
}

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthUserApi();
$userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | User ID

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthUserApi->new();
my $userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | User ID

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

# Create an instance of the API class
api_instance = openapi_client.AuthUserApi()
userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | User ID (default to null)

try:
    api_response = api_instance.check_if_exists_auth_user_by_id(userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthUserApi->checkIfExistsAuthUserById: %s\n" % e)
extern crate AuthUserApi;

pub fn main() {
    let userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = AuthUserApi::Context::default();
    let result = client.checkIfExistsAuthUserById(userId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
userId*
UUID (uuid)
User ID
Required

Responses

createAuthUser

Check if AuthUser exists for the specified user ID


/users-keycloak/auth-users/{userId}

Usage and SDK Samples

curl -X POST \
 -H "Accept: text/plain,application/json" \
 "http://localhost:8081/users-keycloak/auth-users/{userId}"

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

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

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

        // Create an instance of the API class
        AuthUserApi apiInstance = new AuthUserApi();
        UUID userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | User ID

        try {
            apiInstance.createAuthUser(userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthUserApi#createAuthUser");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID userId = new UUID(); // UUID | User ID

try {
    final result = await api_instance.createAuthUser(userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createAuthUser: $e\n');
}


import org.openapitools.client.api.AuthUserApi;

public class AuthUserApiExample {
    public static void main(String[] args) {
        AuthUserApi apiInstance = new AuthUserApi();
        UUID userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | User ID

        try {
            apiInstance.createAuthUser(userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthUserApi#createAuthUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AuthUserApi *apiInstance = [[AuthUserApi alloc] init];
UUID *userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // User ID (default to null)

[apiInstance createAuthUserWith:userId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.AuthUserApi()
var userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} User ID

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

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

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

            // Create an instance of the API class
            var apiInstance = new AuthUserApi();
            var userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | User ID (default to null)

            try {
                apiInstance.createAuthUser(userId);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthUserApi.createAuthUser: " + e.Message );
            }
        }
    }
}

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthUserApi();
$userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | User ID

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthUserApi->new();
my $userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | User ID

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

# Create an instance of the API class
api_instance = openapi_client.AuthUserApi()
userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | User ID (default to null)

try:
    api_instance.create_auth_user(userId)
except ApiException as e:
    print("Exception when calling AuthUserApi->createAuthUser: %s\n" % e)
extern crate AuthUserApi;

pub fn main() {
    let userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = AuthUserApi::Context::default();
    let result = client.createAuthUser(userId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
userId*
UUID (uuid)
User ID
Required

Responses

ForgottenUsernamePassword

recoverForgottenUsername

Called when a user has forgotten a username. Always returns 204 No Content regardless of whether a user exists, to prevent username/email enumeration. If a matching active user is found, a username reminder is sent. Otherwise, the request is logged but no email is sent. 


/users-keycloak/forgotten/username

Usage and SDK Samples

curl -X POST \
 -H "Accept: text/plain,application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/users-keycloak/forgotten/username" \
 -d ''

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

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

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

        // Create an instance of the API class
        ForgottenUsernamePasswordApi apiInstance = new ForgottenUsernamePasswordApi();
        Identifier identifier = ; // Identifier | 

        try {
            'String' result = apiInstance.recoverForgottenUsername(identifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ForgottenUsernamePasswordApi#recoverForgottenUsername");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Identifier identifier = new Identifier(); // Identifier | 

try {
    final result = await api_instance.recoverForgottenUsername(identifier);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->recoverForgottenUsername: $e\n');
}


import org.openapitools.client.api.ForgottenUsernamePasswordApi;

public class ForgottenUsernamePasswordApiExample {
    public static void main(String[] args) {
        ForgottenUsernamePasswordApi apiInstance = new ForgottenUsernamePasswordApi();
        Identifier identifier = ; // Identifier | 

        try {
            'String' result = apiInstance.recoverForgottenUsername(identifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ForgottenUsernamePasswordApi#recoverForgottenUsername");
            e.printStackTrace();
        }
    }
}


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

[apiInstance recoverForgottenUsernameWith:identifier
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.ForgottenUsernamePasswordApi()
var identifier = ; // {Identifier} 

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

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

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

            // Create an instance of the API class
            var apiInstance = new ForgottenUsernamePasswordApi();
            var identifier = new Identifier(); // Identifier | 

            try {
                'String' result = apiInstance.recoverForgottenUsername(identifier);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ForgottenUsernamePasswordApi.recoverForgottenUsername: " + e.Message );
            }
        }
    }
}

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ForgottenUsernamePasswordApi();
$identifier = ; // Identifier | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ForgottenUsernamePasswordApi->new();
my $identifier = WWW::OPenAPIClient::Object::Identifier->new(); # Identifier | 

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

# Create an instance of the API class
api_instance = openapi_client.ForgottenUsernamePasswordApi()
identifier =  # Identifier | 

try:
    api_response = api_instance.recover_forgotten_username(identifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ForgottenUsernamePasswordApi->recoverForgottenUsername: %s\n" % e)
extern crate ForgottenUsernamePasswordApi;

pub fn main() {
    let identifier = ; // Identifier

    let mut context = ForgottenUsernamePasswordApi::Context::default();
    let result = client.recoverForgottenUsername(identifier, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
identifier *

Responses

resetForgottenPassword

Called when a user has forgotten a password. Always returns 204 No Content regardless of whether a user exists, to prevent username/email enumeration. If a matching active user is found, a password reset link is sent. Otherwise, the request is logged but no email is sent. 


/users-keycloak/forgotten/password

Usage and SDK Samples

curl -X POST \
 -H "Accept: text/plain,application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/users-keycloak/forgotten/password" \
 -d ''

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

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

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

        // Create an instance of the API class
        ForgottenUsernamePasswordApi apiInstance = new ForgottenUsernamePasswordApi();
        Identifier identifier = ; // Identifier | 

        try {
            'String' result = apiInstance.resetForgottenPassword(identifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ForgottenUsernamePasswordApi#resetForgottenPassword");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Identifier identifier = new Identifier(); // Identifier | 

try {
    final result = await api_instance.resetForgottenPassword(identifier);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->resetForgottenPassword: $e\n');
}


import org.openapitools.client.api.ForgottenUsernamePasswordApi;

public class ForgottenUsernamePasswordApiExample {
    public static void main(String[] args) {
        ForgottenUsernamePasswordApi apiInstance = new ForgottenUsernamePasswordApi();
        Identifier identifier = ; // Identifier | 

        try {
            'String' result = apiInstance.resetForgottenPassword(identifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ForgottenUsernamePasswordApi#resetForgottenPassword");
            e.printStackTrace();
        }
    }
}


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

[apiInstance resetForgottenPasswordWith:identifier
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.ForgottenUsernamePasswordApi()
var identifier = ; // {Identifier} 

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

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

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

            // Create an instance of the API class
            var apiInstance = new ForgottenUsernamePasswordApi();
            var identifier = new Identifier(); // Identifier | 

            try {
                'String' result = apiInstance.resetForgottenPassword(identifier);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ForgottenUsernamePasswordApi.resetForgottenPassword: " + e.Message );
            }
        }
    }
}

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ForgottenUsernamePasswordApi();
$identifier = ; // Identifier | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ForgottenUsernamePasswordApi->new();
my $identifier = WWW::OPenAPIClient::Object::Identifier->new(); # Identifier | 

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

# Create an instance of the API class
api_instance = openapi_client.ForgottenUsernamePasswordApi()
identifier =  # Identifier | 

try:
    api_response = api_instance.reset_forgotten_password(identifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ForgottenUsernamePasswordApi->resetForgottenPassword: %s\n" % e)
extern crate ForgottenUsernamePasswordApi;

pub fn main() {
    let identifier = ; // Identifier

    let mut context = ForgottenUsernamePasswordApi::Context::default();
    let result = client.resetForgottenPassword(identifier, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
identifier *

Responses

IdpMigration

linkUserIdpMigration

Link users to an identity provider migration operation


/users-keycloak/idp-migrations

Usage and SDK Samples

curl -X POST \
 -H "Accept: text/plain" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/users-keycloak/idp-migrations" \
 -d ''

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

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

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

        // Create an instance of the API class
        IdpMigrationApi apiInstance = new IdpMigrationApi();
        UsersIdp usersIdp = ; // UsersIdp | 

        try {
            'String' result = apiInstance.linkUserIdpMigration(usersIdp);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IdpMigrationApi#linkUserIdpMigration");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UsersIdp usersIdp = new UsersIdp(); // UsersIdp | 

try {
    final result = await api_instance.linkUserIdpMigration(usersIdp);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->linkUserIdpMigration: $e\n');
}


import org.openapitools.client.api.IdpMigrationApi;

public class IdpMigrationApiExample {
    public static void main(String[] args) {
        IdpMigrationApi apiInstance = new IdpMigrationApi();
        UsersIdp usersIdp = ; // UsersIdp | 

        try {
            'String' result = apiInstance.linkUserIdpMigration(usersIdp);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IdpMigrationApi#linkUserIdpMigration");
            e.printStackTrace();
        }
    }
}


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

[apiInstance linkUserIdpMigrationWith:usersIdp
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.IdpMigrationApi()
var usersIdp = ; // {UsersIdp} 

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

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

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

            // Create an instance of the API class
            var apiInstance = new IdpMigrationApi();
            var usersIdp = new UsersIdp(); // UsersIdp | 

            try {
                'String' result = apiInstance.linkUserIdpMigration(usersIdp);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling IdpMigrationApi.linkUserIdpMigration: " + e.Message );
            }
        }
    }
}

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\IdpMigrationApi();
$usersIdp = ; // UsersIdp | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::IdpMigrationApi->new();
my $usersIdp = WWW::OPenAPIClient::Object::UsersIdp->new(); # UsersIdp | 

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

# Create an instance of the API class
api_instance = openapi_client.IdpMigrationApi()
usersIdp =  # UsersIdp | 

try:
    api_response = api_instance.link_user_idp_migration(usersIdp)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IdpMigrationApi->linkUserIdpMigration: %s\n" % e)
extern crate IdpMigrationApi;

pub fn main() {
    let usersIdp = ; // UsersIdp

    let mut context = IdpMigrationApi::Context::default();
    let result = client.linkUserIdpMigration(usersIdp, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
usersIdp *

Responses

unlinkUserIdpMigration

Unlink users from an identity provider migration operation


/users-keycloak/idp-migrations

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: text/plain" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/users-keycloak/idp-migrations" \
 -d ''

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

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

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

        // Create an instance of the API class
        IdpMigrationApi apiInstance = new IdpMigrationApi();
        UsersIdp usersIdp = ; // UsersIdp | 

        try {
            'String' result = apiInstance.unlinkUserIdpMigration(usersIdp);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IdpMigrationApi#unlinkUserIdpMigration");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UsersIdp usersIdp = new UsersIdp(); // UsersIdp | 

try {
    final result = await api_instance.unlinkUserIdpMigration(usersIdp);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->unlinkUserIdpMigration: $e\n');
}


import org.openapitools.client.api.IdpMigrationApi;

public class IdpMigrationApiExample {
    public static void main(String[] args) {
        IdpMigrationApi apiInstance = new IdpMigrationApi();
        UsersIdp usersIdp = ; // UsersIdp | 

        try {
            'String' result = apiInstance.unlinkUserIdpMigration(usersIdp);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IdpMigrationApi#unlinkUserIdpMigration");
            e.printStackTrace();
        }
    }
}


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

[apiInstance unlinkUserIdpMigrationWith:usersIdp
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.IdpMigrationApi()
var usersIdp = ; // {UsersIdp} 

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

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

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

            // Create an instance of the API class
            var apiInstance = new IdpMigrationApi();
            var usersIdp = new UsersIdp(); // UsersIdp | 

            try {
                'String' result = apiInstance.unlinkUserIdpMigration(usersIdp);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling IdpMigrationApi.unlinkUserIdpMigration: " + e.Message );
            }
        }
    }
}

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\IdpMigrationApi();
$usersIdp = ; // UsersIdp | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::IdpMigrationApi->new();
my $usersIdp = WWW::OPenAPIClient::Object::UsersIdp->new(); # UsersIdp | 

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

# Create an instance of the API class
api_instance = openapi_client.IdpMigrationApi()
usersIdp =  # UsersIdp | 

try:
    api_response = api_instance.unlink_user_idp_migration(usersIdp)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IdpMigrationApi->unlinkUserIdpMigration: %s\n" % e)
extern crate IdpMigrationApi;

pub fn main() {
    let usersIdp = ; // UsersIdp

    let mut context = IdpMigrationApi::Context::default();
    let result = client.unlinkUserIdpMigration(usersIdp, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
usersIdp *

Responses

Migration

deleteMigration

Delete a user migration


/users-keycloak/migrations/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: text/plain" \
 "http://localhost:8081/users-keycloak/migrations/{id}"

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

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

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

        // Create an instance of the API class
        MigrationApi apiInstance = new MigrationApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id

        try {
            'String' result = apiInstance.deleteMigration(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MigrationApi#deleteMigration");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Entity id

try {
    final result = await api_instance.deleteMigration(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteMigration: $e\n');
}


import org.openapitools.client.api.MigrationApi;

public class MigrationApiExample {
    public static void main(String[] args) {
        MigrationApi apiInstance = new MigrationApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id

        try {
            'String' result = apiInstance.deleteMigration(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MigrationApi#deleteMigration");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MigrationApi *apiInstance = [[MigrationApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Entity id (default to null)

[apiInstance deleteMigrationWith:id
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.MigrationApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Entity id

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

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

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

            // Create an instance of the API class
            var apiInstance = new MigrationApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Entity id (default to null)

            try {
                'String' result = apiInstance.deleteMigration(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MigrationApi.deleteMigration: " + e.Message );
            }
        }
    }
}

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MigrationApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MigrationApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Entity id

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

# Create an instance of the API class
api_instance = openapi_client.MigrationApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Entity id (default to null)

try:
    api_response = api_instance.delete_migration(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MigrationApi->deleteMigration: %s\n" % e)
extern crate MigrationApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = MigrationApi::Context::default();
    let result = client.deleteMigration(id, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Entity id
Required

Responses

getMigration

Retrieve a user migration


/users-keycloak/migrations/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/users-keycloak/migrations/{id}"

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

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

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

        // Create an instance of the API class
        MigrationApi apiInstance = new MigrationApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id

        try {
            userMigrationJob result = apiInstance.getMigration(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MigrationApi#getMigration");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Entity id

try {
    final result = await api_instance.getMigration(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getMigration: $e\n');
}


import org.openapitools.client.api.MigrationApi;

public class MigrationApiExample {
    public static void main(String[] args) {
        MigrationApi apiInstance = new MigrationApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id

        try {
            userMigrationJob result = apiInstance.getMigration(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MigrationApi#getMigration");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MigrationApi *apiInstance = [[MigrationApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Entity id (default to null)

[apiInstance getMigrationWith:id
              completionHandler: ^(userMigrationJob output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.MigrationApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Entity id

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

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

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

            // Create an instance of the API class
            var apiInstance = new MigrationApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Entity id (default to null)

            try {
                userMigrationJob result = apiInstance.getMigration(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MigrationApi.getMigration: " + e.Message );
            }
        }
    }
}

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MigrationApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MigrationApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Entity id

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

# Create an instance of the API class
api_instance = openapi_client.MigrationApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Entity id (default to null)

try:
    api_response = api_instance.get_migration(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MigrationApi->getMigration: %s\n" % e)
extern crate MigrationApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = MigrationApi::Context::default();
    let result = client.getMigration(id, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Entity id
Required

Responses

getMigrations

Retrieve a list of user migrations


/users-keycloak/migrations

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/users-keycloak/migrations?query=query_example&offset=56&limit=56"

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

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

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

        // Create an instance of the API class
        MigrationApi apiInstance = new MigrationApi();
        String query = query_example; // String | A CQL query string with search conditions.
        Integer offset = 56; // Integer | Skip over a number of elements by specifying an offset value for the query.
        Integer limit = 56; // Integer | Limit the number of elements returned in the response.

        try {
            userMigrationJobs result = apiInstance.getMigrations(query, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MigrationApi#getMigrations");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A CQL query string with search conditions.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.

try {
    final result = await api_instance.getMigrations(query, offset, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getMigrations: $e\n');
}


import org.openapitools.client.api.MigrationApi;

public class MigrationApiExample {
    public static void main(String[] args) {
        MigrationApi apiInstance = new MigrationApi();
        String query = query_example; // String | A CQL query string with search conditions.
        Integer offset = 56; // Integer | Skip over a number of elements by specifying an offset value for the query.
        Integer limit = 56; // Integer | Limit the number of elements returned in the response.

        try {
            userMigrationJobs result = apiInstance.getMigrations(query, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MigrationApi#getMigrations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MigrationApi *apiInstance = [[MigrationApi alloc] init];
String *query = query_example; // A CQL query string with search conditions. (optional) (default to null)
Integer *offset = 56; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)
Integer *limit = 56; // Limit the number of elements returned in the response. (optional) (default to 10)

[apiInstance getMigrationsWith:query
    offset:offset
    limit:limit
              completionHandler: ^(userMigrationJobs output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.MigrationApi()
var opts = {
  'query': query_example, // {String} A CQL query string with search conditions.
  'offset': 56, // {Integer} Skip over a number of elements by specifying an offset value for the query.
  'limit': 56 // {Integer} Limit the number of elements returned in the response.
};

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

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

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

            // Create an instance of the API class
            var apiInstance = new MigrationApi();
            var query = query_example;  // String | A CQL query string with search conditions. (optional)  (default to null)
            var offset = 56;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)
            var limit = 56;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)

            try {
                userMigrationJobs result = apiInstance.getMigrations(query, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MigrationApi.getMigrations: " + e.Message );
            }
        }
    }
}

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MigrationApi();
$query = query_example; // String | A CQL query string with search conditions.
$offset = 56; // Integer | Skip over a number of elements by specifying an offset value for the query.
$limit = 56; // Integer | Limit the number of elements returned in the response.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MigrationApi->new();
my $query = query_example; # String | A CQL query string with search conditions.
my $offset = 56; # Integer | Skip over a number of elements by specifying an offset value for the query.
my $limit = 56; # Integer | Limit the number of elements returned in the response.

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

# Create an instance of the API class
api_instance = openapi_client.MigrationApi()
query = query_example # String | A CQL query string with search conditions. (optional) (default to null)
offset = 56 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)
limit = 56 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)

try:
    api_response = api_instance.get_migrations(query=query, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MigrationApi->getMigrations: %s\n" % e)
extern crate MigrationApi;

pub fn main() {
    let query = query_example; // String
    let offset = 56; // Integer
    let limit = 56; // Integer

    let mut context = MigrationApi::Context::default();
    let result = client.getMigrations(query, offset, limit, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
query
String
A CQL query string with search conditions.
offset
Integer
Skip over a number of elements by specifying an offset value for the query.
limit
Integer
Limit the number of elements returned in the response.

Responses

migrateUsers

Migrate users from mod-users to Keycloak


/users-keycloak/migrations

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost:8081/users-keycloak/migrations"

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

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

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

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

        try {
            userMigrationJob result = apiInstance.migrateUsers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MigrationApi#migrateUsers");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.migrateUsers();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->migrateUsers: $e\n');
}


import org.openapitools.client.api.MigrationApi;

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

        try {
            userMigrationJob result = apiInstance.migrateUsers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MigrationApi#migrateUsers");
            e.printStackTrace();
        }
    }
}


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

[apiInstance migrateUsersWithCompletionHandler: 
              ^(userMigrationJob output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.MigrationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.migrateUsers(callback);

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

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

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

            try {
                userMigrationJob result = apiInstance.migrateUsers();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MigrationApi.migrateUsers: " + e.Message );
            }
        }
    }
}

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

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

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

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

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

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

try:
    api_response = api_instance.migrate_users()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MigrationApi->migrateUsers: %s\n" % e)
extern crate MigrationApi;

pub fn main() {

    let mut context = MigrationApi::Context::default();
    let result = client.migrateUsers(&context).wait();

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

Scopes

Parameters

Responses

PasswordReset

passwordReset


/users-keycloak/password-reset/reset

Usage and SDK Samples

curl -X POST \
 -H "Accept: text/plain,application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/users-keycloak/password-reset/reset" \
 -d ''

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

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

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

        // Create an instance of the API class
        PasswordResetApi apiInstance = new PasswordResetApi();
        PasswordReset passwordReset = ; // PasswordReset | 

        try {
            'String' result = apiInstance.passwordReset(passwordReset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordResetApi#passwordReset");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PasswordReset passwordReset = new PasswordReset(); // PasswordReset | 

try {
    final result = await api_instance.passwordReset(passwordReset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->passwordReset: $e\n');
}


import org.openapitools.client.api.PasswordResetApi;

public class PasswordResetApiExample {
    public static void main(String[] args) {
        PasswordResetApi apiInstance = new PasswordResetApi();
        PasswordReset passwordReset = ; // PasswordReset | 

        try {
            'String' result = apiInstance.passwordReset(passwordReset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordResetApi#passwordReset");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PasswordResetApi *apiInstance = [[PasswordResetApi alloc] init];
PasswordReset *passwordReset = ; //  (optional)

[apiInstance passwordResetWith:passwordReset
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.PasswordResetApi()
var opts = {
  'passwordReset':  // {PasswordReset} 
};

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

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

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

            // Create an instance of the API class
            var apiInstance = new PasswordResetApi();
            var passwordReset = new PasswordReset(); // PasswordReset |  (optional) 

            try {
                'String' result = apiInstance.passwordReset(passwordReset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PasswordResetApi.passwordReset: " + e.Message );
            }
        }
    }
}

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PasswordResetApi();
$passwordReset = ; // PasswordReset | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PasswordResetApi->new();
my $passwordReset = WWW::OPenAPIClient::Object::PasswordReset->new(); # PasswordReset | 

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

# Create an instance of the API class
api_instance = openapi_client.PasswordResetApi()
passwordReset =  # PasswordReset |  (optional)

try:
    api_response = api_instance.password_reset(passwordReset=passwordReset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PasswordResetApi->passwordReset: %s\n" % e)
extern crate PasswordResetApi;

pub fn main() {
    let passwordReset = ; // PasswordReset

    let mut context = PasswordResetApi::Context::default();
    let result = client.passwordReset(passwordReset, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
passwordReset

Responses

Users

createUser

Create a new user


/users-keycloak/users

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/users-keycloak/users?keycloakOnly=true" \
 -d ''

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

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

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

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        User user = ; // User | 
        Boolean keycloakOnly = true; // Boolean | Create auth user only during user creation

        try {
            user result = apiInstance.createUser(user, keycloakOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#createUser");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final User user = new User(); // User | 
final Boolean keycloakOnly = new Boolean(); // Boolean | Create auth user only during user creation

try {
    final result = await api_instance.createUser(user, keycloakOnly);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createUser: $e\n');
}


import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        User user = ; // User | 
        Boolean keycloakOnly = true; // Boolean | Create auth user only during user creation

        try {
            user result = apiInstance.createUser(user, keycloakOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#createUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
User *user = ; // 
Boolean *keycloakOnly = true; // Create auth user only during user creation (optional) (default to false)

[apiInstance createUserWith:user
    keycloakOnly:keycloakOnly
              completionHandler: ^(user output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.UsersApi()
var user = ; // {User} 
var opts = {
  'keycloakOnly': true // {Boolean} Create auth user only during user creation
};

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

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

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

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var user = new User(); // User | 
            var keycloakOnly = true;  // Boolean | Create auth user only during user creation (optional)  (default to false)

            try {
                user result = apiInstance.createUser(user, keycloakOnly);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.createUser: " + e.Message );
            }
        }
    }
}

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$user = ; // User | 
$keycloakOnly = true; // Boolean | Create auth user only during user creation

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $user = WWW::OPenAPIClient::Object::User->new(); # User | 
my $keycloakOnly = true; # Boolean | Create auth user only during user creation

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

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
user =  # User | 
keycloakOnly = true # Boolean | Create auth user only during user creation (optional) (default to false)

try:
    api_response = api_instance.create_user(user, keycloakOnly=keycloakOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->createUser: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let user = ; // User
    let keycloakOnly = true; // Boolean

    let mut context = UsersApi::Context::default();
    let result = client.createUser(user, keycloakOnly, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
user *

Query parameters
Name Description
keycloakOnly
Boolean
Create auth user only during user creation

Responses

deleteUser

Delete user with given id


/users-keycloak/users/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: text/plain,application/json" \
 "http://localhost:8081/users-keycloak/users/{id}"

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

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

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

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id

        try {
            'String' result = apiInstance.deleteUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteUser");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Entity id

try {
    final result = await api_instance.deleteUser(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteUser: $e\n');
}


import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id

        try {
            'String' result = apiInstance.deleteUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Entity id (default to null)

[apiInstance deleteUserWith:id
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.UsersApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Entity id

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

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

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

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Entity id (default to null)

            try {
                'String' result = apiInstance.deleteUser(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.deleteUser: " + e.Message );
            }
        }
    }
}

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Entity id

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

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Entity id (default to null)

try:
    api_response = api_instance.delete_user(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->deleteUser: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = UsersApi::Context::default();
    let result = client.deleteUser(id, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Entity id
Required

Responses

deleteUsers

Delete a collection of users selected by a CQL query; | this doesn't delete proxyFor records that reference them


/users-keycloak/users

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: text/plain,application/json" \
 "http://localhost:8081/users-keycloak/users?query=query_example"

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

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

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

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        String query = query_example; // String | A CQL query string with search conditions.

        try {
            'String' result = apiInstance.deleteUsers(query);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteUsers");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A CQL query string with search conditions.

try {
    final result = await api_instance.deleteUsers(query);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteUsers: $e\n');
}


import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String query = query_example; // String | A CQL query string with search conditions.

        try {
            'String' result = apiInstance.deleteUsers(query);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteUsers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
String *query = query_example; // A CQL query string with search conditions. (optional) (default to null)

[apiInstance deleteUsersWith:query
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.UsersApi()
var opts = {
  'query': query_example // {String} A CQL query string with search conditions.
};

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

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

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

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var query = query_example;  // String | A CQL query string with search conditions. (optional)  (default to null)

            try {
                'String' result = apiInstance.deleteUsers(query);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.deleteUsers: " + e.Message );
            }
        }
    }
}

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$query = query_example; // String | A CQL query string with search conditions.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $query = query_example; # String | A CQL query string with search conditions.

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

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
query = query_example # String | A CQL query string with search conditions. (optional) (default to null)

try:
    api_response = api_instance.delete_users(query=query)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->deleteUsers: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let query = query_example; // String

    let mut context = UsersApi::Context::default();
    let result = client.deleteUsers(query, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
query
String
A CQL query string with search conditions.

Responses

findPermissions

Finds user permissions by filter. desiredPermissions query parameter is required. Wildcard (*) is supported.


/users-keycloak/users/{id}/permissions

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/users-keycloak/users/{id}/permissions?desiredPermissions=["users.collection.get","users.item.*"]"

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

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

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

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id
        array[String] desiredPermissions = ["users.collection.get","users.item.*"]; // array[String] | Permissions of permission prefix to filter by

        try {
            permissionsContainer result = apiInstance.findPermissions(id, desiredPermissions);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#findPermissions");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Entity id
final array[String] desiredPermissions = new array[String](); // array[String] | Permissions of permission prefix to filter by

try {
    final result = await api_instance.findPermissions(id, desiredPermissions);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->findPermissions: $e\n');
}


import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id
        array[String] desiredPermissions = ["users.collection.get","users.item.*"]; // array[String] | Permissions of permission prefix to filter by

        try {
            permissionsContainer result = apiInstance.findPermissions(id, desiredPermissions);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#findPermissions");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Entity id (default to null)
array[String] *desiredPermissions = ["users.collection.get","users.item.*"]; // Permissions of permission prefix to filter by (default to null)

[apiInstance findPermissionsWith:id
    desiredPermissions:desiredPermissions
              completionHandler: ^(permissionsContainer output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.UsersApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Entity id
var desiredPermissions = ["users.collection.get","users.item.*"]; // {array[String]} Permissions of permission prefix to filter by

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

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

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

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Entity id (default to null)
            var desiredPermissions = new array[String](); // array[String] | Permissions of permission prefix to filter by (default to null)

            try {
                permissionsContainer result = apiInstance.findPermissions(id, desiredPermissions);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.findPermissions: " + e.Message );
            }
        }
    }
}

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id
$desiredPermissions = ["users.collection.get","users.item.*"]; // array[String] | Permissions of permission prefix to filter by

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Entity id
my $desiredPermissions = [["users.collection.get","users.item.*"]]; # array[String] | Permissions of permission prefix to filter by

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

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Entity id (default to null)
desiredPermissions = ["users.collection.get","users.item.*"] # array[String] | Permissions of permission prefix to filter by (default to null)

try:
    api_response = api_instance.find_permissions(id, desiredPermissions)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->findPermissions: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let desiredPermissions = ["users.collection.get","users.item.*"]; // array[String]

    let mut context = UsersApi::Context::default();
    let result = client.findPermissions(id, desiredPermissions, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Entity id
Required
Query parameters
Name Description
desiredPermissions*
array[String]
Permissions of permission prefix to filter by
Required

Responses

getUser

Get a single user


/users-keycloak/users/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/users-keycloak/users/{id}"

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

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

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

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id

        try {
            user result = apiInstance.getUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUser");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Entity id

try {
    final result = await api_instance.getUser(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUser: $e\n');
}


import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id

        try {
            user result = apiInstance.getUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Entity id (default to null)

[apiInstance getUserWith:id
              completionHandler: ^(user output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.UsersApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Entity id

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

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

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

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Entity id (default to null)

            try {
                user result = apiInstance.getUser(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.getUser: " + e.Message );
            }
        }
    }
}

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Entity id

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

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Entity id (default to null)

try:
    api_response = api_instance.get_user(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getUser: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = UsersApi::Context::default();
    let result = client.getUser(id, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Entity id
Required

Responses

getUserBySelfReference

Get a user by self reference


/users-keycloak/_self

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/users-keycloak/_self?include=&expandPermissions=true&overrideUser=true"

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

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

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

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        array[includedField] include = ; // array[includedField] | Indicates which referenced fields should be populated (de-referenced) by the service
        Boolean expandPermissions = true; // Boolean | Whether or not to expand permissions listings
        Boolean overrideUser = true; // Boolean | When set to true the real user will be retrieved for ECS login into member tenants

        try {
            compositeUser result = apiInstance.getUserBySelfReference(include, expandPermissions, overrideUser);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUserBySelfReference");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final array[includedField] include = new array[includedField](); // array[includedField] | Indicates which referenced fields should be populated (de-referenced) by the service
final Boolean expandPermissions = new Boolean(); // Boolean | Whether or not to expand permissions listings
final Boolean overrideUser = new Boolean(); // Boolean | When set to true the real user will be retrieved for ECS login into member tenants

try {
    final result = await api_instance.getUserBySelfReference(include, expandPermissions, overrideUser);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUserBySelfReference: $e\n');
}


import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        array[includedField] include = ; // array[includedField] | Indicates which referenced fields should be populated (de-referenced) by the service
        Boolean expandPermissions = true; // Boolean | Whether or not to expand permissions listings
        Boolean overrideUser = true; // Boolean | When set to true the real user will be retrieved for ECS login into member tenants

        try {
            compositeUser result = apiInstance.getUserBySelfReference(include, expandPermissions, overrideUser);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUserBySelfReference");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
array[includedField] *include = ; // Indicates which referenced fields should be populated (de-referenced) by the service (optional) (default to null)
Boolean *expandPermissions = true; // Whether or not to expand permissions listings (optional) (default to false)
Boolean *overrideUser = true; // When set to true the real user will be retrieved for ECS login into member tenants (optional) (default to false)

[apiInstance getUserBySelfReferenceWith:include
    expandPermissions:expandPermissions
    overrideUser:overrideUser
              completionHandler: ^(compositeUser output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.UsersApi()
var opts = {
  'include': , // {array[includedField]} Indicates which referenced fields should be populated (de-referenced) by the service
  'expandPermissions': true, // {Boolean} Whether or not to expand permissions listings
  'overrideUser': true // {Boolean} When set to true the real user will be retrieved for ECS login into member tenants
};

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

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

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

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var include = new array[includedField](); // array[includedField] | Indicates which referenced fields should be populated (de-referenced) by the service (optional)  (default to null)
            var expandPermissions = true;  // Boolean | Whether or not to expand permissions listings (optional)  (default to false)
            var overrideUser = true;  // Boolean | When set to true the real user will be retrieved for ECS login into member tenants (optional)  (default to false)

            try {
                compositeUser result = apiInstance.getUserBySelfReference(include, expandPermissions, overrideUser);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.getUserBySelfReference: " + e.Message );
            }
        }
    }
}

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$include = ; // array[includedField] | Indicates which referenced fields should be populated (de-referenced) by the service
$expandPermissions = true; // Boolean | Whether or not to expand permissions listings
$overrideUser = true; // Boolean | When set to true the real user will be retrieved for ECS login into member tenants

try {
    $result = $api_instance->getUserBySelfReference($include, $expandPermissions, $overrideUser);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->getUserBySelfReference: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $include = []; # array[includedField] | Indicates which referenced fields should be populated (de-referenced) by the service
my $expandPermissions = true; # Boolean | Whether or not to expand permissions listings
my $overrideUser = true; # Boolean | When set to true the real user will be retrieved for ECS login into member tenants

eval {
    my $result = $api_instance->getUserBySelfReference(include => $include, expandPermissions => $expandPermissions, overrideUser => $overrideUser);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->getUserBySelfReference: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
include =  # array[includedField] | Indicates which referenced fields should be populated (de-referenced) by the service (optional) (default to null)
expandPermissions = true # Boolean | Whether or not to expand permissions listings (optional) (default to false)
overrideUser = true # Boolean | When set to true the real user will be retrieved for ECS login into member tenants (optional) (default to false)

try:
    api_response = api_instance.get_user_by_self_reference(include=include, expandPermissions=expandPermissions, overrideUser=overrideUser)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getUserBySelfReference: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let include = ; // array[includedField]
    let expandPermissions = true; // Boolean
    let overrideUser = true; // Boolean

    let mut context = UsersApi::Context::default();
    let result = client.getUserBySelfReference(include, expandPermissions, overrideUser, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
include
array[includedField]
Indicates which referenced fields should be populated (de-referenced) by the service
expandPermissions
Boolean
Whether or not to expand permissions listings
overrideUser
Boolean
When set to true the real user will be retrieved for ECS login into member tenants

Responses

getUsers

Retrieve a list of users


/users-keycloak/users

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/users-keycloak/users?query=query_example&offset=56&limit=56"

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

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

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

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        String query = query_example; // String | A CQL query string with search conditions.
        Integer offset = 56; // Integer | Skip over a number of elements by specifying an offset value for the query.
        Integer limit = 56; // Integer | Limit the number of elements returned in the response.

        try {
            users result = apiInstance.getUsers(query, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUsers");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A CQL query string with search conditions.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.

try {
    final result = await api_instance.getUsers(query, offset, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUsers: $e\n');
}


import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String query = query_example; // String | A CQL query string with search conditions.
        Integer offset = 56; // Integer | Skip over a number of elements by specifying an offset value for the query.
        Integer limit = 56; // Integer | Limit the number of elements returned in the response.

        try {
            users result = apiInstance.getUsers(query, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUsers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
String *query = query_example; // A CQL query string with search conditions. (optional) (default to null)
Integer *offset = 56; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)
Integer *limit = 56; // Limit the number of elements returned in the response. (optional) (default to 10)

[apiInstance getUsersWith:query
    offset:offset
    limit:limit
              completionHandler: ^(users output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.UsersApi()
var opts = {
  'query': query_example, // {String} A CQL query string with search conditions.
  'offset': 56, // {Integer} Skip over a number of elements by specifying an offset value for the query.
  'limit': 56 // {Integer} Limit the number of elements returned in the response.
};

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 Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var query = query_example;  // String | A CQL query string with search conditions. (optional)  (default to null)
            var offset = 56;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)
            var limit = 56;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)

            try {
                users result = apiInstance.getUsers(query, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.getUsers: " + e.Message );
            }
        }
    }
}

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$query = query_example; // String | A CQL query string with search conditions.
$offset = 56; // Integer | Skip over a number of elements by specifying an offset value for the query.
$limit = 56; // Integer | Limit the number of elements returned in the response.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $query = query_example; # String | A CQL query string with search conditions.
my $offset = 56; # Integer | Skip over a number of elements by specifying an offset value for the query.
my $limit = 56; # Integer | Limit the number of elements returned in the response.

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

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
query = query_example # String | A CQL query string with search conditions. (optional) (default to null)
offset = 56 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)
limit = 56 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)

try:
    api_response = api_instance.get_users(query=query, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getUsers: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let query = query_example; // String
    let offset = 56; // Integer
    let limit = 56; // Integer

    let mut context = UsersApi::Context::default();
    let result = client.getUsers(query, offset, limit, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
query
String
A CQL query string with search conditions.
offset
Integer
Skip over a number of elements by specifying an offset value for the query.
limit
Integer
Limit the number of elements returned in the response.

Responses

updateUser

Update user with given id


/users-keycloak/users/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: text/plain,application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/users-keycloak/users/{id}" \
 -d ''

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

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

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

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id
        User user = ; // User | 

        try {
            'String' result = apiInstance.updateUser(id, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateUser");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Entity id
final User user = new User(); // User | 

try {
    final result = await api_instance.updateUser(id, user);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateUser: $e\n');
}


import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id
        User user = ; // User | 

        try {
            'String' result = apiInstance.updateUser(id, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Entity id (default to null)
User *user = ; // 

[apiInstance updateUserWith:id
    user:user
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UsersKeycloakApi = require('users_keycloak_api');

// Create an instance of the API class
var api = new UsersKeycloakApi.UsersApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Entity id
var user = ; // {User} 

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

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

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

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Entity id (default to null)
            var user = new User(); // User | 

            try {
                'String' result = apiInstance.updateUser(id, user);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.updateUser: " + e.Message );
            }
        }
    }
}

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id
$user = ; // User | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Entity id
my $user = WWW::OPenAPIClient::Object::User->new(); # User | 

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

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Entity id (default to null)
user =  # User | 

try:
    api_response = api_instance.update_user(id, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->updateUser: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let user = ; // User

    let mut context = UsersApi::Context::default();
    let result = client.updateUser(id, user, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Entity id
Required
Body parameters
Name Description
user *

Responses