Mod Roles Keycloak API

Capability

findCapabilities

Get capabilities by query


/capabilities

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/capabilities?query=role&limit=20&offset=2"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CapabilityApi;

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

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

        // Create an instance of the API class
        CapabilityApi apiInstance = new CapabilityApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            capabilities result = apiInstance.findCapabilities(query, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CapabilityApi#findCapabilities");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A query string to filter users based on matching criteria in fields.
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.

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

import org.openapitools.client.api.CapabilityApi;

public class CapabilityApiExample {
    public static void main(String[] args) {
        CapabilityApi apiInstance = new CapabilityApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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


// Create an instance of the API class
CapabilityApi *apiInstance = [[CapabilityApi alloc] init];
String *query = role; // A query string to filter users based on matching criteria in fields. (optional) (default to null)
Integer *limit = 20; // Limit the number of elements returned in the response. (optional) (default to 10)
Integer *offset = 2; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

[apiInstance findCapabilitiesWith:query
    limit:limit
    offset:offset
              completionHandler: ^(capabilities output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.CapabilityApi()
var opts = {
  'query': role, // {String} A query string to filter users based on matching criteria in fields.
  'limit': 20, // {Integer} Limit the number of elements returned in the response.
  'offset': 2 // {Integer} Skip over a number of elements by specifying an offset value for the query.
};

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

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

            // Create an instance of the API class
            var apiInstance = new CapabilityApi();
            var query = role;  // String | A query string to filter users based on matching criteria in fields. (optional)  (default to null)
            var limit = 20;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)
            var offset = 2;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)

            try {
                capabilities result = apiInstance.findCapabilities(query, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CapabilityApi.findCapabilities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CapabilityApi();
$query = role; // String | A query string to filter users based on matching criteria in fields.
$limit = 20; // Integer | Limit the number of elements returned in the response.
$offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CapabilityApi->new();
my $query = role; # String | A query string to filter users based on matching criteria in fields.
my $limit = 20; # Integer | Limit the number of elements returned in the response.
my $offset = 2; # Integer | Skip over a number of elements by specifying an offset value for the query.

eval {
    my $result = $api_instance->findCapabilities(query => $query, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CapabilityApi->findCapabilities: $@\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.CapabilityApi()
query = role # String | A query string to filter users based on matching criteria in fields. (optional) (default to null)
limit = 20 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)
offset = 2 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

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

pub fn main() {
    let query = role; // String
    let limit = 20; // Integer
    let offset = 2; // Integer

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

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

Scopes

Parameters

Query parameters
Name Description
query
String
A query string to filter users based on matching criteria in fields.
limit
Integer
Limit the number of elements returned in the response.
offset
Integer
Skip over a number of elements by specifying an offset value for the query.

Responses


findCapabilitiesByCapabilitySetId

Find capabilities by capability set ID


/capability-sets/{id}/capabilities

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/capability-sets/{id}/capabilities?includeDummy=false&limit=20&offset=2"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CapabilityApi;

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

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

        // Create an instance of the API class
        CapabilityApi apiInstance = new CapabilityApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id
        Boolean includeDummy = false; // Boolean | Include dummy capabilities.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            capabilities result = apiInstance.findCapabilitiesByCapabilitySetId(id, includeDummy, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CapabilityApi#findCapabilitiesByCapabilitySetId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Entity id
final Boolean includeDummy = new Boolean(); // Boolean | Include dummy capabilities.
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.

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

import org.openapitools.client.api.CapabilityApi;

public class CapabilityApiExample {
    public static void main(String[] args) {
        CapabilityApi apiInstance = new CapabilityApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id
        Boolean includeDummy = false; // Boolean | Include dummy capabilities.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            capabilities result = apiInstance.findCapabilitiesByCapabilitySetId(id, includeDummy, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CapabilityApi#findCapabilitiesByCapabilitySetId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CapabilityApi *apiInstance = [[CapabilityApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Entity id (default to null)
Boolean *includeDummy = false; // Include dummy capabilities. (optional) (default to false)
Integer *limit = 20; // Limit the number of elements returned in the response. (optional) (default to 10)
Integer *offset = 2; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

[apiInstance findCapabilitiesByCapabilitySetIdWith:id
    includeDummy:includeDummy
    limit:limit
    offset:offset
              completionHandler: ^(capabilities output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.CapabilityApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Entity id
var opts = {
  'includeDummy': false, // {Boolean} Include dummy capabilities.
  'limit': 20, // {Integer} Limit the number of elements returned in the response.
  'offset': 2 // {Integer} Skip over a number of elements by specifying an offset value for the query.
};

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

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

            // Create an instance of the API class
            var apiInstance = new CapabilityApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Entity id (default to null)
            var includeDummy = false;  // Boolean | Include dummy capabilities. (optional)  (default to false)
            var limit = 20;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)
            var offset = 2;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)

            try {
                capabilities result = apiInstance.findCapabilitiesByCapabilitySetId(id, includeDummy, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CapabilityApi.findCapabilitiesByCapabilitySetId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CapabilityApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id
$includeDummy = false; // Boolean | Include dummy capabilities.
$limit = 20; // Integer | Limit the number of elements returned in the response.
$offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CapabilityApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Entity id
my $includeDummy = false; # Boolean | Include dummy capabilities.
my $limit = 20; # Integer | Limit the number of elements returned in the response.
my $offset = 2; # Integer | Skip over a number of elements by specifying an offset value for the query.

eval {
    my $result = $api_instance->findCapabilitiesByCapabilitySetId(id => $id, includeDummy => $includeDummy, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CapabilityApi->findCapabilitiesByCapabilitySetId: $@\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.CapabilityApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Entity id (default to null)
includeDummy = false # Boolean | Include dummy capabilities. (optional) (default to false)
limit = 20 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)
offset = 2 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

try:
    api_response = api_instance.find_capabilities_by_capability_set_id(id, includeDummy=includeDummy, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CapabilityApi->findCapabilitiesByCapabilitySetId: %s\n" % e)
extern crate CapabilityApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let includeDummy = false; // Boolean
    let limit = 20; // Integer
    let offset = 2; // Integer

    let mut context = CapabilityApi::Context::default();
    let result = client.findCapabilitiesByCapabilitySetId(id, includeDummy, limit, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Entity id
Required
Query parameters
Name Description
includeDummy
Boolean
Include dummy capabilities.
limit
Integer
Limit the number of elements returned in the response.
offset
Integer
Skip over a number of elements by specifying an offset value for the query.

Responses


getCapabilityById

Get capability by ID


/capabilities/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/capabilities/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CapabilityApi;

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

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

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

        try {
            capability result = apiInstance.getCapabilityById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CapabilityApi#getCapabilityById");
            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.getCapabilityById(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCapabilityById: $e\n');
}

import org.openapitools.client.api.CapabilityApi;

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

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


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

[apiInstance getCapabilityByIdWith:id
              completionHandler: ^(capability output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.CapabilityApi()
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.getCapabilityById(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

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

            try {
                capability result = apiInstance.getCapabilityById(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CapabilityApi.getCapabilityById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval {
    my $result = $api_instance->getCapabilityById(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CapabilityApi->getCapabilityById: $@\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.CapabilityApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Entity id (default to null)

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

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

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

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

Scopes

Parameters

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

Responses


CapabilitySet

findCapabilitySets

Get capabilities by query


/capability-sets

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/capability-sets?query=role&limit=20&offset=2"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CapabilitySetApi;

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

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

        // Create an instance of the API class
        CapabilitySetApi apiInstance = new CapabilitySetApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            capabilitySets result = apiInstance.findCapabilitySets(query, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CapabilitySetApi#findCapabilitySets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A query string to filter users based on matching criteria in fields.
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.

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

import org.openapitools.client.api.CapabilitySetApi;

public class CapabilitySetApiExample {
    public static void main(String[] args) {
        CapabilitySetApi apiInstance = new CapabilitySetApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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


// Create an instance of the API class
CapabilitySetApi *apiInstance = [[CapabilitySetApi alloc] init];
String *query = role; // A query string to filter users based on matching criteria in fields. (optional) (default to null)
Integer *limit = 20; // Limit the number of elements returned in the response. (optional) (default to 10)
Integer *offset = 2; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

[apiInstance findCapabilitySetsWith:query
    limit:limit
    offset:offset
              completionHandler: ^(capabilitySets output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.CapabilitySetApi()
var opts = {
  'query': role, // {String} A query string to filter users based on matching criteria in fields.
  'limit': 20, // {Integer} Limit the number of elements returned in the response.
  'offset': 2 // {Integer} Skip over a number of elements by specifying an offset value for the query.
};

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

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

            // Create an instance of the API class
            var apiInstance = new CapabilitySetApi();
            var query = role;  // String | A query string to filter users based on matching criteria in fields. (optional)  (default to null)
            var limit = 20;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)
            var offset = 2;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)

            try {
                capabilitySets result = apiInstance.findCapabilitySets(query, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CapabilitySetApi.findCapabilitySets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CapabilitySetApi();
$query = role; // String | A query string to filter users based on matching criteria in fields.
$limit = 20; // Integer | Limit the number of elements returned in the response.
$offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CapabilitySetApi->new();
my $query = role; # String | A query string to filter users based on matching criteria in fields.
my $limit = 20; # Integer | Limit the number of elements returned in the response.
my $offset = 2; # Integer | Skip over a number of elements by specifying an offset value for the query.

eval {
    my $result = $api_instance->findCapabilitySets(query => $query, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CapabilitySetApi->findCapabilitySets: $@\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.CapabilitySetApi()
query = role # String | A query string to filter users based on matching criteria in fields. (optional) (default to null)
limit = 20 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)
offset = 2 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

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

pub fn main() {
    let query = role; // String
    let limit = 20; // Integer
    let offset = 2; // Integer

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

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

Scopes

Parameters

Query parameters
Name Description
query
String
A query string to filter users based on matching criteria in fields.
limit
Integer
Limit the number of elements returned in the response.
offset
Integer
Skip over a number of elements by specifying an offset value for the query.

Responses


getCapabilitySetById

Get capability set by ID


/capability-sets/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/capability-sets/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CapabilitySetApi;

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

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

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

        try {
            capabilitySet result = apiInstance.getCapabilitySetById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CapabilitySetApi#getCapabilitySetById");
            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.getCapabilitySetById(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCapabilitySetById: $e\n');
}

import org.openapitools.client.api.CapabilitySetApi;

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

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


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

[apiInstance getCapabilitySetByIdWith:id
              completionHandler: ^(capabilitySet output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.CapabilitySetApi()
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.getCapabilitySetById(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

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

            try {
                capabilitySet result = apiInstance.getCapabilitySetById(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CapabilitySetApi.getCapabilitySetById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval {
    my $result = $api_instance->getCapabilitySetById(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CapabilitySetApi->getCapabilitySetById: $@\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.CapabilitySetApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Entity id (default to null)

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

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

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

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

Scopes

Parameters

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

Responses


LoadableRoles

findLoadableRoles

Get loadable roles by query


/loadable-roles

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/loadable-roles?query=role&limit=20&offset=2"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LoadableRolesApi;

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

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

        // Create an instance of the API class
        LoadableRolesApi apiInstance = new LoadableRolesApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            loadableRoles result = apiInstance.findLoadableRoles(query, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoadableRolesApi#findLoadableRoles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A query string to filter users based on matching criteria in fields.
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.

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

import org.openapitools.client.api.LoadableRolesApi;

public class LoadableRolesApiExample {
    public static void main(String[] args) {
        LoadableRolesApi apiInstance = new LoadableRolesApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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


// Create an instance of the API class
LoadableRolesApi *apiInstance = [[LoadableRolesApi alloc] init];
String *query = role; // A query string to filter users based on matching criteria in fields. (optional) (default to null)
Integer *limit = 20; // Limit the number of elements returned in the response. (optional) (default to 10)
Integer *offset = 2; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

[apiInstance findLoadableRolesWith:query
    limit:limit
    offset:offset
              completionHandler: ^(loadableRoles output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.LoadableRolesApi()
var opts = {
  'query': role, // {String} A query string to filter users based on matching criteria in fields.
  'limit': 20, // {Integer} Limit the number of elements returned in the response.
  'offset': 2 // {Integer} Skip over a number of elements by specifying an offset value for the query.
};

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

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

            // Create an instance of the API class
            var apiInstance = new LoadableRolesApi();
            var query = role;  // String | A query string to filter users based on matching criteria in fields. (optional)  (default to null)
            var limit = 20;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)
            var offset = 2;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)

            try {
                loadableRoles result = apiInstance.findLoadableRoles(query, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LoadableRolesApi.findLoadableRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LoadableRolesApi();
$query = role; // String | A query string to filter users based on matching criteria in fields.
$limit = 20; // Integer | Limit the number of elements returned in the response.
$offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LoadableRolesApi->new();
my $query = role; # String | A query string to filter users based on matching criteria in fields.
my $limit = 20; # Integer | Limit the number of elements returned in the response.
my $offset = 2; # Integer | Skip over a number of elements by specifying an offset value for the query.

eval {
    my $result = $api_instance->findLoadableRoles(query => $query, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoadableRolesApi->findLoadableRoles: $@\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.LoadableRolesApi()
query = role # String | A query string to filter users based on matching criteria in fields. (optional) (default to null)
limit = 20 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)
offset = 2 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

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

pub fn main() {
    let query = role; // String
    let limit = 20; // Integer
    let offset = 2; // Integer

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

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

Scopes

Parameters

Query parameters
Name Description
query
String
A query string to filter users based on matching criteria in fields.
limit
Integer
Limit the number of elements returned in the response.
offset
Integer
Skip over a number of elements by specifying an offset value for the query.

Responses


upsertLoadableRole

A default role is created or updated, role is populated with the specified permissions (capabilities and capability sets) as they become available in the system. Default role cannot be changed via Roles API.


/loadable-roles

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/loadable-roles" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LoadableRolesApi;

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

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

        // Create an instance of the API class
        LoadableRolesApi apiInstance = new LoadableRolesApi();
        LoadableRole loadableRole = ; // LoadableRole | 

        try {
            loadableRole result = apiInstance.upsertLoadableRole(loadableRole);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoadableRolesApi#upsertLoadableRole");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final LoadableRole loadableRole = new LoadableRole(); // LoadableRole | 

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

import org.openapitools.client.api.LoadableRolesApi;

public class LoadableRolesApiExample {
    public static void main(String[] args) {
        LoadableRolesApi apiInstance = new LoadableRolesApi();
        LoadableRole loadableRole = ; // LoadableRole | 

        try {
            loadableRole result = apiInstance.upsertLoadableRole(loadableRole);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoadableRolesApi#upsertLoadableRole");
            e.printStackTrace();
        }
    }
}


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

[apiInstance upsertLoadableRoleWith:loadableRole
              completionHandler: ^(loadableRole output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.LoadableRolesApi()
var loadableRole = ; // {LoadableRole} 

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

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

            // Create an instance of the API class
            var apiInstance = new LoadableRolesApi();
            var loadableRole = new LoadableRole(); // LoadableRole | 

            try {
                loadableRole result = apiInstance.upsertLoadableRole(loadableRole);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LoadableRolesApi.upsertLoadableRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LoadableRolesApi();
$loadableRole = ; // LoadableRole | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LoadableRolesApi->new();
my $loadableRole = WWW::OPenAPIClient::Object::LoadableRole->new(); # LoadableRole | 

eval {
    my $result = $api_instance->upsertLoadableRole(loadableRole => $loadableRole);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoadableRolesApi->upsertLoadableRole: $@\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.LoadableRolesApi()
loadableRole =  # LoadableRole | 

try:
    api_response = api_instance.upsert_loadable_role(loadableRole)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LoadableRolesApi->upsertLoadableRole: %s\n" % e)
extern crate LoadableRolesApi;

pub fn main() {
    let loadableRole = ; // LoadableRole

    let mut context = LoadableRolesApi::Context::default();
    let result = client.upsertLoadableRole(loadableRole, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
loadableRole *

Responses


Migration

deleteMigration

Delete a permission migration


/roles-keycloak/migrations/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: text/plain" \
 "http://localhost:8081/roles-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 ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.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


findMigrations

Retrieve a list of permission migrations


/roles-keycloak/migrations

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/roles-keycloak/migrations?query=role&offset=2&limit=20"
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 = role; // String | A query string to filter users based on matching criteria in fields.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.

        try {
            permissionMigrationJobs result = apiInstance.findMigrations(query, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MigrationApi#findMigrations");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A query string to filter users based on matching criteria in fields.
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.findMigrations(query, offset, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->findMigrations: $e\n');
}

import org.openapitools.client.api.MigrationApi;

public class MigrationApiExample {
    public static void main(String[] args) {
        MigrationApi apiInstance = new MigrationApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.

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


// Create an instance of the API class
MigrationApi *apiInstance = [[MigrationApi alloc] init];
String *query = role; // A query string to filter users based on matching criteria in fields. (optional) (default to null)
Integer *offset = 2; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)
Integer *limit = 20; // Limit the number of elements returned in the response. (optional) (default to 10)

[apiInstance findMigrationsWith:query
    offset:offset
    limit:limit
              completionHandler: ^(permissionMigrationJobs output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.MigrationApi()
var opts = {
  'query': role, // {String} A query string to filter users based on matching criteria in fields.
  'offset': 2, // {Integer} Skip over a number of elements by specifying an offset value for the query.
  'limit': 20 // {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.findMigrations(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new MigrationApi();
            var query = role;  // String | A query string to filter users based on matching criteria in fields. (optional)  (default to null)
            var offset = 2;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)
            var limit = 20;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)

            try {
                permissionMigrationJobs result = apiInstance.findMigrations(query, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MigrationApi.findMigrations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MigrationApi();
$query = role; // String | A query string to filter users based on matching criteria in fields.
$offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.
$limit = 20; // Integer | Limit the number of elements returned in the response.

try {
    $result = $api_instance->findMigrations($query, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MigrationApi->findMigrations: ', $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 = role; # String | A query string to filter users based on matching criteria in fields.
my $offset = 2; # Integer | Skip over a number of elements by specifying an offset value for the query.
my $limit = 20; # Integer | Limit the number of elements returned in the response.

eval {
    my $result = $api_instance->findMigrations(query => $query, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MigrationApi->findMigrations: $@\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 = role # String | A query string to filter users based on matching criteria in fields. (optional) (default to null)
offset = 2 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)
limit = 20 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)

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

pub fn main() {
    let query = role; // String
    let offset = 2; // Integer
    let limit = 20; // Integer

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

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

Scopes

Parameters

Query parameters
Name Description
query
String
A query string to filter users based on matching criteria in fields.
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


getMigration

Retrieve a permission migration


/roles-keycloak/migrations/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/roles-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 {
            permissionMigrationJob 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 {
            permissionMigrationJob 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: ^(permissionMigrationJob output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.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 {
                permissionMigrationJob 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


getMigrationErrors

Retrieve errors for a specific migration job


/roles-keycloak/migrations/{id}/errors

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/roles-keycloak/migrations/{id}/errors?limit=20&offset=2"
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
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            permissionMigrationErrors result = apiInstance.getMigrationErrors(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MigrationApi#getMigrationErrors");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Entity id
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.

try {
    final result = await api_instance.getMigrationErrors(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getMigrationErrors: $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
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            permissionMigrationErrors result = apiInstance.getMigrationErrors(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MigrationApi#getMigrationErrors");
            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)
Integer *limit = 20; // Limit the number of elements returned in the response. (optional) (default to 10)
Integer *offset = 2; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

[apiInstance getMigrationErrorsWith:id
    limit:limit
    offset:offset
              completionHandler: ^(permissionMigrationErrors output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.MigrationApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Entity id
var opts = {
  'limit': 20, // {Integer} Limit the number of elements returned in the response.
  'offset': 2 // {Integer} Skip over a number of elements by specifying an offset value for the query.
};

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

namespace Example
{
    public class getMigrationErrorsExample
    {
        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)
            var limit = 20;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)
            var offset = 2;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)

            try {
                permissionMigrationErrors result = apiInstance.getMigrationErrors(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MigrationApi.getMigrationErrors: " + 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
$limit = 20; // Integer | Limit the number of elements returned in the response.
$offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

try {
    $result = $api_instance->getMigrationErrors($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MigrationApi->getMigrationErrors: ', $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
my $limit = 20; # Integer | Limit the number of elements returned in the response.
my $offset = 2; # Integer | Skip over a number of elements by specifying an offset value for the query.

eval {
    my $result = $api_instance->getMigrationErrors(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MigrationApi->getMigrationErrors: $@\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)
limit = 20 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)
offset = 2 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

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

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Entity id
Required
Query parameters
Name Description
limit
Integer
Limit the number of elements returned in the response.
offset
Integer
Skip over a number of elements by specifying an offset value for the query.

Responses


migratePermissions

Migrate user permissions from mod-permissions to Keycloak


/roles-keycloak/migrations

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost:8081/roles-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 {
            permissionMigrationJob result = apiInstance.migratePermissions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MigrationApi#migratePermissions");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


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

import org.openapitools.client.api.MigrationApi;

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

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


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

[apiInstance migratePermissionsWithCompletionHandler: 
              ^(permissionMigrationJob output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

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

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

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

            try {
                permissionMigrationJob result = apiInstance.migratePermissions();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MigrationApi.migratePermissions: " + 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->migratePermissions();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MigrationApi->migratePermissions: ', $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->migratePermissions();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MigrationApi->migratePermissions: $@\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_permissions()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MigrationApi->migratePermissions: %s\n" % e)
extern crate MigrationApi;

pub fn main() {

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

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

Scopes

Parameters

Responses


PermissionsUsers

getPermissionsUser

Get permissions by user ID. If there is onlyVisible=true, then desiredPermissions are ignored.


/permissions/users/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/permissions/users/{id}?onlyVisible=false&desiredPermissions=["users.item.get","users.collection.*"]"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PermissionsUsersApi;

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

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

        // Create an instance of the API class
        PermissionsUsersApi apiInstance = new PermissionsUsersApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id
        Boolean onlyVisible = false; // Boolean | Return only visible permission sets
        array[String] desiredPermissions = ["users.item.get","users.collection.*"]; // array[String] | A list of permissions to filter by

        try {
            permissionsUser result = apiInstance.getPermissionsUser(id, onlyVisible, desiredPermissions);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsUsersApi#getPermissionsUser");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Entity id
final Boolean onlyVisible = new Boolean(); // Boolean | Return only visible permission sets
final array[String] desiredPermissions = new array[String](); // array[String] | A list of permissions to filter by

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

import org.openapitools.client.api.PermissionsUsersApi;

public class PermissionsUsersApiExample {
    public static void main(String[] args) {
        PermissionsUsersApi apiInstance = new PermissionsUsersApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id
        Boolean onlyVisible = false; // Boolean | Return only visible permission sets
        array[String] desiredPermissions = ["users.item.get","users.collection.*"]; // array[String] | A list of permissions to filter by

        try {
            permissionsUser result = apiInstance.getPermissionsUser(id, onlyVisible, desiredPermissions);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsUsersApi#getPermissionsUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PermissionsUsersApi *apiInstance = [[PermissionsUsersApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Entity id (default to null)
Boolean *onlyVisible = false; // Return only visible permission sets (optional) (default to false)
array[String] *desiredPermissions = ["users.item.get","users.collection.*"]; // A list of permissions to filter by (optional) (default to null)

[apiInstance getPermissionsUserWith:id
    onlyVisible:onlyVisible
    desiredPermissions:desiredPermissions
              completionHandler: ^(permissionsUser output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.PermissionsUsersApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Entity id
var opts = {
  'onlyVisible': false, // {Boolean} Return only visible permission sets
  'desiredPermissions': ["users.item.get","users.collection.*"] // {array[String]} A list of permissions to filter by
};

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

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

            // Create an instance of the API class
            var apiInstance = new PermissionsUsersApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Entity id (default to null)
            var onlyVisible = false;  // Boolean | Return only visible permission sets (optional)  (default to false)
            var desiredPermissions = new array[String](); // array[String] | A list of permissions to filter by (optional)  (default to null)

            try {
                permissionsUser result = apiInstance.getPermissionsUser(id, onlyVisible, desiredPermissions);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PermissionsUsersApi.getPermissionsUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PermissionsUsersApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Entity id
$onlyVisible = false; // Boolean | Return only visible permission sets
$desiredPermissions = ["users.item.get","users.collection.*"]; // array[String] | A list of permissions to filter by

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PermissionsUsersApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Entity id
my $onlyVisible = false; # Boolean | Return only visible permission sets
my $desiredPermissions = [["users.item.get","users.collection.*"]]; # array[String] | A list of permissions to filter by

eval {
    my $result = $api_instance->getPermissionsUser(id => $id, onlyVisible => $onlyVisible, desiredPermissions => $desiredPermissions);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PermissionsUsersApi->getPermissionsUser: $@\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.PermissionsUsersApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Entity id (default to null)
onlyVisible = false # Boolean | Return only visible permission sets (optional) (default to false)
desiredPermissions = ["users.item.get","users.collection.*"] # array[String] | A list of permissions to filter by (optional) (default to null)

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

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

    let mut context = PermissionsUsersApi::Context::default();
    let result = client.getPermissionsUser(id, onlyVisible, desiredPermissions, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Entity id
Required
Query parameters
Name Description
onlyVisible
Boolean
Return only visible permission sets
desiredPermissions
array[String]
A list of permissions to filter by

Responses


Policies

createPolicies

Create one or more policies


/policies/batch

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/policies/batch" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoliciesApi;

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

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

        // Create an instance of the API class
        PoliciesApi apiInstance = new PoliciesApi();
        PoliciesRequest policiesRequest = {"$ref":"#/components/examples/policiesRequest"}; // PoliciesRequest | 

        try {
            policies result = apiInstance.createPolicies(policiesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#createPolicies");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PoliciesRequest policiesRequest = new PoliciesRequest(); // PoliciesRequest | 

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

import org.openapitools.client.api.PoliciesApi;

public class PoliciesApiExample {
    public static void main(String[] args) {
        PoliciesApi apiInstance = new PoliciesApi();
        PoliciesRequest policiesRequest = {"$ref":"#/components/examples/policiesRequest"}; // PoliciesRequest | 

        try {
            policies result = apiInstance.createPolicies(policiesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#createPolicies");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoliciesApi *apiInstance = [[PoliciesApi alloc] init];
PoliciesRequest *policiesRequest = {"$ref":"#/components/examples/policiesRequest"}; // 

[apiInstance createPoliciesWith:policiesRequest
              completionHandler: ^(policies output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.PoliciesApi()
var policiesRequest = {"$ref":"#/components/examples/policiesRequest"}; // {PoliciesRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new PoliciesApi();
            var policiesRequest = new PoliciesRequest(); // PoliciesRequest | 

            try {
                policies result = apiInstance.createPolicies(policiesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoliciesApi.createPolicies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoliciesApi();
$policiesRequest = {"$ref":"#/components/examples/policiesRequest"}; // PoliciesRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoliciesApi->new();
my $policiesRequest = WWW::OPenAPIClient::Object::PoliciesRequest->new(); # PoliciesRequest | 

eval {
    my $result = $api_instance->createPolicies(policiesRequest => $policiesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoliciesApi->createPolicies: $@\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.PoliciesApi()
policiesRequest = {"$ref":"#/components/examples/policiesRequest"} # PoliciesRequest | 

try:
    api_response = api_instance.create_policies(policiesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoliciesApi->createPolicies: %s\n" % e)
extern crate PoliciesApi;

pub fn main() {
    let policiesRequest = {"$ref":"#/components/examples/policiesRequest"}; // PoliciesRequest

    let mut context = PoliciesApi::Context::default();
    let result = client.createPolicies(policiesRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
policiesRequest *

Responses


createPolicy

Create a policy


/policies

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/policies" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoliciesApi;

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

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

        // Create an instance of the API class
        PoliciesApi apiInstance = new PoliciesApi();
        Policy policy = {"$ref":"#/components/examples/timeBasedPolicy"}; // Policy | 

        try {
            policy result = apiInstance.createPolicy(policy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#createPolicy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Policy policy = new Policy(); // Policy | 

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

import org.openapitools.client.api.PoliciesApi;

public class PoliciesApiExample {
    public static void main(String[] args) {
        PoliciesApi apiInstance = new PoliciesApi();
        Policy policy = {"$ref":"#/components/examples/timeBasedPolicy"}; // Policy | 

        try {
            policy result = apiInstance.createPolicy(policy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#createPolicy");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoliciesApi *apiInstance = [[PoliciesApi alloc] init];
Policy *policy = {"$ref":"#/components/examples/timeBasedPolicy"}; // 

[apiInstance createPolicyWith:policy
              completionHandler: ^(policy output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.PoliciesApi()
var policy = {"$ref":"#/components/examples/timeBasedPolicy"}; // {Policy} 

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

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

            // Create an instance of the API class
            var apiInstance = new PoliciesApi();
            var policy = new Policy(); // Policy | 

            try {
                policy result = apiInstance.createPolicy(policy);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoliciesApi.createPolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoliciesApi();
$policy = {"$ref":"#/components/examples/timeBasedPolicy"}; // Policy | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoliciesApi->new();
my $policy = WWW::OPenAPIClient::Object::Policy->new(); # Policy | 

eval {
    my $result = $api_instance->createPolicy(policy => $policy);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoliciesApi->createPolicy: $@\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.PoliciesApi()
policy = {"$ref":"#/components/examples/timeBasedPolicy"} # Policy | 

try:
    api_response = api_instance.create_policy(policy)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoliciesApi->createPolicy: %s\n" % e)
extern crate PoliciesApi;

pub fn main() {
    let policy = {"$ref":"#/components/examples/timeBasedPolicy"}; // Policy

    let mut context = PoliciesApi::Context::default();
    let result = client.createPolicy(policy, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
policy *

Responses


deletePolicy

Delete a policy


/policies/{id}

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8081/policies/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoliciesApi;

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

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

        // Create an instance of the API class
        PoliciesApi apiInstance = new PoliciesApi();
        UUID id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Policy identifier

        try {
            apiInstance.deletePolicy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#deletePolicy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Policy identifier

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

import org.openapitools.client.api.PoliciesApi;

public class PoliciesApiExample {
    public static void main(String[] args) {
        PoliciesApi apiInstance = new PoliciesApi();
        UUID id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Policy identifier

        try {
            apiInstance.deletePolicy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#deletePolicy");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoliciesApi *apiInstance = [[PoliciesApi alloc] init];
UUID *id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; // Policy identifier (default to null)

[apiInstance deletePolicyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.PoliciesApi()
var id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; // {UUID} Policy identifier

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

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

            // Create an instance of the API class
            var apiInstance = new PoliciesApi();
            var id = 1e589e76-e9ca-401c-ad8e-0d121a11111e;  // UUID | Policy identifier (default to null)

            try {
                apiInstance.deletePolicy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoliciesApi.deletePolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoliciesApi();
$id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Policy identifier

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoliciesApi->new();
my $id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; # UUID | Policy identifier

eval {
    $api_instance->deletePolicy(id => $id);
};
if ($@) {
    warn "Exception when calling PoliciesApi->deletePolicy: $@\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.PoliciesApi()
id = 1e589e76-e9ca-401c-ad8e-0d121a11111e # UUID | Policy identifier (default to null)

try:
    api_instance.delete_policy(id)
except ApiException as e:
    print("Exception when calling PoliciesApi->deletePolicy: %s\n" % e)
extern crate PoliciesApi;

pub fn main() {
    let id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; // UUID

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

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Policy identifier
Required

Responses


findPolicies

Get policies by query


/policies

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/policies?query=role&limit=20&offset=2"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoliciesApi;

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

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

        // Create an instance of the API class
        PoliciesApi apiInstance = new PoliciesApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            policies result = apiInstance.findPolicies(query, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#findPolicies");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A query string to filter users based on matching criteria in fields.
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.

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

import org.openapitools.client.api.PoliciesApi;

public class PoliciesApiExample {
    public static void main(String[] args) {
        PoliciesApi apiInstance = new PoliciesApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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


// Create an instance of the API class
PoliciesApi *apiInstance = [[PoliciesApi alloc] init];
String *query = role; // A query string to filter users based on matching criteria in fields. (optional) (default to null)
Integer *limit = 20; // Limit the number of elements returned in the response. (optional) (default to 10)
Integer *offset = 2; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

[apiInstance findPoliciesWith:query
    limit:limit
    offset:offset
              completionHandler: ^(policies output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.PoliciesApi()
var opts = {
  'query': role, // {String} A query string to filter users based on matching criteria in fields.
  'limit': 20, // {Integer} Limit the number of elements returned in the response.
  'offset': 2 // {Integer} Skip over a number of elements by specifying an offset value for the query.
};

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

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

            // Create an instance of the API class
            var apiInstance = new PoliciesApi();
            var query = role;  // String | A query string to filter users based on matching criteria in fields. (optional)  (default to null)
            var limit = 20;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)
            var offset = 2;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)

            try {
                policies result = apiInstance.findPolicies(query, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoliciesApi.findPolicies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoliciesApi();
$query = role; // String | A query string to filter users based on matching criteria in fields.
$limit = 20; // Integer | Limit the number of elements returned in the response.
$offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoliciesApi->new();
my $query = role; # String | A query string to filter users based on matching criteria in fields.
my $limit = 20; # Integer | Limit the number of elements returned in the response.
my $offset = 2; # Integer | Skip over a number of elements by specifying an offset value for the query.

eval {
    my $result = $api_instance->findPolicies(query => $query, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoliciesApi->findPolicies: $@\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.PoliciesApi()
query = role # String | A query string to filter users based on matching criteria in fields. (optional) (default to null)
limit = 20 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)
offset = 2 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

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

pub fn main() {
    let query = role; // String
    let limit = 20; // Integer
    let offset = 2; // Integer

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

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

Scopes

Parameters

Query parameters
Name Description
query
String
A query string to filter users based on matching criteria in fields.
limit
Integer
Limit the number of elements returned in the response.
offset
Integer
Skip over a number of elements by specifying an offset value for the query.

Responses


getPolicy

Get policy by ID


/policies/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/policies/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoliciesApi;

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

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

        // Create an instance of the API class
        PoliciesApi apiInstance = new PoliciesApi();
        UUID id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Policy identifier

        try {
            policy result = apiInstance.getPolicy(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#getPolicy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Policy identifier

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

import org.openapitools.client.api.PoliciesApi;

public class PoliciesApiExample {
    public static void main(String[] args) {
        PoliciesApi apiInstance = new PoliciesApi();
        UUID id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Policy identifier

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


// Create an instance of the API class
PoliciesApi *apiInstance = [[PoliciesApi alloc] init];
UUID *id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; // Policy identifier (default to null)

[apiInstance getPolicyWith:id
              completionHandler: ^(policy output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.PoliciesApi()
var id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; // {UUID} Policy identifier

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

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

            // Create an instance of the API class
            var apiInstance = new PoliciesApi();
            var id = 1e589e76-e9ca-401c-ad8e-0d121a11111e;  // UUID | Policy identifier (default to null)

            try {
                policy result = apiInstance.getPolicy(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoliciesApi.getPolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoliciesApi();
$id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Policy identifier

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoliciesApi->new();
my $id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; # UUID | Policy identifier

eval {
    my $result = $api_instance->getPolicy(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoliciesApi->getPolicy: $@\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.PoliciesApi()
id = 1e589e76-e9ca-401c-ad8e-0d121a11111e # UUID | Policy identifier (default to null)

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

pub fn main() {
    let id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; // UUID

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

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Policy identifier
Required

Responses


updatePolicy

Update a policy


/policies/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/policies/{id}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoliciesApi;

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

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

        // Create an instance of the API class
        PoliciesApi apiInstance = new PoliciesApi();
        UUID id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Policy identifier
        Policy policy = {"$ref":"#/components/examples/policyRequest"}; // Policy | 

        try {
            apiInstance.updatePolicy(id, policy);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#updatePolicy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Policy identifier
final Policy policy = new Policy(); // Policy | 

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

import org.openapitools.client.api.PoliciesApi;

public class PoliciesApiExample {
    public static void main(String[] args) {
        PoliciesApi apiInstance = new PoliciesApi();
        UUID id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Policy identifier
        Policy policy = {"$ref":"#/components/examples/policyRequest"}; // Policy | 

        try {
            apiInstance.updatePolicy(id, policy);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#updatePolicy");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoliciesApi *apiInstance = [[PoliciesApi alloc] init];
UUID *id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; // Policy identifier (default to null)
Policy *policy = {"$ref":"#/components/examples/policyRequest"}; // 

[apiInstance updatePolicyWith:id
    policy:policy
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.PoliciesApi()
var id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; // {UUID} Policy identifier
var policy = {"$ref":"#/components/examples/policyRequest"}; // {Policy} 

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

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

            // Create an instance of the API class
            var apiInstance = new PoliciesApi();
            var id = 1e589e76-e9ca-401c-ad8e-0d121a11111e;  // UUID | Policy identifier (default to null)
            var policy = new Policy(); // Policy | 

            try {
                apiInstance.updatePolicy(id, policy);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoliciesApi.updatePolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoliciesApi();
$id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Policy identifier
$policy = {"$ref":"#/components/examples/policyRequest"}; // Policy | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoliciesApi->new();
my $id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; # UUID | Policy identifier
my $policy = WWW::OPenAPIClient::Object::Policy->new(); # Policy | 

eval {
    $api_instance->updatePolicy(id => $id, policy => $policy);
};
if ($@) {
    warn "Exception when calling PoliciesApi->updatePolicy: $@\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.PoliciesApi()
id = 1e589e76-e9ca-401c-ad8e-0d121a11111e # UUID | Policy identifier (default to null)
policy = {"$ref":"#/components/examples/policyRequest"} # Policy | 

try:
    api_instance.update_policy(id, policy)
except ApiException as e:
    print("Exception when calling PoliciesApi->updatePolicy: %s\n" % e)
extern crate PoliciesApi;

pub fn main() {
    let id = 1e589e76-e9ca-401c-ad8e-0d121a11111e; // UUID
    let policy = {"$ref":"#/components/examples/policyRequest"}; // Policy

    let mut context = PoliciesApi::Context::default();
    let result = client.updatePolicy(id, policy, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Policy identifier
Required
Body parameters
Name Description
policy *

Responses


RoleCapability

createRoleCapabilities

Create a record associating one or more capabilities with the role


/roles/capabilities

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/roles/capabilities" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoleCapabilityApi;

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

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

        // Create an instance of the API class
        RoleCapabilityApi apiInstance = new RoleCapabilityApi();
        RoleCapabilitiesRequest roleCapabilitiesRequest = {"$ref":"#/components/examples/roleCapabilitiesRequest"}; // RoleCapabilitiesRequest | 

        try {
            roleCapabilities result = apiInstance.createRoleCapabilities(roleCapabilitiesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleCapabilityApi#createRoleCapabilities");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final RoleCapabilitiesRequest roleCapabilitiesRequest = new RoleCapabilitiesRequest(); // RoleCapabilitiesRequest | 

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

import org.openapitools.client.api.RoleCapabilityApi;

public class RoleCapabilityApiExample {
    public static void main(String[] args) {
        RoleCapabilityApi apiInstance = new RoleCapabilityApi();
        RoleCapabilitiesRequest roleCapabilitiesRequest = {"$ref":"#/components/examples/roleCapabilitiesRequest"}; // RoleCapabilitiesRequest | 

        try {
            roleCapabilities result = apiInstance.createRoleCapabilities(roleCapabilitiesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleCapabilityApi#createRoleCapabilities");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoleCapabilityApi *apiInstance = [[RoleCapabilityApi alloc] init];
RoleCapabilitiesRequest *roleCapabilitiesRequest = {"$ref":"#/components/examples/roleCapabilitiesRequest"}; // 

[apiInstance createRoleCapabilitiesWith:roleCapabilitiesRequest
              completionHandler: ^(roleCapabilities output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RoleCapabilityApi()
var roleCapabilitiesRequest = {"$ref":"#/components/examples/roleCapabilitiesRequest"}; // {RoleCapabilitiesRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new RoleCapabilityApi();
            var roleCapabilitiesRequest = new RoleCapabilitiesRequest(); // RoleCapabilitiesRequest | 

            try {
                roleCapabilities result = apiInstance.createRoleCapabilities(roleCapabilitiesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoleCapabilityApi.createRoleCapabilities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoleCapabilityApi();
$roleCapabilitiesRequest = {"$ref":"#/components/examples/roleCapabilitiesRequest"}; // RoleCapabilitiesRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoleCapabilityApi->new();
my $roleCapabilitiesRequest = WWW::OPenAPIClient::Object::RoleCapabilitiesRequest->new(); # RoleCapabilitiesRequest | 

eval {
    my $result = $api_instance->createRoleCapabilities(roleCapabilitiesRequest => $roleCapabilitiesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoleCapabilityApi->createRoleCapabilities: $@\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.RoleCapabilityApi()
roleCapabilitiesRequest = {"$ref":"#/components/examples/roleCapabilitiesRequest"} # RoleCapabilitiesRequest | 

try:
    api_response = api_instance.create_role_capabilities(roleCapabilitiesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleCapabilityApi->createRoleCapabilities: %s\n" % e)
extern crate RoleCapabilityApi;

pub fn main() {
    let roleCapabilitiesRequest = {"$ref":"#/components/examples/roleCapabilitiesRequest"}; // RoleCapabilitiesRequest

    let mut context = RoleCapabilityApi::Context::default();
    let result = client.createRoleCapabilities(roleCapabilitiesRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
roleCapabilitiesRequest *

Responses


deleteRoleCapabilities

Removes all capabilities assignments for the specified role identifier


/roles/{id}/capabilities

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost:8081/roles/{id}/capabilities"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoleCapabilityApi;

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

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

        // Create an instance of the API class
        RoleCapabilityApi apiInstance = new RoleCapabilityApi();
        UUID id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier

        try {
            apiInstance.deleteRoleCapabilities(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleCapabilityApi#deleteRoleCapabilities");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Role identifier

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

import org.openapitools.client.api.RoleCapabilityApi;

public class RoleCapabilityApiExample {
    public static void main(String[] args) {
        RoleCapabilityApi apiInstance = new RoleCapabilityApi();
        UUID id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier

        try {
            apiInstance.deleteRoleCapabilities(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleCapabilityApi#deleteRoleCapabilities");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoleCapabilityApi *apiInstance = [[RoleCapabilityApi alloc] init];
UUID *id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // Role identifier (default to null)

[apiInstance deleteRoleCapabilitiesWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RoleCapabilityApi()
var id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // {UUID} Role identifier

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

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

            // Create an instance of the API class
            var apiInstance = new RoleCapabilityApi();
            var id = 1e985e76-e9ca-401c-ad8e-0d121a11111e;  // UUID | Role identifier (default to null)

            try {
                apiInstance.deleteRoleCapabilities(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoleCapabilityApi.deleteRoleCapabilities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoleCapabilityApi();
$id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoleCapabilityApi->new();
my $id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; # UUID | Role identifier

eval {
    $api_instance->deleteRoleCapabilities(id => $id);
};
if ($@) {
    warn "Exception when calling RoleCapabilityApi->deleteRoleCapabilities: $@\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.RoleCapabilityApi()
id = 1e985e76-e9ca-401c-ad8e-0d121a11111e # UUID | Role identifier (default to null)

try:
    api_instance.delete_role_capabilities(id)
except ApiException as e:
    print("Exception when calling RoleCapabilityApi->deleteRoleCapabilities: %s\n" % e)
extern crate RoleCapabilityApi;

pub fn main() {
    let id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID

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

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Role identifier
Required

Responses


findCapabilitiesByRoleId

Get capabilities assigned to role by role identifier


/roles/{id}/capabilities

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/roles/{id}/capabilities?expand=true&includeDummy=false&limit=20&offset=2"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoleCapabilityApi;

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

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

        // Create an instance of the API class
        RoleCapabilityApi apiInstance = new RoleCapabilityApi();
        UUID id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier
        Boolean expand = true; // Boolean | Defines if capability sets must be expanded
        Boolean includeDummy = false; // Boolean | Include dummy capabilities.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            capabilities result = apiInstance.findCapabilitiesByRoleId(id, expand, includeDummy, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleCapabilityApi#findCapabilitiesByRoleId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Role identifier
final Boolean expand = new Boolean(); // Boolean | Defines if capability sets must be expanded
final Boolean includeDummy = new Boolean(); // Boolean | Include dummy capabilities.
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.

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

import org.openapitools.client.api.RoleCapabilityApi;

public class RoleCapabilityApiExample {
    public static void main(String[] args) {
        RoleCapabilityApi apiInstance = new RoleCapabilityApi();
        UUID id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier
        Boolean expand = true; // Boolean | Defines if capability sets must be expanded
        Boolean includeDummy = false; // Boolean | Include dummy capabilities.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            capabilities result = apiInstance.findCapabilitiesByRoleId(id, expand, includeDummy, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleCapabilityApi#findCapabilitiesByRoleId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoleCapabilityApi *apiInstance = [[RoleCapabilityApi alloc] init];
UUID *id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // Role identifier (default to null)
Boolean *expand = true; // Defines if capability sets must be expanded (optional) (default to false)
Boolean *includeDummy = false; // Include dummy capabilities. (optional) (default to false)
Integer *limit = 20; // Limit the number of elements returned in the response. (optional) (default to 10)
Integer *offset = 2; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

[apiInstance findCapabilitiesByRoleIdWith:id
    expand:expand
    includeDummy:includeDummy
    limit:limit
    offset:offset
              completionHandler: ^(capabilities output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RoleCapabilityApi()
var id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // {UUID} Role identifier
var opts = {
  'expand': true, // {Boolean} Defines if capability sets must be expanded
  'includeDummy': false, // {Boolean} Include dummy capabilities.
  'limit': 20, // {Integer} Limit the number of elements returned in the response.
  'offset': 2 // {Integer} Skip over a number of elements by specifying an offset value for the query.
};

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

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

            // Create an instance of the API class
            var apiInstance = new RoleCapabilityApi();
            var id = 1e985e76-e9ca-401c-ad8e-0d121a11111e;  // UUID | Role identifier (default to null)
            var expand = true;  // Boolean | Defines if capability sets must be expanded (optional)  (default to false)
            var includeDummy = false;  // Boolean | Include dummy capabilities. (optional)  (default to false)
            var limit = 20;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)
            var offset = 2;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)

            try {
                capabilities result = apiInstance.findCapabilitiesByRoleId(id, expand, includeDummy, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoleCapabilityApi.findCapabilitiesByRoleId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoleCapabilityApi();
$id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier
$expand = true; // Boolean | Defines if capability sets must be expanded
$includeDummy = false; // Boolean | Include dummy capabilities.
$limit = 20; // Integer | Limit the number of elements returned in the response.
$offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoleCapabilityApi->new();
my $id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; # UUID | Role identifier
my $expand = true; # Boolean | Defines if capability sets must be expanded
my $includeDummy = false; # Boolean | Include dummy capabilities.
my $limit = 20; # Integer | Limit the number of elements returned in the response.
my $offset = 2; # Integer | Skip over a number of elements by specifying an offset value for the query.

eval {
    my $result = $api_instance->findCapabilitiesByRoleId(id => $id, expand => $expand, includeDummy => $includeDummy, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoleCapabilityApi->findCapabilitiesByRoleId: $@\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.RoleCapabilityApi()
id = 1e985e76-e9ca-401c-ad8e-0d121a11111e # UUID | Role identifier (default to null)
expand = true # Boolean | Defines if capability sets must be expanded (optional) (default to false)
includeDummy = false # Boolean | Include dummy capabilities. (optional) (default to false)
limit = 20 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)
offset = 2 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

try:
    api_response = api_instance.find_capabilities_by_role_id(id, expand=expand, includeDummy=includeDummy, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleCapabilityApi->findCapabilitiesByRoleId: %s\n" % e)
extern crate RoleCapabilityApi;

pub fn main() {
    let id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID
    let expand = true; // Boolean
    let includeDummy = false; // Boolean
    let limit = 20; // Integer
    let offset = 2; // Integer

    let mut context = RoleCapabilityApi::Context::default();
    let result = client.findCapabilitiesByRoleId(id, expand, includeDummy, limit, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Role identifier
Required
Query parameters
Name Description
expand
Boolean
Defines if capability sets must be expanded
includeDummy
Boolean
Include dummy capabilities.
limit
Integer
Limit the number of elements returned in the response.
offset
Integer
Skip over a number of elements by specifying an offset value for the query.

Responses


getRoleCapabilities

Get role-capability relation items by CQL query and pagination parameters


/roles/capabilities

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/roles/capabilities?query=role&limit=20&offset=2"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoleCapabilityApi;

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

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

        // Create an instance of the API class
        RoleCapabilityApi apiInstance = new RoleCapabilityApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            roleCapabilities result = apiInstance.getRoleCapabilities(query, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleCapabilityApi#getRoleCapabilities");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A query string to filter users based on matching criteria in fields.
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.

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

import org.openapitools.client.api.RoleCapabilityApi;

public class RoleCapabilityApiExample {
    public static void main(String[] args) {
        RoleCapabilityApi apiInstance = new RoleCapabilityApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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


// Create an instance of the API class
RoleCapabilityApi *apiInstance = [[RoleCapabilityApi alloc] init];
String *query = role; // A query string to filter users based on matching criteria in fields. (optional) (default to null)
Integer *limit = 20; // Limit the number of elements returned in the response. (optional) (default to 10)
Integer *offset = 2; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

[apiInstance getRoleCapabilitiesWith:query
    limit:limit
    offset:offset
              completionHandler: ^(roleCapabilities output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RoleCapabilityApi()
var opts = {
  'query': role, // {String} A query string to filter users based on matching criteria in fields.
  'limit': 20, // {Integer} Limit the number of elements returned in the response.
  'offset': 2 // {Integer} Skip over a number of elements by specifying an offset value for the query.
};

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

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

            // Create an instance of the API class
            var apiInstance = new RoleCapabilityApi();
            var query = role;  // String | A query string to filter users based on matching criteria in fields. (optional)  (default to null)
            var limit = 20;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)
            var offset = 2;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)

            try {
                roleCapabilities result = apiInstance.getRoleCapabilities(query, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoleCapabilityApi.getRoleCapabilities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoleCapabilityApi();
$query = role; // String | A query string to filter users based on matching criteria in fields.
$limit = 20; // Integer | Limit the number of elements returned in the response.
$offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoleCapabilityApi->new();
my $query = role; # String | A query string to filter users based on matching criteria in fields.
my $limit = 20; # Integer | Limit the number of elements returned in the response.
my $offset = 2; # Integer | Skip over a number of elements by specifying an offset value for the query.

eval {
    my $result = $api_instance->getRoleCapabilities(query => $query, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoleCapabilityApi->getRoleCapabilities: $@\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.RoleCapabilityApi()
query = role # String | A query string to filter users based on matching criteria in fields. (optional) (default to null)
limit = 20 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)
offset = 2 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

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

pub fn main() {
    let query = role; // String
    let limit = 20; // Integer
    let offset = 2; // Integer

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

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

Scopes

Parameters

Query parameters
Name Description
query
String
A query string to filter users based on matching criteria in fields.
limit
Integer
Limit the number of elements returned in the response.
offset
Integer
Skip over a number of elements by specifying an offset value for the query.

Responses


updateRoleCapabilities

Modifies the set of capabilities assigned to the specified role.


/roles/{id}/capabilities

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/roles/{id}/capabilities" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoleCapabilityApi;

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

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

        // Create an instance of the API class
        RoleCapabilityApi apiInstance = new RoleCapabilityApi();
        UUID id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier
        CapabilitiesUpdateRequest capabilitiesUpdateRequest = {"$ref":"#/components/examples/capabilitiesUpdateRequest"}; // CapabilitiesUpdateRequest | 

        try {
            apiInstance.updateRoleCapabilities(id, capabilitiesUpdateRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleCapabilityApi#updateRoleCapabilities");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Role identifier
final CapabilitiesUpdateRequest capabilitiesUpdateRequest = new CapabilitiesUpdateRequest(); // CapabilitiesUpdateRequest | 

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

import org.openapitools.client.api.RoleCapabilityApi;

public class RoleCapabilityApiExample {
    public static void main(String[] args) {
        RoleCapabilityApi apiInstance = new RoleCapabilityApi();
        UUID id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier
        CapabilitiesUpdateRequest capabilitiesUpdateRequest = {"$ref":"#/components/examples/capabilitiesUpdateRequest"}; // CapabilitiesUpdateRequest | 

        try {
            apiInstance.updateRoleCapabilities(id, capabilitiesUpdateRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleCapabilityApi#updateRoleCapabilities");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoleCapabilityApi *apiInstance = [[RoleCapabilityApi alloc] init];
UUID *id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // Role identifier (default to null)
CapabilitiesUpdateRequest *capabilitiesUpdateRequest = {"$ref":"#/components/examples/capabilitiesUpdateRequest"}; // 

[apiInstance updateRoleCapabilitiesWith:id
    capabilitiesUpdateRequest:capabilitiesUpdateRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RoleCapabilityApi()
var id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // {UUID} Role identifier
var capabilitiesUpdateRequest = {"$ref":"#/components/examples/capabilitiesUpdateRequest"}; // {CapabilitiesUpdateRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new RoleCapabilityApi();
            var id = 1e985e76-e9ca-401c-ad8e-0d121a11111e;  // UUID | Role identifier (default to null)
            var capabilitiesUpdateRequest = new CapabilitiesUpdateRequest(); // CapabilitiesUpdateRequest | 

            try {
                apiInstance.updateRoleCapabilities(id, capabilitiesUpdateRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoleCapabilityApi.updateRoleCapabilities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoleCapabilityApi();
$id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier
$capabilitiesUpdateRequest = {"$ref":"#/components/examples/capabilitiesUpdateRequest"}; // CapabilitiesUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoleCapabilityApi->new();
my $id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; # UUID | Role identifier
my $capabilitiesUpdateRequest = WWW::OPenAPIClient::Object::CapabilitiesUpdateRequest->new(); # CapabilitiesUpdateRequest | 

eval {
    $api_instance->updateRoleCapabilities(id => $id, capabilitiesUpdateRequest => $capabilitiesUpdateRequest);
};
if ($@) {
    warn "Exception when calling RoleCapabilityApi->updateRoleCapabilities: $@\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.RoleCapabilityApi()
id = 1e985e76-e9ca-401c-ad8e-0d121a11111e # UUID | Role identifier (default to null)
capabilitiesUpdateRequest = {"$ref":"#/components/examples/capabilitiesUpdateRequest"} # CapabilitiesUpdateRequest | 

try:
    api_instance.update_role_capabilities(id, capabilitiesUpdateRequest)
except ApiException as e:
    print("Exception when calling RoleCapabilityApi->updateRoleCapabilities: %s\n" % e)
extern crate RoleCapabilityApi;

pub fn main() {
    let id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID
    let capabilitiesUpdateRequest = {"$ref":"#/components/examples/capabilitiesUpdateRequest"}; // CapabilitiesUpdateRequest

    let mut context = RoleCapabilityApi::Context::default();
    let result = client.updateRoleCapabilities(id, capabilitiesUpdateRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Role identifier
Required
Body parameters
Name Description
capabilitiesUpdateRequest *

Responses


RoleCapabilitySet

createRoleCapabilitySets

Create a record associating one or more capabilities with the role


/roles/capability-sets

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/roles/capability-sets" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoleCapabilitySetApi;

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

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

        // Create an instance of the API class
        RoleCapabilitySetApi apiInstance = new RoleCapabilitySetApi();
        RoleCapabilitySetsRequest roleCapabilitySetsRequest = {"$ref":"#/components/examples/roleCapabilitySetsRequest"}; // RoleCapabilitySetsRequest | 

        try {
            roleCapabilitySets result = apiInstance.createRoleCapabilitySets(roleCapabilitySetsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleCapabilitySetApi#createRoleCapabilitySets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final RoleCapabilitySetsRequest roleCapabilitySetsRequest = new RoleCapabilitySetsRequest(); // RoleCapabilitySetsRequest | 

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

import org.openapitools.client.api.RoleCapabilitySetApi;

public class RoleCapabilitySetApiExample {
    public static void main(String[] args) {
        RoleCapabilitySetApi apiInstance = new RoleCapabilitySetApi();
        RoleCapabilitySetsRequest roleCapabilitySetsRequest = {"$ref":"#/components/examples/roleCapabilitySetsRequest"}; // RoleCapabilitySetsRequest | 

        try {
            roleCapabilitySets result = apiInstance.createRoleCapabilitySets(roleCapabilitySetsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleCapabilitySetApi#createRoleCapabilitySets");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoleCapabilitySetApi *apiInstance = [[RoleCapabilitySetApi alloc] init];
RoleCapabilitySetsRequest *roleCapabilitySetsRequest = {"$ref":"#/components/examples/roleCapabilitySetsRequest"}; // 

[apiInstance createRoleCapabilitySetsWith:roleCapabilitySetsRequest
              completionHandler: ^(roleCapabilitySets output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RoleCapabilitySetApi()
var roleCapabilitySetsRequest = {"$ref":"#/components/examples/roleCapabilitySetsRequest"}; // {RoleCapabilitySetsRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new RoleCapabilitySetApi();
            var roleCapabilitySetsRequest = new RoleCapabilitySetsRequest(); // RoleCapabilitySetsRequest | 

            try {
                roleCapabilitySets result = apiInstance.createRoleCapabilitySets(roleCapabilitySetsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoleCapabilitySetApi.createRoleCapabilitySets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoleCapabilitySetApi();
$roleCapabilitySetsRequest = {"$ref":"#/components/examples/roleCapabilitySetsRequest"}; // RoleCapabilitySetsRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoleCapabilitySetApi->new();
my $roleCapabilitySetsRequest = WWW::OPenAPIClient::Object::RoleCapabilitySetsRequest->new(); # RoleCapabilitySetsRequest | 

eval {
    my $result = $api_instance->createRoleCapabilitySets(roleCapabilitySetsRequest => $roleCapabilitySetsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoleCapabilitySetApi->createRoleCapabilitySets: $@\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.RoleCapabilitySetApi()
roleCapabilitySetsRequest = {"$ref":"#/components/examples/roleCapabilitySetsRequest"} # RoleCapabilitySetsRequest | 

try:
    api_response = api_instance.create_role_capability_sets(roleCapabilitySetsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleCapabilitySetApi->createRoleCapabilitySets: %s\n" % e)
extern crate RoleCapabilitySetApi;

pub fn main() {
    let roleCapabilitySetsRequest = {"$ref":"#/components/examples/roleCapabilitySetsRequest"}; // RoleCapabilitySetsRequest

    let mut context = RoleCapabilitySetApi::Context::default();
    let result = client.createRoleCapabilitySets(roleCapabilitySetsRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
roleCapabilitySetsRequest *

Responses


deleteRoleCapabilitySets

Removes all capability sets assignments for the specified role identifier


/roles/{id}/capability-sets

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost:8081/roles/{id}/capability-sets"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoleCapabilitySetApi;

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

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

        // Create an instance of the API class
        RoleCapabilitySetApi apiInstance = new RoleCapabilitySetApi();
        UUID id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier

        try {
            apiInstance.deleteRoleCapabilitySets(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleCapabilitySetApi#deleteRoleCapabilitySets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Role identifier

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

import org.openapitools.client.api.RoleCapabilitySetApi;

public class RoleCapabilitySetApiExample {
    public static void main(String[] args) {
        RoleCapabilitySetApi apiInstance = new RoleCapabilitySetApi();
        UUID id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier

        try {
            apiInstance.deleteRoleCapabilitySets(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleCapabilitySetApi#deleteRoleCapabilitySets");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoleCapabilitySetApi *apiInstance = [[RoleCapabilitySetApi alloc] init];
UUID *id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // Role identifier (default to null)

[apiInstance deleteRoleCapabilitySetsWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RoleCapabilitySetApi()
var id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // {UUID} Role identifier

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

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

            // Create an instance of the API class
            var apiInstance = new RoleCapabilitySetApi();
            var id = 1e985e76-e9ca-401c-ad8e-0d121a11111e;  // UUID | Role identifier (default to null)

            try {
                apiInstance.deleteRoleCapabilitySets(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoleCapabilitySetApi.deleteRoleCapabilitySets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoleCapabilitySetApi();
$id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoleCapabilitySetApi->new();
my $id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; # UUID | Role identifier

eval {
    $api_instance->deleteRoleCapabilitySets(id => $id);
};
if ($@) {
    warn "Exception when calling RoleCapabilitySetApi->deleteRoleCapabilitySets: $@\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.RoleCapabilitySetApi()
id = 1e985e76-e9ca-401c-ad8e-0d121a11111e # UUID | Role identifier (default to null)

try:
    api_instance.delete_role_capability_sets(id)
except ApiException as e:
    print("Exception when calling RoleCapabilitySetApi->deleteRoleCapabilitySets: %s\n" % e)
extern crate RoleCapabilitySetApi;

pub fn main() {
    let id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID

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

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Role identifier
Required

Responses


getCapabilitySetsByRoleId

Get capability sets assigned to role by role identifier


/roles/{id}/capability-sets

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/roles/{id}/capability-sets?limit=20&offset=2"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoleCapabilitySetApi;

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

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

        // Create an instance of the API class
        RoleCapabilitySetApi apiInstance = new RoleCapabilitySetApi();
        UUID id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            capabilitySets result = apiInstance.getCapabilitySetsByRoleId(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleCapabilitySetApi#getCapabilitySetsByRoleId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Role identifier
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.

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

import org.openapitools.client.api.RoleCapabilitySetApi;

public class RoleCapabilitySetApiExample {
    public static void main(String[] args) {
        RoleCapabilitySetApi apiInstance = new RoleCapabilitySetApi();
        UUID id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            capabilitySets result = apiInstance.getCapabilitySetsByRoleId(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleCapabilitySetApi#getCapabilitySetsByRoleId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoleCapabilitySetApi *apiInstance = [[RoleCapabilitySetApi alloc] init];
UUID *id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // Role identifier (default to null)
Integer *limit = 20; // Limit the number of elements returned in the response. (optional) (default to 10)
Integer *offset = 2; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

[apiInstance getCapabilitySetsByRoleIdWith:id
    limit:limit
    offset:offset
              completionHandler: ^(capabilitySets output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RoleCapabilitySetApi()
var id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // {UUID} Role identifier
var opts = {
  'limit': 20, // {Integer} Limit the number of elements returned in the response.
  'offset': 2 // {Integer} Skip over a number of elements by specifying an offset value for the query.
};

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

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

            // Create an instance of the API class
            var apiInstance = new RoleCapabilitySetApi();
            var id = 1e985e76-e9ca-401c-ad8e-0d121a11111e;  // UUID | Role identifier (default to null)
            var limit = 20;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)
            var offset = 2;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)

            try {
                capabilitySets result = apiInstance.getCapabilitySetsByRoleId(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoleCapabilitySetApi.getCapabilitySetsByRoleId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoleCapabilitySetApi();
$id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier
$limit = 20; // Integer | Limit the number of elements returned in the response.
$offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoleCapabilitySetApi->new();
my $id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; # UUID | Role identifier
my $limit = 20; # Integer | Limit the number of elements returned in the response.
my $offset = 2; # Integer | Skip over a number of elements by specifying an offset value for the query.

eval {
    my $result = $api_instance->getCapabilitySetsByRoleId(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoleCapabilitySetApi->getCapabilitySetsByRoleId: $@\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.RoleCapabilitySetApi()
id = 1e985e76-e9ca-401c-ad8e-0d121a11111e # UUID | Role identifier (default to null)
limit = 20 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)
offset = 2 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

try:
    api_response = api_instance.get_capability_sets_by_role_id(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleCapabilitySetApi->getCapabilitySetsByRoleId: %s\n" % e)
extern crate RoleCapabilitySetApi;

pub fn main() {
    let id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID
    let limit = 20; // Integer
    let offset = 2; // Integer

    let mut context = RoleCapabilitySetApi::Context::default();
    let result = client.getCapabilitySetsByRoleId(id, limit, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Role identifier
Required
Query parameters
Name Description
limit
Integer
Limit the number of elements returned in the response.
offset
Integer
Skip over a number of elements by specifying an offset value for the query.

Responses


getRoleCapabilitySets

Get role-capability-set relation items by CQL query


/roles/capability-sets

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/roles/capability-sets?query=role&limit=20&offset=2"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoleCapabilitySetApi;

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

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

        // Create an instance of the API class
        RoleCapabilitySetApi apiInstance = new RoleCapabilitySetApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            roleCapabilitySets result = apiInstance.getRoleCapabilitySets(query, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleCapabilitySetApi#getRoleCapabilitySets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A query string to filter users based on matching criteria in fields.
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.

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

import org.openapitools.client.api.RoleCapabilitySetApi;

public class RoleCapabilitySetApiExample {
    public static void main(String[] args) {
        RoleCapabilitySetApi apiInstance = new RoleCapabilitySetApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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


// Create an instance of the API class
RoleCapabilitySetApi *apiInstance = [[RoleCapabilitySetApi alloc] init];
String *query = role; // A query string to filter users based on matching criteria in fields. (optional) (default to null)
Integer *limit = 20; // Limit the number of elements returned in the response. (optional) (default to 10)
Integer *offset = 2; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

[apiInstance getRoleCapabilitySetsWith:query
    limit:limit
    offset:offset
              completionHandler: ^(roleCapabilitySets output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RoleCapabilitySetApi()
var opts = {
  'query': role, // {String} A query string to filter users based on matching criteria in fields.
  'limit': 20, // {Integer} Limit the number of elements returned in the response.
  'offset': 2 // {Integer} Skip over a number of elements by specifying an offset value for the query.
};

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

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

            // Create an instance of the API class
            var apiInstance = new RoleCapabilitySetApi();
            var query = role;  // String | A query string to filter users based on matching criteria in fields. (optional)  (default to null)
            var limit = 20;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)
            var offset = 2;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)

            try {
                roleCapabilitySets result = apiInstance.getRoleCapabilitySets(query, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoleCapabilitySetApi.getRoleCapabilitySets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoleCapabilitySetApi();
$query = role; // String | A query string to filter users based on matching criteria in fields.
$limit = 20; // Integer | Limit the number of elements returned in the response.
$offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoleCapabilitySetApi->new();
my $query = role; # String | A query string to filter users based on matching criteria in fields.
my $limit = 20; # Integer | Limit the number of elements returned in the response.
my $offset = 2; # Integer | Skip over a number of elements by specifying an offset value for the query.

eval {
    my $result = $api_instance->getRoleCapabilitySets(query => $query, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoleCapabilitySetApi->getRoleCapabilitySets: $@\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.RoleCapabilitySetApi()
query = role # String | A query string to filter users based on matching criteria in fields. (optional) (default to null)
limit = 20 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)
offset = 2 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

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

pub fn main() {
    let query = role; // String
    let limit = 20; // Integer
    let offset = 2; // Integer

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

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

Scopes

Parameters

Query parameters
Name Description
query
String
A query string to filter users based on matching criteria in fields.
limit
Integer
Limit the number of elements returned in the response.
offset
Integer
Skip over a number of elements by specifying an offset value for the query.

Responses


updateRoleCapabilitySets

Modifies the set of capability sets assigned to the specified role.


/roles/{id}/capability-sets

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/roles/{id}/capability-sets" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoleCapabilitySetApi;

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

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

        // Create an instance of the API class
        RoleCapabilitySetApi apiInstance = new RoleCapabilitySetApi();
        UUID id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier
        CapabilitySetsUpdateRequest capabilitySetsUpdateRequest = {"$ref":"#/components/examples/capabilitySetsUpdateRequest"}; // CapabilitySetsUpdateRequest | 

        try {
            apiInstance.updateRoleCapabilitySets(id, capabilitySetsUpdateRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleCapabilitySetApi#updateRoleCapabilitySets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Role identifier
final CapabilitySetsUpdateRequest capabilitySetsUpdateRequest = new CapabilitySetsUpdateRequest(); // CapabilitySetsUpdateRequest | 

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

import org.openapitools.client.api.RoleCapabilitySetApi;

public class RoleCapabilitySetApiExample {
    public static void main(String[] args) {
        RoleCapabilitySetApi apiInstance = new RoleCapabilitySetApi();
        UUID id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier
        CapabilitySetsUpdateRequest capabilitySetsUpdateRequest = {"$ref":"#/components/examples/capabilitySetsUpdateRequest"}; // CapabilitySetsUpdateRequest | 

        try {
            apiInstance.updateRoleCapabilitySets(id, capabilitySetsUpdateRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleCapabilitySetApi#updateRoleCapabilitySets");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoleCapabilitySetApi *apiInstance = [[RoleCapabilitySetApi alloc] init];
UUID *id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // Role identifier (default to null)
CapabilitySetsUpdateRequest *capabilitySetsUpdateRequest = {"$ref":"#/components/examples/capabilitySetsUpdateRequest"}; // 

[apiInstance updateRoleCapabilitySetsWith:id
    capabilitySetsUpdateRequest:capabilitySetsUpdateRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RoleCapabilitySetApi()
var id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // {UUID} Role identifier
var capabilitySetsUpdateRequest = {"$ref":"#/components/examples/capabilitySetsUpdateRequest"}; // {CapabilitySetsUpdateRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new RoleCapabilitySetApi();
            var id = 1e985e76-e9ca-401c-ad8e-0d121a11111e;  // UUID | Role identifier (default to null)
            var capabilitySetsUpdateRequest = new CapabilitySetsUpdateRequest(); // CapabilitySetsUpdateRequest | 

            try {
                apiInstance.updateRoleCapabilitySets(id, capabilitySetsUpdateRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoleCapabilitySetApi.updateRoleCapabilitySets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoleCapabilitySetApi();
$id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier
$capabilitySetsUpdateRequest = {"$ref":"#/components/examples/capabilitySetsUpdateRequest"}; // CapabilitySetsUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoleCapabilitySetApi->new();
my $id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; # UUID | Role identifier
my $capabilitySetsUpdateRequest = WWW::OPenAPIClient::Object::CapabilitySetsUpdateRequest->new(); # CapabilitySetsUpdateRequest | 

eval {
    $api_instance->updateRoleCapabilitySets(id => $id, capabilitySetsUpdateRequest => $capabilitySetsUpdateRequest);
};
if ($@) {
    warn "Exception when calling RoleCapabilitySetApi->updateRoleCapabilitySets: $@\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.RoleCapabilitySetApi()
id = 1e985e76-e9ca-401c-ad8e-0d121a11111e # UUID | Role identifier (default to null)
capabilitySetsUpdateRequest = {"$ref":"#/components/examples/capabilitySetsUpdateRequest"} # CapabilitySetsUpdateRequest | 

try:
    api_instance.update_role_capability_sets(id, capabilitySetsUpdateRequest)
except ApiException as e:
    print("Exception when calling RoleCapabilitySetApi->updateRoleCapabilitySets: %s\n" % e)
extern crate RoleCapabilitySetApi;

pub fn main() {
    let id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID
    let capabilitySetsUpdateRequest = {"$ref":"#/components/examples/capabilitySetsUpdateRequest"}; // CapabilitySetsUpdateRequest

    let mut context = RoleCapabilitySetApi::Context::default();
    let result = client.updateRoleCapabilitySets(id, capabilitySetsUpdateRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Role identifier
Required
Body parameters
Name Description
capabilitySetsUpdateRequest *

Responses


Roles

createRole

Create a role


/roles

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/roles" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RolesApi;

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

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

        // Create an instance of the API class
        RolesApi apiInstance = new RolesApi();
        Role role = {"$ref":"#/components/examples/roleRequest"}; // Role | 

        try {
            role result = apiInstance.createRole(role);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#createRole");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Role role = new Role(); // Role | 

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

import org.openapitools.client.api.RolesApi;

public class RolesApiExample {
    public static void main(String[] args) {
        RolesApi apiInstance = new RolesApi();
        Role role = {"$ref":"#/components/examples/roleRequest"}; // Role | 

        try {
            role result = apiInstance.createRole(role);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#createRole");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RolesApi *apiInstance = [[RolesApi alloc] init];
Role *role = {"$ref":"#/components/examples/roleRequest"}; // 

[apiInstance createRoleWith:role
              completionHandler: ^(role output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RolesApi()
var role = {"$ref":"#/components/examples/roleRequest"}; // {Role} 

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

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

            // Create an instance of the API class
            var apiInstance = new RolesApi();
            var role = new Role(); // Role | 

            try {
                role result = apiInstance.createRole(role);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RolesApi.createRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RolesApi();
$role = {"$ref":"#/components/examples/roleRequest"}; // Role | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RolesApi->new();
my $role = WWW::OPenAPIClient::Object::Role->new(); # Role | 

eval {
    my $result = $api_instance->createRole(role => $role);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RolesApi->createRole: $@\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.RolesApi()
role = {"$ref":"#/components/examples/roleRequest"} # Role | 

try:
    api_response = api_instance.create_role(role)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RolesApi->createRole: %s\n" % e)
extern crate RolesApi;

pub fn main() {
    let role = {"$ref":"#/components/examples/roleRequest"}; // Role

    let mut context = RolesApi::Context::default();
    let result = client.createRole(role, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
role *

Responses


createRoles

Create one or more roles


/roles/batch

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/roles/batch" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RolesApi;

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

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

        // Create an instance of the API class
        RolesApi apiInstance = new RolesApi();
        RolesRequest rolesRequest = {"$ref":"#/components/examples/rolesRequest"}; // RolesRequest | 

        try {
            roles result = apiInstance.createRoles(rolesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#createRoles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final RolesRequest rolesRequest = new RolesRequest(); // RolesRequest | 

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

import org.openapitools.client.api.RolesApi;

public class RolesApiExample {
    public static void main(String[] args) {
        RolesApi apiInstance = new RolesApi();
        RolesRequest rolesRequest = {"$ref":"#/components/examples/rolesRequest"}; // RolesRequest | 

        try {
            roles result = apiInstance.createRoles(rolesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#createRoles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RolesApi *apiInstance = [[RolesApi alloc] init];
RolesRequest *rolesRequest = {"$ref":"#/components/examples/rolesRequest"}; // 

[apiInstance createRolesWith:rolesRequest
              completionHandler: ^(roles output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RolesApi()
var rolesRequest = {"$ref":"#/components/examples/rolesRequest"}; // {RolesRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new RolesApi();
            var rolesRequest = new RolesRequest(); // RolesRequest | 

            try {
                roles result = apiInstance.createRoles(rolesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RolesApi.createRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RolesApi();
$rolesRequest = {"$ref":"#/components/examples/rolesRequest"}; // RolesRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RolesApi->new();
my $rolesRequest = WWW::OPenAPIClient::Object::RolesRequest->new(); # RolesRequest | 

eval {
    my $result = $api_instance->createRoles(rolesRequest => $rolesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RolesApi->createRoles: $@\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.RolesApi()
rolesRequest = {"$ref":"#/components/examples/rolesRequest"} # RolesRequest | 

try:
    api_response = api_instance.create_roles(rolesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RolesApi->createRoles: %s\n" % e)
extern crate RolesApi;

pub fn main() {
    let rolesRequest = {"$ref":"#/components/examples/rolesRequest"}; // RolesRequest

    let mut context = RolesApi::Context::default();
    let result = client.createRoles(rolesRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
rolesRequest *

Responses


deleteRole

Delete a role


/roles/{id}

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8081/roles/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RolesApi;

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

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

        // Create an instance of the API class
        RolesApi apiInstance = new RolesApi();
        UUID id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier

        try {
            apiInstance.deleteRole(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#deleteRole");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Role identifier

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

import org.openapitools.client.api.RolesApi;

public class RolesApiExample {
    public static void main(String[] args) {
        RolesApi apiInstance = new RolesApi();
        UUID id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier

        try {
            apiInstance.deleteRole(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#deleteRole");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RolesApi *apiInstance = [[RolesApi alloc] init];
UUID *id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // Role identifier (default to null)

[apiInstance deleteRoleWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RolesApi()
var id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // {UUID} Role identifier

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

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

            // Create an instance of the API class
            var apiInstance = new RolesApi();
            var id = 1e985e76-e9ca-401c-ad8e-0d121a11111e;  // UUID | Role identifier (default to null)

            try {
                apiInstance.deleteRole(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling RolesApi.deleteRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RolesApi();
$id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RolesApi->new();
my $id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; # UUID | Role identifier

eval {
    $api_instance->deleteRole(id => $id);
};
if ($@) {
    warn "Exception when calling RolesApi->deleteRole: $@\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.RolesApi()
id = 1e985e76-e9ca-401c-ad8e-0d121a11111e # UUID | Role identifier (default to null)

try:
    api_instance.delete_role(id)
except ApiException as e:
    print("Exception when calling RolesApi->deleteRole: %s\n" % e)
extern crate RolesApi;

pub fn main() {
    let id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID

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

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Role identifier
Required

Responses


findRoles

Get roles by query


/roles

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/roles?query=role&limit=20&offset=2"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RolesApi;

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

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

        // Create an instance of the API class
        RolesApi apiInstance = new RolesApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            roles result = apiInstance.findRoles(query, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#findRoles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A query string to filter users based on matching criteria in fields.
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.

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

import org.openapitools.client.api.RolesApi;

public class RolesApiExample {
    public static void main(String[] args) {
        RolesApi apiInstance = new RolesApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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


// Create an instance of the API class
RolesApi *apiInstance = [[RolesApi alloc] init];
String *query = role; // A query string to filter users based on matching criteria in fields. (optional) (default to null)
Integer *limit = 20; // Limit the number of elements returned in the response. (optional) (default to 10)
Integer *offset = 2; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

[apiInstance findRolesWith:query
    limit:limit
    offset:offset
              completionHandler: ^(roles output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RolesApi()
var opts = {
  'query': role, // {String} A query string to filter users based on matching criteria in fields.
  'limit': 20, // {Integer} Limit the number of elements returned in the response.
  'offset': 2 // {Integer} Skip over a number of elements by specifying an offset value for the query.
};

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

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

            // Create an instance of the API class
            var apiInstance = new RolesApi();
            var query = role;  // String | A query string to filter users based on matching criteria in fields. (optional)  (default to null)
            var limit = 20;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)
            var offset = 2;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)

            try {
                roles result = apiInstance.findRoles(query, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RolesApi.findRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RolesApi();
$query = role; // String | A query string to filter users based on matching criteria in fields.
$limit = 20; // Integer | Limit the number of elements returned in the response.
$offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RolesApi->new();
my $query = role; # String | A query string to filter users based on matching criteria in fields.
my $limit = 20; # Integer | Limit the number of elements returned in the response.
my $offset = 2; # Integer | Skip over a number of elements by specifying an offset value for the query.

eval {
    my $result = $api_instance->findRoles(query => $query, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RolesApi->findRoles: $@\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.RolesApi()
query = role # String | A query string to filter users based on matching criteria in fields. (optional) (default to null)
limit = 20 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)
offset = 2 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

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

pub fn main() {
    let query = role; // String
    let limit = 20; // Integer
    let offset = 2; // Integer

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

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

Scopes

Parameters

Query parameters
Name Description
query
String
A query string to filter users based on matching criteria in fields.
limit
Integer
Limit the number of elements returned in the response.
offset
Integer
Skip over a number of elements by specifying an offset value for the query.

Responses


getRole

Get role by ID


/roles/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/roles/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RolesApi;

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

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

        // Create an instance of the API class
        RolesApi apiInstance = new RolesApi();
        UUID id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier

        try {
            role result = apiInstance.getRole(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#getRole");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Role identifier

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

import org.openapitools.client.api.RolesApi;

public class RolesApiExample {
    public static void main(String[] args) {
        RolesApi apiInstance = new RolesApi();
        UUID id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier

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


// Create an instance of the API class
RolesApi *apiInstance = [[RolesApi alloc] init];
UUID *id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // Role identifier (default to null)

[apiInstance getRoleWith:id
              completionHandler: ^(role output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RolesApi()
var id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // {UUID} Role identifier

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

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

            // Create an instance of the API class
            var apiInstance = new RolesApi();
            var id = 1e985e76-e9ca-401c-ad8e-0d121a11111e;  // UUID | Role identifier (default to null)

            try {
                role result = apiInstance.getRole(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RolesApi.getRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RolesApi();
$id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RolesApi->new();
my $id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; # UUID | Role identifier

eval {
    my $result = $api_instance->getRole(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RolesApi->getRole: $@\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.RolesApi()
id = 1e985e76-e9ca-401c-ad8e-0d121a11111e # UUID | Role identifier (default to null)

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

pub fn main() {
    let id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID

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

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Role identifier
Required

Responses


updateRole

Update a role


/roles/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/roles/{id}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RolesApi;

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

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

        // Create an instance of the API class
        RolesApi apiInstance = new RolesApi();
        UUID id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier
        Role role = {"$ref":"#/components/examples/roleRequest"}; // Role | 

        try {
            apiInstance.updateRole(id, role);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#updateRole");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | Role identifier
final Role role = new Role(); // Role | 

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

import org.openapitools.client.api.RolesApi;

public class RolesApiExample {
    public static void main(String[] args) {
        RolesApi apiInstance = new RolesApi();
        UUID id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier
        Role role = {"$ref":"#/components/examples/roleRequest"}; // Role | 

        try {
            apiInstance.updateRole(id, role);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#updateRole");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RolesApi *apiInstance = [[RolesApi alloc] init];
UUID *id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // Role identifier (default to null)
Role *role = {"$ref":"#/components/examples/roleRequest"}; // 

[apiInstance updateRoleWith:id
    role:role
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RolesApi()
var id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // {UUID} Role identifier
var role = {"$ref":"#/components/examples/roleRequest"}; // {Role} 

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

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

            // Create an instance of the API class
            var apiInstance = new RolesApi();
            var id = 1e985e76-e9ca-401c-ad8e-0d121a11111e;  // UUID | Role identifier (default to null)
            var role = new Role(); // Role | 

            try {
                apiInstance.updateRole(id, role);
            } catch (Exception e) {
                Debug.Print("Exception when calling RolesApi.updateRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RolesApi();
$id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID | Role identifier
$role = {"$ref":"#/components/examples/roleRequest"}; // Role | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RolesApi->new();
my $id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; # UUID | Role identifier
my $role = WWW::OPenAPIClient::Object::Role->new(); # Role | 

eval {
    $api_instance->updateRole(id => $id, role => $role);
};
if ($@) {
    warn "Exception when calling RolesApi->updateRole: $@\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.RolesApi()
id = 1e985e76-e9ca-401c-ad8e-0d121a11111e # UUID | Role identifier (default to null)
role = {"$ref":"#/components/examples/roleRequest"} # Role | 

try:
    api_instance.update_role(id, role)
except ApiException as e:
    print("Exception when calling RolesApi->updateRole: %s\n" % e)
extern crate RolesApi;

pub fn main() {
    let id = 1e985e76-e9ca-401c-ad8e-0d121a11111e; // UUID
    let role = {"$ref":"#/components/examples/roleRequest"}; // Role

    let mut context = RolesApi::Context::default();
    let result = client.updateRole(id, role, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Role identifier
Required
Body parameters
Name Description
role *

Responses


RolesUsers

assignRolesToUser

Create a record associating role with user


/roles/users

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/roles/users" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RolesUsersApi;

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

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

        // Create an instance of the API class
        RolesUsersApi apiInstance = new RolesUsersApi();
        UserRolesRequest userRolesRequest = {"$ref":"#/components/examples/userRoleRequest"}; // UserRolesRequest | 

        try {
            userRoles result = apiInstance.assignRolesToUser(userRolesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesUsersApi#assignRolesToUser");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UserRolesRequest userRolesRequest = new UserRolesRequest(); // UserRolesRequest | 

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

import org.openapitools.client.api.RolesUsersApi;

public class RolesUsersApiExample {
    public static void main(String[] args) {
        RolesUsersApi apiInstance = new RolesUsersApi();
        UserRolesRequest userRolesRequest = {"$ref":"#/components/examples/userRoleRequest"}; // UserRolesRequest | 

        try {
            userRoles result = apiInstance.assignRolesToUser(userRolesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesUsersApi#assignRolesToUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RolesUsersApi *apiInstance = [[RolesUsersApi alloc] init];
UserRolesRequest *userRolesRequest = {"$ref":"#/components/examples/userRoleRequest"}; // 

[apiInstance assignRolesToUserWith:userRolesRequest
              completionHandler: ^(userRoles output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RolesUsersApi()
var userRolesRequest = {"$ref":"#/components/examples/userRoleRequest"}; // {UserRolesRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new RolesUsersApi();
            var userRolesRequest = new UserRolesRequest(); // UserRolesRequest | 

            try {
                userRoles result = apiInstance.assignRolesToUser(userRolesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RolesUsersApi.assignRolesToUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RolesUsersApi();
$userRolesRequest = {"$ref":"#/components/examples/userRoleRequest"}; // UserRolesRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RolesUsersApi->new();
my $userRolesRequest = WWW::OPenAPIClient::Object::UserRolesRequest->new(); # UserRolesRequest | 

eval {
    my $result = $api_instance->assignRolesToUser(userRolesRequest => $userRolesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RolesUsersApi->assignRolesToUser: $@\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.RolesUsersApi()
userRolesRequest = {"$ref":"#/components/examples/userRoleRequest"} # UserRolesRequest | 

try:
    api_response = api_instance.assign_roles_to_user(userRolesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RolesUsersApi->assignRolesToUser: %s\n" % e)
extern crate RolesUsersApi;

pub fn main() {
    let userRolesRequest = {"$ref":"#/components/examples/userRoleRequest"}; // UserRolesRequest

    let mut context = RolesUsersApi::Context::default();
    let result = client.assignRolesToUser(userRolesRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
userRolesRequest *

Responses


deleteUserRoles

Delete a roles user by user ID


/roles/users/{id}

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8081/roles/users/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RolesUsersApi;

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

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

        // Create an instance of the API class
        RolesUsersApi apiInstance = new RolesUsersApi();
        UUID id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier

        try {
            apiInstance.deleteUserRoles(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesUsersApi#deleteUserRoles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | User identifier

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

import org.openapitools.client.api.RolesUsersApi;

public class RolesUsersApiExample {
    public static void main(String[] args) {
        RolesUsersApi apiInstance = new RolesUsersApi();
        UUID id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier

        try {
            apiInstance.deleteUserRoles(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesUsersApi#deleteUserRoles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RolesUsersApi *apiInstance = [[RolesUsersApi alloc] init];
UUID *id = 1e111e76-1111-401c-ad8e-0d121a11111e; // User identifier (default to null)

[apiInstance deleteUserRolesWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RolesUsersApi()
var id = 1e111e76-1111-401c-ad8e-0d121a11111e; // {UUID} User identifier

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

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

            // Create an instance of the API class
            var apiInstance = new RolesUsersApi();
            var id = 1e111e76-1111-401c-ad8e-0d121a11111e;  // UUID | User identifier (default to null)

            try {
                apiInstance.deleteUserRoles(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling RolesUsersApi.deleteUserRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RolesUsersApi();
$id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RolesUsersApi->new();
my $id = 1e111e76-1111-401c-ad8e-0d121a11111e; # UUID | User identifier

eval {
    $api_instance->deleteUserRoles(id => $id);
};
if ($@) {
    warn "Exception when calling RolesUsersApi->deleteUserRoles: $@\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.RolesUsersApi()
id = 1e111e76-1111-401c-ad8e-0d121a11111e # UUID | User identifier (default to null)

try:
    api_instance.delete_user_roles(id)
except ApiException as e:
    print("Exception when calling RolesUsersApi->deleteUserRoles: %s\n" % e)
extern crate RolesUsersApi;

pub fn main() {
    let id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID

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

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
User identifier
Required

Responses


findUserRoles

Search user-role relations by CQL query


/roles/users

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/roles/users?query=role&limit=20&offset=2"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RolesUsersApi;

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

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

        // Create an instance of the API class
        RolesUsersApi apiInstance = new RolesUsersApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            userRoles result = apiInstance.findUserRoles(query, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesUsersApi#findUserRoles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A query string to filter users based on matching criteria in fields.
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.

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

import org.openapitools.client.api.RolesUsersApi;

public class RolesUsersApiExample {
    public static void main(String[] args) {
        RolesUsersApi apiInstance = new RolesUsersApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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


// Create an instance of the API class
RolesUsersApi *apiInstance = [[RolesUsersApi alloc] init];
String *query = role; // A query string to filter users based on matching criteria in fields. (optional) (default to null)
Integer *limit = 20; // Limit the number of elements returned in the response. (optional) (default to 10)
Integer *offset = 2; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

[apiInstance findUserRolesWith:query
    limit:limit
    offset:offset
              completionHandler: ^(userRoles output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RolesUsersApi()
var opts = {
  'query': role, // {String} A query string to filter users based on matching criteria in fields.
  'limit': 20, // {Integer} Limit the number of elements returned in the response.
  'offset': 2 // {Integer} Skip over a number of elements by specifying an offset value for the query.
};

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

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

            // Create an instance of the API class
            var apiInstance = new RolesUsersApi();
            var query = role;  // String | A query string to filter users based on matching criteria in fields. (optional)  (default to null)
            var limit = 20;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)
            var offset = 2;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)

            try {
                userRoles result = apiInstance.findUserRoles(query, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RolesUsersApi.findUserRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RolesUsersApi();
$query = role; // String | A query string to filter users based on matching criteria in fields.
$limit = 20; // Integer | Limit the number of elements returned in the response.
$offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RolesUsersApi->new();
my $query = role; # String | A query string to filter users based on matching criteria in fields.
my $limit = 20; # Integer | Limit the number of elements returned in the response.
my $offset = 2; # Integer | Skip over a number of elements by specifying an offset value for the query.

eval {
    my $result = $api_instance->findUserRoles(query => $query, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RolesUsersApi->findUserRoles: $@\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.RolesUsersApi()
query = role # String | A query string to filter users based on matching criteria in fields. (optional) (default to null)
limit = 20 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)
offset = 2 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

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

pub fn main() {
    let query = role; // String
    let limit = 20; // Integer
    let offset = 2; // Integer

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

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

Scopes

Parameters

Query parameters
Name Description
query
String
A query string to filter users based on matching criteria in fields.
limit
Integer
Limit the number of elements returned in the response.
offset
Integer
Skip over a number of elements by specifying an offset value for the query.

Responses


getUserRoles

Get roles user by user ID


/roles/users/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/roles/users/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RolesUsersApi;

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

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

        // Create an instance of the API class
        RolesUsersApi apiInstance = new RolesUsersApi();
        UUID id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier

        try {
            userRoles result = apiInstance.getUserRoles(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesUsersApi#getUserRoles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | User identifier

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

import org.openapitools.client.api.RolesUsersApi;

public class RolesUsersApiExample {
    public static void main(String[] args) {
        RolesUsersApi apiInstance = new RolesUsersApi();
        UUID id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier

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


// Create an instance of the API class
RolesUsersApi *apiInstance = [[RolesUsersApi alloc] init];
UUID *id = 1e111e76-1111-401c-ad8e-0d121a11111e; // User identifier (default to null)

[apiInstance getUserRolesWith:id
              completionHandler: ^(userRoles output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RolesUsersApi()
var id = 1e111e76-1111-401c-ad8e-0d121a11111e; // {UUID} User identifier

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

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

            // Create an instance of the API class
            var apiInstance = new RolesUsersApi();
            var id = 1e111e76-1111-401c-ad8e-0d121a11111e;  // UUID | User identifier (default to null)

            try {
                userRoles result = apiInstance.getUserRoles(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RolesUsersApi.getUserRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RolesUsersApi();
$id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RolesUsersApi->new();
my $id = 1e111e76-1111-401c-ad8e-0d121a11111e; # UUID | User identifier

eval {
    my $result = $api_instance->getUserRoles(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RolesUsersApi->getUserRoles: $@\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.RolesUsersApi()
id = 1e111e76-1111-401c-ad8e-0d121a11111e # UUID | User identifier (default to null)

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

pub fn main() {
    let id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID

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

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
User identifier
Required

Responses


updateUserRoles

Update a roles user by user ID


/roles/users/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/roles/users/{id}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RolesUsersApi;

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

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

        // Create an instance of the API class
        RolesUsersApi apiInstance = new RolesUsersApi();
        UUID id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier
        UserRolesRequest userRolesRequest = {"$ref":"#/components/examples/userRolesResponse"}; // UserRolesRequest | 

        try {
            apiInstance.updateUserRoles(id, userRolesRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesUsersApi#updateUserRoles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | User identifier
final UserRolesRequest userRolesRequest = new UserRolesRequest(); // UserRolesRequest | 

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

import org.openapitools.client.api.RolesUsersApi;

public class RolesUsersApiExample {
    public static void main(String[] args) {
        RolesUsersApi apiInstance = new RolesUsersApi();
        UUID id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier
        UserRolesRequest userRolesRequest = {"$ref":"#/components/examples/userRolesResponse"}; // UserRolesRequest | 

        try {
            apiInstance.updateUserRoles(id, userRolesRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesUsersApi#updateUserRoles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RolesUsersApi *apiInstance = [[RolesUsersApi alloc] init];
UUID *id = 1e111e76-1111-401c-ad8e-0d121a11111e; // User identifier (default to null)
UserRolesRequest *userRolesRequest = {"$ref":"#/components/examples/userRolesResponse"}; // 

[apiInstance updateUserRolesWith:id
    userRolesRequest:userRolesRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.RolesUsersApi()
var id = 1e111e76-1111-401c-ad8e-0d121a11111e; // {UUID} User identifier
var userRolesRequest = {"$ref":"#/components/examples/userRolesResponse"}; // {UserRolesRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new RolesUsersApi();
            var id = 1e111e76-1111-401c-ad8e-0d121a11111e;  // UUID | User identifier (default to null)
            var userRolesRequest = new UserRolesRequest(); // UserRolesRequest | 

            try {
                apiInstance.updateUserRoles(id, userRolesRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling RolesUsersApi.updateUserRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RolesUsersApi();
$id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier
$userRolesRequest = {"$ref":"#/components/examples/userRolesResponse"}; // UserRolesRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RolesUsersApi->new();
my $id = 1e111e76-1111-401c-ad8e-0d121a11111e; # UUID | User identifier
my $userRolesRequest = WWW::OPenAPIClient::Object::UserRolesRequest->new(); # UserRolesRequest | 

eval {
    $api_instance->updateUserRoles(id => $id, userRolesRequest => $userRolesRequest);
};
if ($@) {
    warn "Exception when calling RolesUsersApi->updateUserRoles: $@\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.RolesUsersApi()
id = 1e111e76-1111-401c-ad8e-0d121a11111e # UUID | User identifier (default to null)
userRolesRequest = {"$ref":"#/components/examples/userRolesResponse"} # UserRolesRequest | 

try:
    api_instance.update_user_roles(id, userRolesRequest)
except ApiException as e:
    print("Exception when calling RolesUsersApi->updateUserRoles: %s\n" % e)
extern crate RolesUsersApi;

pub fn main() {
    let id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID
    let userRolesRequest = {"$ref":"#/components/examples/userRolesResponse"}; // UserRolesRequest

    let mut context = RolesUsersApi::Context::default();
    let result = client.updateUserRoles(id, userRolesRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
User identifier
Required
Body parameters
Name Description
userRolesRequest *

Responses


UserCapability

createUserCapabilities

Create a record associating one or more capabilities with a user.


/users/capabilities

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/users/capabilities" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserCapabilityApi;

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

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

        // Create an instance of the API class
        UserCapabilityApi apiInstance = new UserCapabilityApi();
        UserCapabilitiesRequest userCapabilitiesRequest = {"$ref":"#/components/examples/userCapabilitiesRequest"}; // UserCapabilitiesRequest | 

        try {
            userCapabilities result = apiInstance.createUserCapabilities(userCapabilitiesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserCapabilityApi#createUserCapabilities");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UserCapabilitiesRequest userCapabilitiesRequest = new UserCapabilitiesRequest(); // UserCapabilitiesRequest | 

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

import org.openapitools.client.api.UserCapabilityApi;

public class UserCapabilityApiExample {
    public static void main(String[] args) {
        UserCapabilityApi apiInstance = new UserCapabilityApi();
        UserCapabilitiesRequest userCapabilitiesRequest = {"$ref":"#/components/examples/userCapabilitiesRequest"}; // UserCapabilitiesRequest | 

        try {
            userCapabilities result = apiInstance.createUserCapabilities(userCapabilitiesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserCapabilityApi#createUserCapabilities");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserCapabilityApi *apiInstance = [[UserCapabilityApi alloc] init];
UserCapabilitiesRequest *userCapabilitiesRequest = {"$ref":"#/components/examples/userCapabilitiesRequest"}; // 

[apiInstance createUserCapabilitiesWith:userCapabilitiesRequest
              completionHandler: ^(userCapabilities output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.UserCapabilityApi()
var userCapabilitiesRequest = {"$ref":"#/components/examples/userCapabilitiesRequest"}; // {UserCapabilitiesRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new UserCapabilityApi();
            var userCapabilitiesRequest = new UserCapabilitiesRequest(); // UserCapabilitiesRequest | 

            try {
                userCapabilities result = apiInstance.createUserCapabilities(userCapabilitiesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserCapabilityApi.createUserCapabilities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserCapabilityApi();
$userCapabilitiesRequest = {"$ref":"#/components/examples/userCapabilitiesRequest"}; // UserCapabilitiesRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserCapabilityApi->new();
my $userCapabilitiesRequest = WWW::OPenAPIClient::Object::UserCapabilitiesRequest->new(); # UserCapabilitiesRequest | 

eval {
    my $result = $api_instance->createUserCapabilities(userCapabilitiesRequest => $userCapabilitiesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserCapabilityApi->createUserCapabilities: $@\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.UserCapabilityApi()
userCapabilitiesRequest = {"$ref":"#/components/examples/userCapabilitiesRequest"} # UserCapabilitiesRequest | 

try:
    api_response = api_instance.create_user_capabilities(userCapabilitiesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserCapabilityApi->createUserCapabilities: %s\n" % e)
extern crate UserCapabilityApi;

pub fn main() {
    let userCapabilitiesRequest = {"$ref":"#/components/examples/userCapabilitiesRequest"}; // UserCapabilitiesRequest

    let mut context = UserCapabilityApi::Context::default();
    let result = client.createUserCapabilities(userCapabilitiesRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
userCapabilitiesRequest *

Responses


deleteUserCapabilities

Removes all capability assignments for the specified user identifier


/users/{id}/capabilities

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost:8081/users/{id}/capabilities"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserCapabilityApi;

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

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

        // Create an instance of the API class
        UserCapabilityApi apiInstance = new UserCapabilityApi();
        UUID id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier

        try {
            apiInstance.deleteUserCapabilities(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserCapabilityApi#deleteUserCapabilities");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | User identifier

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

import org.openapitools.client.api.UserCapabilityApi;

public class UserCapabilityApiExample {
    public static void main(String[] args) {
        UserCapabilityApi apiInstance = new UserCapabilityApi();
        UUID id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier

        try {
            apiInstance.deleteUserCapabilities(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserCapabilityApi#deleteUserCapabilities");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserCapabilityApi *apiInstance = [[UserCapabilityApi alloc] init];
UUID *id = 1e111e76-1111-401c-ad8e-0d121a11111e; // User identifier (default to null)

[apiInstance deleteUserCapabilitiesWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.UserCapabilityApi()
var id = 1e111e76-1111-401c-ad8e-0d121a11111e; // {UUID} User identifier

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

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

            // Create an instance of the API class
            var apiInstance = new UserCapabilityApi();
            var id = 1e111e76-1111-401c-ad8e-0d121a11111e;  // UUID | User identifier (default to null)

            try {
                apiInstance.deleteUserCapabilities(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserCapabilityApi.deleteUserCapabilities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserCapabilityApi();
$id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserCapabilityApi->new();
my $id = 1e111e76-1111-401c-ad8e-0d121a11111e; # UUID | User identifier

eval {
    $api_instance->deleteUserCapabilities(id => $id);
};
if ($@) {
    warn "Exception when calling UserCapabilityApi->deleteUserCapabilities: $@\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.UserCapabilityApi()
id = 1e111e76-1111-401c-ad8e-0d121a11111e # UUID | User identifier (default to null)

try:
    api_instance.delete_user_capabilities(id)
except ApiException as e:
    print("Exception when calling UserCapabilityApi->deleteUserCapabilities: %s\n" % e)
extern crate UserCapabilityApi;

pub fn main() {
    let id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID

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

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
User identifier
Required

Responses


findCapabilitiesByUserId

Retrieve capabilities assigned to role by role identifier


/users/{id}/capabilities

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/users/{id}/capabilities?expand=true&includeDummy=false&limit=20&offset=2"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserCapabilityApi;

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

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

        // Create an instance of the API class
        UserCapabilityApi apiInstance = new UserCapabilityApi();
        UUID id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier
        Boolean expand = true; // Boolean | Defines if capability sets must be expanded
        Boolean includeDummy = false; // Boolean | Include dummy capabilities.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            capabilities result = apiInstance.findCapabilitiesByUserId(id, expand, includeDummy, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserCapabilityApi#findCapabilitiesByUserId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | User identifier
final Boolean expand = new Boolean(); // Boolean | Defines if capability sets must be expanded
final Boolean includeDummy = new Boolean(); // Boolean | Include dummy capabilities.
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.

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

import org.openapitools.client.api.UserCapabilityApi;

public class UserCapabilityApiExample {
    public static void main(String[] args) {
        UserCapabilityApi apiInstance = new UserCapabilityApi();
        UUID id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier
        Boolean expand = true; // Boolean | Defines if capability sets must be expanded
        Boolean includeDummy = false; // Boolean | Include dummy capabilities.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            capabilities result = apiInstance.findCapabilitiesByUserId(id, expand, includeDummy, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserCapabilityApi#findCapabilitiesByUserId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserCapabilityApi *apiInstance = [[UserCapabilityApi alloc] init];
UUID *id = 1e111e76-1111-401c-ad8e-0d121a11111e; // User identifier (default to null)
Boolean *expand = true; // Defines if capability sets must be expanded (optional) (default to false)
Boolean *includeDummy = false; // Include dummy capabilities. (optional) (default to false)
Integer *limit = 20; // Limit the number of elements returned in the response. (optional) (default to 10)
Integer *offset = 2; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

[apiInstance findCapabilitiesByUserIdWith:id
    expand:expand
    includeDummy:includeDummy
    limit:limit
    offset:offset
              completionHandler: ^(capabilities output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.UserCapabilityApi()
var id = 1e111e76-1111-401c-ad8e-0d121a11111e; // {UUID} User identifier
var opts = {
  'expand': true, // {Boolean} Defines if capability sets must be expanded
  'includeDummy': false, // {Boolean} Include dummy capabilities.
  'limit': 20, // {Integer} Limit the number of elements returned in the response.
  'offset': 2 // {Integer} Skip over a number of elements by specifying an offset value for the query.
};

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

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

            // Create an instance of the API class
            var apiInstance = new UserCapabilityApi();
            var id = 1e111e76-1111-401c-ad8e-0d121a11111e;  // UUID | User identifier (default to null)
            var expand = true;  // Boolean | Defines if capability sets must be expanded (optional)  (default to false)
            var includeDummy = false;  // Boolean | Include dummy capabilities. (optional)  (default to false)
            var limit = 20;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)
            var offset = 2;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)

            try {
                capabilities result = apiInstance.findCapabilitiesByUserId(id, expand, includeDummy, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserCapabilityApi.findCapabilitiesByUserId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserCapabilityApi();
$id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier
$expand = true; // Boolean | Defines if capability sets must be expanded
$includeDummy = false; // Boolean | Include dummy capabilities.
$limit = 20; // Integer | Limit the number of elements returned in the response.
$offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserCapabilityApi->new();
my $id = 1e111e76-1111-401c-ad8e-0d121a11111e; # UUID | User identifier
my $expand = true; # Boolean | Defines if capability sets must be expanded
my $includeDummy = false; # Boolean | Include dummy capabilities.
my $limit = 20; # Integer | Limit the number of elements returned in the response.
my $offset = 2; # Integer | Skip over a number of elements by specifying an offset value for the query.

eval {
    my $result = $api_instance->findCapabilitiesByUserId(id => $id, expand => $expand, includeDummy => $includeDummy, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserCapabilityApi->findCapabilitiesByUserId: $@\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.UserCapabilityApi()
id = 1e111e76-1111-401c-ad8e-0d121a11111e # UUID | User identifier (default to null)
expand = true # Boolean | Defines if capability sets must be expanded (optional) (default to false)
includeDummy = false # Boolean | Include dummy capabilities. (optional) (default to false)
limit = 20 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)
offset = 2 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

try:
    api_response = api_instance.find_capabilities_by_user_id(id, expand=expand, includeDummy=includeDummy, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserCapabilityApi->findCapabilitiesByUserId: %s\n" % e)
extern crate UserCapabilityApi;

pub fn main() {
    let id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID
    let expand = true; // Boolean
    let includeDummy = false; // Boolean
    let limit = 20; // Integer
    let offset = 2; // Integer

    let mut context = UserCapabilityApi::Context::default();
    let result = client.findCapabilitiesByUserId(id, expand, includeDummy, limit, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
User identifier
Required
Query parameters
Name Description
expand
Boolean
Defines if capability sets must be expanded
includeDummy
Boolean
Include dummy capabilities.
limit
Integer
Limit the number of elements returned in the response.
offset
Integer
Skip over a number of elements by specifying an offset value for the query.

Responses


getUserCapabilities

Search user capabilities by CQL query


/users/capabilities

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/users/capabilities?query=role&limit=20&offset=2"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserCapabilityApi;

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

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

        // Create an instance of the API class
        UserCapabilityApi apiInstance = new UserCapabilityApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            userCapabilities result = apiInstance.getUserCapabilities(query, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserCapabilityApi#getUserCapabilities");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A query string to filter users based on matching criteria in fields.
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.

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

import org.openapitools.client.api.UserCapabilityApi;

public class UserCapabilityApiExample {
    public static void main(String[] args) {
        UserCapabilityApi apiInstance = new UserCapabilityApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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


// Create an instance of the API class
UserCapabilityApi *apiInstance = [[UserCapabilityApi alloc] init];
String *query = role; // A query string to filter users based on matching criteria in fields. (optional) (default to null)
Integer *limit = 20; // Limit the number of elements returned in the response. (optional) (default to 10)
Integer *offset = 2; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

[apiInstance getUserCapabilitiesWith:query
    limit:limit
    offset:offset
              completionHandler: ^(userCapabilities output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.UserCapabilityApi()
var opts = {
  'query': role, // {String} A query string to filter users based on matching criteria in fields.
  'limit': 20, // {Integer} Limit the number of elements returned in the response.
  'offset': 2 // {Integer} Skip over a number of elements by specifying an offset value for the query.
};

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

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

            // Create an instance of the API class
            var apiInstance = new UserCapabilityApi();
            var query = role;  // String | A query string to filter users based on matching criteria in fields. (optional)  (default to null)
            var limit = 20;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)
            var offset = 2;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)

            try {
                userCapabilities result = apiInstance.getUserCapabilities(query, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserCapabilityApi.getUserCapabilities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserCapabilityApi();
$query = role; // String | A query string to filter users based on matching criteria in fields.
$limit = 20; // Integer | Limit the number of elements returned in the response.
$offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserCapabilityApi->new();
my $query = role; # String | A query string to filter users based on matching criteria in fields.
my $limit = 20; # Integer | Limit the number of elements returned in the response.
my $offset = 2; # Integer | Skip over a number of elements by specifying an offset value for the query.

eval {
    my $result = $api_instance->getUserCapabilities(query => $query, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserCapabilityApi->getUserCapabilities: $@\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.UserCapabilityApi()
query = role # String | A query string to filter users based on matching criteria in fields. (optional) (default to null)
limit = 20 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)
offset = 2 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

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

pub fn main() {
    let query = role; // String
    let limit = 20; // Integer
    let offset = 2; // Integer

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

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

Scopes

Parameters

Query parameters
Name Description
query
String
A query string to filter users based on matching criteria in fields.
limit
Integer
Limit the number of elements returned in the response.
offset
Integer
Skip over a number of elements by specifying an offset value for the query.

Responses


updateUserCapabilities

Modifies the set of capabilities assigned to the specified user.


/users/{id}/capabilities

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/users/{id}/capabilities" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserCapabilityApi;

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

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

        // Create an instance of the API class
        UserCapabilityApi apiInstance = new UserCapabilityApi();
        UUID id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier
        CapabilitiesUpdateRequest capabilitiesUpdateRequest = {"$ref":"#/components/examples/capabilitiesUpdateRequest"}; // CapabilitiesUpdateRequest | 

        try {
            apiInstance.updateUserCapabilities(id, capabilitiesUpdateRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserCapabilityApi#updateUserCapabilities");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | User identifier
final CapabilitiesUpdateRequest capabilitiesUpdateRequest = new CapabilitiesUpdateRequest(); // CapabilitiesUpdateRequest | 

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

import org.openapitools.client.api.UserCapabilityApi;

public class UserCapabilityApiExample {
    public static void main(String[] args) {
        UserCapabilityApi apiInstance = new UserCapabilityApi();
        UUID id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier
        CapabilitiesUpdateRequest capabilitiesUpdateRequest = {"$ref":"#/components/examples/capabilitiesUpdateRequest"}; // CapabilitiesUpdateRequest | 

        try {
            apiInstance.updateUserCapabilities(id, capabilitiesUpdateRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserCapabilityApi#updateUserCapabilities");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserCapabilityApi *apiInstance = [[UserCapabilityApi alloc] init];
UUID *id = 1e111e76-1111-401c-ad8e-0d121a11111e; // User identifier (default to null)
CapabilitiesUpdateRequest *capabilitiesUpdateRequest = {"$ref":"#/components/examples/capabilitiesUpdateRequest"}; // 

[apiInstance updateUserCapabilitiesWith:id
    capabilitiesUpdateRequest:capabilitiesUpdateRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.UserCapabilityApi()
var id = 1e111e76-1111-401c-ad8e-0d121a11111e; // {UUID} User identifier
var capabilitiesUpdateRequest = {"$ref":"#/components/examples/capabilitiesUpdateRequest"}; // {CapabilitiesUpdateRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new UserCapabilityApi();
            var id = 1e111e76-1111-401c-ad8e-0d121a11111e;  // UUID | User identifier (default to null)
            var capabilitiesUpdateRequest = new CapabilitiesUpdateRequest(); // CapabilitiesUpdateRequest | 

            try {
                apiInstance.updateUserCapabilities(id, capabilitiesUpdateRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserCapabilityApi.updateUserCapabilities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserCapabilityApi();
$id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier
$capabilitiesUpdateRequest = {"$ref":"#/components/examples/capabilitiesUpdateRequest"}; // CapabilitiesUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserCapabilityApi->new();
my $id = 1e111e76-1111-401c-ad8e-0d121a11111e; # UUID | User identifier
my $capabilitiesUpdateRequest = WWW::OPenAPIClient::Object::CapabilitiesUpdateRequest->new(); # CapabilitiesUpdateRequest | 

eval {
    $api_instance->updateUserCapabilities(id => $id, capabilitiesUpdateRequest => $capabilitiesUpdateRequest);
};
if ($@) {
    warn "Exception when calling UserCapabilityApi->updateUserCapabilities: $@\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.UserCapabilityApi()
id = 1e111e76-1111-401c-ad8e-0d121a11111e # UUID | User identifier (default to null)
capabilitiesUpdateRequest = {"$ref":"#/components/examples/capabilitiesUpdateRequest"} # CapabilitiesUpdateRequest | 

try:
    api_instance.update_user_capabilities(id, capabilitiesUpdateRequest)
except ApiException as e:
    print("Exception when calling UserCapabilityApi->updateUserCapabilities: %s\n" % e)
extern crate UserCapabilityApi;

pub fn main() {
    let id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID
    let capabilitiesUpdateRequest = {"$ref":"#/components/examples/capabilitiesUpdateRequest"}; // CapabilitiesUpdateRequest

    let mut context = UserCapabilityApi::Context::default();
    let result = client.updateUserCapabilities(id, capabilitiesUpdateRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
User identifier
Required
Body parameters
Name Description
capabilitiesUpdateRequest *

Responses


UserCapabilitySet

createUserCapabilitySets

Create a record associating one or more capabilities with a user.


/users/capability-sets

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/users/capability-sets" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserCapabilitySetApi;

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

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

        // Create an instance of the API class
        UserCapabilitySetApi apiInstance = new UserCapabilitySetApi();
        UserCapabilitySetsRequest userCapabilitySetsRequest = {"$ref":"#/components/examples/userCapabilitySetsRequest"}; // UserCapabilitySetsRequest | 

        try {
            userCapabilitySets result = apiInstance.createUserCapabilitySets(userCapabilitySetsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserCapabilitySetApi#createUserCapabilitySets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UserCapabilitySetsRequest userCapabilitySetsRequest = new UserCapabilitySetsRequest(); // UserCapabilitySetsRequest | 

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

import org.openapitools.client.api.UserCapabilitySetApi;

public class UserCapabilitySetApiExample {
    public static void main(String[] args) {
        UserCapabilitySetApi apiInstance = new UserCapabilitySetApi();
        UserCapabilitySetsRequest userCapabilitySetsRequest = {"$ref":"#/components/examples/userCapabilitySetsRequest"}; // UserCapabilitySetsRequest | 

        try {
            userCapabilitySets result = apiInstance.createUserCapabilitySets(userCapabilitySetsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserCapabilitySetApi#createUserCapabilitySets");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserCapabilitySetApi *apiInstance = [[UserCapabilitySetApi alloc] init];
UserCapabilitySetsRequest *userCapabilitySetsRequest = {"$ref":"#/components/examples/userCapabilitySetsRequest"}; // 

[apiInstance createUserCapabilitySetsWith:userCapabilitySetsRequest
              completionHandler: ^(userCapabilitySets output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.UserCapabilitySetApi()
var userCapabilitySetsRequest = {"$ref":"#/components/examples/userCapabilitySetsRequest"}; // {UserCapabilitySetsRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new UserCapabilitySetApi();
            var userCapabilitySetsRequest = new UserCapabilitySetsRequest(); // UserCapabilitySetsRequest | 

            try {
                userCapabilitySets result = apiInstance.createUserCapabilitySets(userCapabilitySetsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserCapabilitySetApi.createUserCapabilitySets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserCapabilitySetApi();
$userCapabilitySetsRequest = {"$ref":"#/components/examples/userCapabilitySetsRequest"}; // UserCapabilitySetsRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserCapabilitySetApi->new();
my $userCapabilitySetsRequest = WWW::OPenAPIClient::Object::UserCapabilitySetsRequest->new(); # UserCapabilitySetsRequest | 

eval {
    my $result = $api_instance->createUserCapabilitySets(userCapabilitySetsRequest => $userCapabilitySetsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserCapabilitySetApi->createUserCapabilitySets: $@\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.UserCapabilitySetApi()
userCapabilitySetsRequest = {"$ref":"#/components/examples/userCapabilitySetsRequest"} # UserCapabilitySetsRequest | 

try:
    api_response = api_instance.create_user_capability_sets(userCapabilitySetsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserCapabilitySetApi->createUserCapabilitySets: %s\n" % e)
extern crate UserCapabilitySetApi;

pub fn main() {
    let userCapabilitySetsRequest = {"$ref":"#/components/examples/userCapabilitySetsRequest"}; // UserCapabilitySetsRequest

    let mut context = UserCapabilitySetApi::Context::default();
    let result = client.createUserCapabilitySets(userCapabilitySetsRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
userCapabilitySetsRequest *

Responses


deleteUserCapabilitySets

Removes all capability set assignments for the specified user identifier


/users/{id}/capability-sets

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost:8081/users/{id}/capability-sets"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserCapabilitySetApi;

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

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

        // Create an instance of the API class
        UserCapabilitySetApi apiInstance = new UserCapabilitySetApi();
        UUID id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier

        try {
            apiInstance.deleteUserCapabilitySets(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserCapabilitySetApi#deleteUserCapabilitySets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | User identifier

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

import org.openapitools.client.api.UserCapabilitySetApi;

public class UserCapabilitySetApiExample {
    public static void main(String[] args) {
        UserCapabilitySetApi apiInstance = new UserCapabilitySetApi();
        UUID id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier

        try {
            apiInstance.deleteUserCapabilitySets(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserCapabilitySetApi#deleteUserCapabilitySets");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserCapabilitySetApi *apiInstance = [[UserCapabilitySetApi alloc] init];
UUID *id = 1e111e76-1111-401c-ad8e-0d121a11111e; // User identifier (default to null)

[apiInstance deleteUserCapabilitySetsWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.UserCapabilitySetApi()
var id = 1e111e76-1111-401c-ad8e-0d121a11111e; // {UUID} User identifier

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

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

            // Create an instance of the API class
            var apiInstance = new UserCapabilitySetApi();
            var id = 1e111e76-1111-401c-ad8e-0d121a11111e;  // UUID | User identifier (default to null)

            try {
                apiInstance.deleteUserCapabilitySets(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserCapabilitySetApi.deleteUserCapabilitySets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserCapabilitySetApi();
$id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserCapabilitySetApi->new();
my $id = 1e111e76-1111-401c-ad8e-0d121a11111e; # UUID | User identifier

eval {
    $api_instance->deleteUserCapabilitySets(id => $id);
};
if ($@) {
    warn "Exception when calling UserCapabilitySetApi->deleteUserCapabilitySets: $@\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.UserCapabilitySetApi()
id = 1e111e76-1111-401c-ad8e-0d121a11111e # UUID | User identifier (default to null)

try:
    api_instance.delete_user_capability_sets(id)
except ApiException as e:
    print("Exception when calling UserCapabilitySetApi->deleteUserCapabilitySets: %s\n" % e)
extern crate UserCapabilitySetApi;

pub fn main() {
    let id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID

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

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
User identifier
Required

Responses


getCapabilitySetsByUserId

Retrieve capability sets assigned to role by role identifier


/users/{id}/capability-sets

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/users/{id}/capability-sets?limit=20&offset=2"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserCapabilitySetApi;

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

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

        // Create an instance of the API class
        UserCapabilitySetApi apiInstance = new UserCapabilitySetApi();
        UUID id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            capabilitySets result = apiInstance.getCapabilitySetsByUserId(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserCapabilitySetApi#getCapabilitySetsByUserId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | User identifier
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.

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

import org.openapitools.client.api.UserCapabilitySetApi;

public class UserCapabilitySetApiExample {
    public static void main(String[] args) {
        UserCapabilitySetApi apiInstance = new UserCapabilitySetApi();
        UUID id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            capabilitySets result = apiInstance.getCapabilitySetsByUserId(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserCapabilitySetApi#getCapabilitySetsByUserId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserCapabilitySetApi *apiInstance = [[UserCapabilitySetApi alloc] init];
UUID *id = 1e111e76-1111-401c-ad8e-0d121a11111e; // User identifier (default to null)
Integer *limit = 20; // Limit the number of elements returned in the response. (optional) (default to 10)
Integer *offset = 2; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

[apiInstance getCapabilitySetsByUserIdWith:id
    limit:limit
    offset:offset
              completionHandler: ^(capabilitySets output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.UserCapabilitySetApi()
var id = 1e111e76-1111-401c-ad8e-0d121a11111e; // {UUID} User identifier
var opts = {
  'limit': 20, // {Integer} Limit the number of elements returned in the response.
  'offset': 2 // {Integer} Skip over a number of elements by specifying an offset value for the query.
};

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

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

            // Create an instance of the API class
            var apiInstance = new UserCapabilitySetApi();
            var id = 1e111e76-1111-401c-ad8e-0d121a11111e;  // UUID | User identifier (default to null)
            var limit = 20;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)
            var offset = 2;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)

            try {
                capabilitySets result = apiInstance.getCapabilitySetsByUserId(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserCapabilitySetApi.getCapabilitySetsByUserId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserCapabilitySetApi();
$id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier
$limit = 20; // Integer | Limit the number of elements returned in the response.
$offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserCapabilitySetApi->new();
my $id = 1e111e76-1111-401c-ad8e-0d121a11111e; # UUID | User identifier
my $limit = 20; # Integer | Limit the number of elements returned in the response.
my $offset = 2; # Integer | Skip over a number of elements by specifying an offset value for the query.

eval {
    my $result = $api_instance->getCapabilitySetsByUserId(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserCapabilitySetApi->getCapabilitySetsByUserId: $@\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.UserCapabilitySetApi()
id = 1e111e76-1111-401c-ad8e-0d121a11111e # UUID | User identifier (default to null)
limit = 20 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)
offset = 2 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

try:
    api_response = api_instance.get_capability_sets_by_user_id(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserCapabilitySetApi->getCapabilitySetsByUserId: %s\n" % e)
extern crate UserCapabilitySetApi;

pub fn main() {
    let id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID
    let limit = 20; // Integer
    let offset = 2; // Integer

    let mut context = UserCapabilitySetApi::Context::default();
    let result = client.getCapabilitySetsByUserId(id, limit, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
User identifier
Required
Query parameters
Name Description
limit
Integer
Limit the number of elements returned in the response.
offset
Integer
Skip over a number of elements by specifying an offset value for the query.

Responses


getUserCapabilitySets

Get user capabilities by CQL query and pagination parameters


/users/capability-sets

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8081/users/capability-sets?query=role&limit=20&offset=2"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserCapabilitySetApi;

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

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

        // Create an instance of the API class
        UserCapabilitySetApi apiInstance = new UserCapabilitySetApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

        try {
            userCapabilitySets result = apiInstance.getUserCapabilitySets(query, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserCapabilitySetApi#getUserCapabilitySets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String query = new String(); // String | A query string to filter users based on matching criteria in fields.
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.

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

import org.openapitools.client.api.UserCapabilitySetApi;

public class UserCapabilitySetApiExample {
    public static void main(String[] args) {
        UserCapabilitySetApi apiInstance = new UserCapabilitySetApi();
        String query = role; // String | A query string to filter users based on matching criteria in fields.
        Integer limit = 20; // Integer | Limit the number of elements returned in the response.
        Integer offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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


// Create an instance of the API class
UserCapabilitySetApi *apiInstance = [[UserCapabilitySetApi alloc] init];
String *query = role; // A query string to filter users based on matching criteria in fields. (optional) (default to null)
Integer *limit = 20; // Limit the number of elements returned in the response. (optional) (default to 10)
Integer *offset = 2; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

[apiInstance getUserCapabilitySetsWith:query
    limit:limit
    offset:offset
              completionHandler: ^(userCapabilitySets output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.UserCapabilitySetApi()
var opts = {
  'query': role, // {String} A query string to filter users based on matching criteria in fields.
  'limit': 20, // {Integer} Limit the number of elements returned in the response.
  'offset': 2 // {Integer} Skip over a number of elements by specifying an offset value for the query.
};

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

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

            // Create an instance of the API class
            var apiInstance = new UserCapabilitySetApi();
            var query = role;  // String | A query string to filter users based on matching criteria in fields. (optional)  (default to null)
            var limit = 20;  // Integer | Limit the number of elements returned in the response. (optional)  (default to 10)
            var offset = 2;  // Integer | Skip over a number of elements by specifying an offset value for the query. (optional)  (default to 0)

            try {
                userCapabilitySets result = apiInstance.getUserCapabilitySets(query, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserCapabilitySetApi.getUserCapabilitySets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserCapabilitySetApi();
$query = role; // String | A query string to filter users based on matching criteria in fields.
$limit = 20; // Integer | Limit the number of elements returned in the response.
$offset = 2; // Integer | Skip over a number of elements by specifying an offset value for the query.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserCapabilitySetApi->new();
my $query = role; # String | A query string to filter users based on matching criteria in fields.
my $limit = 20; # Integer | Limit the number of elements returned in the response.
my $offset = 2; # Integer | Skip over a number of elements by specifying an offset value for the query.

eval {
    my $result = $api_instance->getUserCapabilitySets(query => $query, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserCapabilitySetApi->getUserCapabilitySets: $@\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.UserCapabilitySetApi()
query = role # String | A query string to filter users based on matching criteria in fields. (optional) (default to null)
limit = 20 # Integer | Limit the number of elements returned in the response. (optional) (default to 10)
offset = 2 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)

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

pub fn main() {
    let query = role; // String
    let limit = 20; // Integer
    let offset = 2; // Integer

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

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

Scopes

Parameters

Query parameters
Name Description
query
String
A query string to filter users based on matching criteria in fields.
limit
Integer
Limit the number of elements returned in the response.
offset
Integer
Skip over a number of elements by specifying an offset value for the query.

Responses


updateUserCapabilitySets

Modifies the set of capability sets assigned to the specified user.


/users/{id}/capability-sets

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8081/users/{id}/capability-sets" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserCapabilitySetApi;

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

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

        // Create an instance of the API class
        UserCapabilitySetApi apiInstance = new UserCapabilitySetApi();
        UUID id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier
        CapabilitySetsUpdateRequest capabilitySetsUpdateRequest = {"$ref":"#/components/examples/capabilitySetsUpdateRequest"}; // CapabilitySetsUpdateRequest | 

        try {
            apiInstance.updateUserCapabilitySets(id, capabilitySetsUpdateRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserCapabilitySetApi#updateUserCapabilitySets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID id = new UUID(); // UUID | User identifier
final CapabilitySetsUpdateRequest capabilitySetsUpdateRequest = new CapabilitySetsUpdateRequest(); // CapabilitySetsUpdateRequest | 

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

import org.openapitools.client.api.UserCapabilitySetApi;

public class UserCapabilitySetApiExample {
    public static void main(String[] args) {
        UserCapabilitySetApi apiInstance = new UserCapabilitySetApi();
        UUID id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier
        CapabilitySetsUpdateRequest capabilitySetsUpdateRequest = {"$ref":"#/components/examples/capabilitySetsUpdateRequest"}; // CapabilitySetsUpdateRequest | 

        try {
            apiInstance.updateUserCapabilitySets(id, capabilitySetsUpdateRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserCapabilitySetApi#updateUserCapabilitySets");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserCapabilitySetApi *apiInstance = [[UserCapabilitySetApi alloc] init];
UUID *id = 1e111e76-1111-401c-ad8e-0d121a11111e; // User identifier (default to null)
CapabilitySetsUpdateRequest *capabilitySetsUpdateRequest = {"$ref":"#/components/examples/capabilitySetsUpdateRequest"}; // 

[apiInstance updateUserCapabilitySetsWith:id
    capabilitySetsUpdateRequest:capabilitySetsUpdateRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ModRolesKeycloakApi = require('mod_roles_keycloak_api');

// Create an instance of the API class
var api = new ModRolesKeycloakApi.UserCapabilitySetApi()
var id = 1e111e76-1111-401c-ad8e-0d121a11111e; // {UUID} User identifier
var capabilitySetsUpdateRequest = {"$ref":"#/components/examples/capabilitySetsUpdateRequest"}; // {CapabilitySetsUpdateRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new UserCapabilitySetApi();
            var id = 1e111e76-1111-401c-ad8e-0d121a11111e;  // UUID | User identifier (default to null)
            var capabilitySetsUpdateRequest = new CapabilitySetsUpdateRequest(); // CapabilitySetsUpdateRequest | 

            try {
                apiInstance.updateUserCapabilitySets(id, capabilitySetsUpdateRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserCapabilitySetApi.updateUserCapabilitySets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserCapabilitySetApi();
$id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID | User identifier
$capabilitySetsUpdateRequest = {"$ref":"#/components/examples/capabilitySetsUpdateRequest"}; // CapabilitySetsUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserCapabilitySetApi->new();
my $id = 1e111e76-1111-401c-ad8e-0d121a11111e; # UUID | User identifier
my $capabilitySetsUpdateRequest = WWW::OPenAPIClient::Object::CapabilitySetsUpdateRequest->new(); # CapabilitySetsUpdateRequest | 

eval {
    $api_instance->updateUserCapabilitySets(id => $id, capabilitySetsUpdateRequest => $capabilitySetsUpdateRequest);
};
if ($@) {
    warn "Exception when calling UserCapabilitySetApi->updateUserCapabilitySets: $@\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.UserCapabilitySetApi()
id = 1e111e76-1111-401c-ad8e-0d121a11111e # UUID | User identifier (default to null)
capabilitySetsUpdateRequest = {"$ref":"#/components/examples/capabilitySetsUpdateRequest"} # CapabilitySetsUpdateRequest | 

try:
    api_instance.update_user_capability_sets(id, capabilitySetsUpdateRequest)
except ApiException as e:
    print("Exception when calling UserCapabilitySetApi->updateUserCapabilitySets: %s\n" % e)
extern crate UserCapabilitySetApi;

pub fn main() {
    let id = 1e111e76-1111-401c-ad8e-0d121a11111e; // UUID
    let capabilitySetsUpdateRequest = {"$ref":"#/components/examples/capabilitySetsUpdateRequest"}; // CapabilitySetsUpdateRequest

    let mut context = UserCapabilitySetApi::Context::default();
    let result = client.updateUserCapabilitySets(id, capabilitySetsUpdateRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
User identifier
Required
Body parameters
Name Description
capabilitySetsUpdateRequest *

Responses