nevisIDM REST API documentation

ApplicationRESTService

createApplication

createApplication
post/core/v1/applications

**Since:** 2.74.0 **Required permission(s):** `AccessControl.ApplicationCreate` Creates a new application

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/applications" \
 -d '{
  "displayed" : true,
  "displayName" : {
    "EN" : "My Application",
    "DE" : "Meine Applikation"
  },
  "name" : "MyApplication",
  "description" : "This application is used as an example.",
  "extId" : "app-12345",
  "url" : "https://my.application.com"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApplicationRESTServiceApi;

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

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

        // Create an instance of the API class
        ApplicationRESTServiceApi apiInstance = new ApplicationRESTServiceApi();
        ApplicationCreateDTO applicationCreateDTO = {"extId":"1001","name":"Confluence","description":"Confluence is used to store documents.","url":"www.example.com/confluence/","displayed":true,"displayName":{"EN":"Confluence","DE":"Confluence","FR":"Confluence","IT":"Confluence"}}; // ApplicationCreateDTO | 

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

final api_instance = DefaultApi();

final ApplicationCreateDTO applicationCreateDTO = new ApplicationCreateDTO(); // ApplicationCreateDTO | 

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

import org.openapitools.client.api.ApplicationRESTServiceApi;

public class ApplicationRESTServiceApiExample {
    public static void main(String[] args) {
        ApplicationRESTServiceApi apiInstance = new ApplicationRESTServiceApi();
        ApplicationCreateDTO applicationCreateDTO = {"extId":"1001","name":"Confluence","description":"Confluence is used to store documents.","url":"www.example.com/confluence/","displayed":true,"displayName":{"EN":"Confluence","DE":"Confluence","FR":"Confluence","IT":"Confluence"}}; // ApplicationCreateDTO | 

        try {
            apiInstance.createApplication(applicationCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationRESTServiceApi#createApplication");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApplicationRESTServiceApi *apiInstance = [[ApplicationRESTServiceApi alloc] init];
ApplicationCreateDTO *applicationCreateDTO = {"extId":"1001","name":"Confluence","description":"Confluence is used to store documents.","url":"www.example.com/confluence/","displayed":true,"displayName":{"EN":"Confluence","DE":"Confluence","FR":"Confluence","IT":"Confluence"}}; // 

// Create application
[apiInstance createApplicationWith:applicationCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ApplicationRESTServiceApi()
var applicationCreateDTO = {"extId":"1001","name":"Confluence","description":"Confluence is used to store documents.","url":"www.example.com/confluence/","displayed":true,"displayName":{"EN":"Confluence","DE":"Confluence","FR":"Confluence","IT":"Confluence"}}; // {ApplicationCreateDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new ApplicationRESTServiceApi();
            var applicationCreateDTO = new ApplicationCreateDTO(); // ApplicationCreateDTO | 

            try {
                // Create application
                apiInstance.createApplication(applicationCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApplicationRESTServiceApi.createApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApplicationRESTServiceApi();
$applicationCreateDTO = {"extId":"1001","name":"Confluence","description":"Confluence is used to store documents.","url":"www.example.com/confluence/","displayed":true,"displayName":{"EN":"Confluence","DE":"Confluence","FR":"Confluence","IT":"Confluence"}}; // ApplicationCreateDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApplicationRESTServiceApi->new();
my $applicationCreateDTO = WWW::OPenAPIClient::Object::ApplicationCreateDTO->new(); # ApplicationCreateDTO | 

eval {
    $api_instance->createApplication(applicationCreateDTO => $applicationCreateDTO);
};
if ($@) {
    warn "Exception when calling ApplicationRESTServiceApi->createApplication: $@\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.ApplicationRESTServiceApi()
applicationCreateDTO = {"extId":"1001","name":"Confluence","description":"Confluence is used to store documents.","url":"www.example.com/confluence/","displayed":true,"displayName":{"EN":"Confluence","DE":"Confluence","FR":"Confluence","IT":"Confluence"}} # ApplicationCreateDTO | 

try:
    # Create application
    api_instance.create_application(applicationCreateDTO)
except ApiException as e:
    print("Exception when calling ApplicationRESTServiceApi->createApplication: %s\n" % e)
extern crate ApplicationRESTServiceApi;

pub fn main() {
    let applicationCreateDTO = {"extId":"1001","name":"Confluence","description":"Confluence is used to store documents.","url":"www.example.com/confluence/","displayed":true,"displayName":{"EN":"Confluence","DE":"Confluence","FR":"Confluence","IT":"Confluence"}}; // ApplicationCreateDTO

    let mut context = ApplicationRESTServiceApi::Context::default();
    let result = client.createApplication(applicationCreateDTO, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
applicationCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

createRole

createRole
post/core/v1/applications/{extId}/roles

**Since:** 2.74.0 **Required permission(s):** `AccessControl.ApplicationView,AccessControl.RoleCreate` Creates a new role for the application with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/applications/{extId}/roles" \
 -d '{
  "name" : "name",
  "description" : "description",
  "extId" : "extId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApplicationRESTServiceApi;

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

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

        // Create an instance of the API class
        ApplicationRESTServiceApi apiInstance = new ApplicationRESTServiceApi();
        String extId = 1001; // String | ExtID of the application
        RoleCreateDTO roleCreateDTO = {"extId":"1020","name":"readonlyRole","description":"role of read-only users"}; // RoleCreateDTO | 

        try {
            apiInstance.createRole(extId, roleCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationRESTServiceApi#createRole");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the application
final RoleCreateDTO roleCreateDTO = new RoleCreateDTO(); // RoleCreateDTO | 

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

import org.openapitools.client.api.ApplicationRESTServiceApi;

public class ApplicationRESTServiceApiExample {
    public static void main(String[] args) {
        ApplicationRESTServiceApi apiInstance = new ApplicationRESTServiceApi();
        String extId = 1001; // String | ExtID of the application
        RoleCreateDTO roleCreateDTO = {"extId":"1020","name":"readonlyRole","description":"role of read-only users"}; // RoleCreateDTO | 

        try {
            apiInstance.createRole(extId, roleCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationRESTServiceApi#createRole");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApplicationRESTServiceApi *apiInstance = [[ApplicationRESTServiceApi alloc] init];
String *extId = 1001; // ExtID of the application (default to null)
RoleCreateDTO *roleCreateDTO = {"extId":"1020","name":"readonlyRole","description":"role of read-only users"}; // 

// Create role
[apiInstance createRoleWith:extId
    roleCreateDTO:roleCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ApplicationRESTServiceApi()
var extId = 1001; // {String} ExtID of the application
var roleCreateDTO = {"extId":"1020","name":"readonlyRole","description":"role of read-only users"}; // {RoleCreateDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createRole(extId, roleCreateDTO, 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 ApplicationRESTServiceApi();
            var extId = 1001;  // String | ExtID of the application (default to null)
            var roleCreateDTO = new RoleCreateDTO(); // RoleCreateDTO | 

            try {
                // Create role
                apiInstance.createRole(extId, roleCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApplicationRESTServiceApi.createRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApplicationRESTServiceApi();
$extId = 1001; // String | ExtID of the application
$roleCreateDTO = {"extId":"1020","name":"readonlyRole","description":"role of read-only users"}; // RoleCreateDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApplicationRESTServiceApi->new();
my $extId = 1001; # String | ExtID of the application
my $roleCreateDTO = WWW::OPenAPIClient::Object::RoleCreateDTO->new(); # RoleCreateDTO | 

eval {
    $api_instance->createRole(extId => $extId, roleCreateDTO => $roleCreateDTO);
};
if ($@) {
    warn "Exception when calling ApplicationRESTServiceApi->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.ApplicationRESTServiceApi()
extId = 1001 # String | ExtID of the application (default to null)
roleCreateDTO = {"extId":"1020","name":"readonlyRole","description":"role of read-only users"} # RoleCreateDTO | 

try:
    # Create role
    api_instance.create_role(extId, roleCreateDTO)
except ApiException as e:
    print("Exception when calling ApplicationRESTServiceApi->createRole: %s\n" % e)
extern crate ApplicationRESTServiceApi;

pub fn main() {
    let extId = 1001; // String
    let roleCreateDTO = {"extId":"1020","name":"readonlyRole","description":"role of read-only users"}; // RoleCreateDTO

    let mut context = ApplicationRESTServiceApi::Context::default();
    let result = client.createRole(extId, roleCreateDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the application
Required
Body parameters
Name Description
roleCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

deleteApplication

deleteApplication
delete/core/v1/applications/{extId}

**Since:** 2.74.0 **Required permission(s):** `AccessControl.ApplicationDelete` Deletes the application with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/applications/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApplicationRESTServiceApi;

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

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

        // Create an instance of the API class
        ApplicationRESTServiceApi apiInstance = new ApplicationRESTServiceApi();
        String extId = 1001; // String | ExtID of the application

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

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the application

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

import org.openapitools.client.api.ApplicationRESTServiceApi;

public class ApplicationRESTServiceApiExample {
    public static void main(String[] args) {
        ApplicationRESTServiceApi apiInstance = new ApplicationRESTServiceApi();
        String extId = 1001; // String | ExtID of the application

        try {
            apiInstance.deleteApplication(extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationRESTServiceApi#deleteApplication");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApplicationRESTServiceApi *apiInstance = [[ApplicationRESTServiceApi alloc] init];
String *extId = 1001; // ExtID of the application (default to null)

// Delete application
[apiInstance deleteApplicationWith:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ApplicationRESTServiceApi()
var extId = 1001; // {String} ExtID of the application

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

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

            // Create an instance of the API class
            var apiInstance = new ApplicationRESTServiceApi();
            var extId = 1001;  // String | ExtID of the application (default to null)

            try {
                // Delete application
                apiInstance.deleteApplication(extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApplicationRESTServiceApi.deleteApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApplicationRESTServiceApi();
$extId = 1001; // String | ExtID of the application

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApplicationRESTServiceApi->new();
my $extId = 1001; # String | ExtID of the application

eval {
    $api_instance->deleteApplication(extId => $extId);
};
if ($@) {
    warn "Exception when calling ApplicationRESTServiceApi->deleteApplication: $@\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.ApplicationRESTServiceApi()
extId = 1001 # String | ExtID of the application (default to null)

try:
    # Delete application
    api_instance.delete_application(extId)
except ApiException as e:
    print("Exception when calling ApplicationRESTServiceApi->deleteApplication: %s\n" % e)
extern crate ApplicationRESTServiceApi;

pub fn main() {
    let extId = 1001; // String

    let mut context = ApplicationRESTServiceApi::Context::default();
    let result = client.deleteApplication(extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the application
Required

Responses


getAllApplications

getAllApplications
get/core/v1/applications

**Since:** 2.71.0 **Required permission(s):** `AccessControl.ApplicationView` Returns the application with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/applications?extId=1001&continuationToken=continuationToken_example&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApplicationRESTServiceApi;

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

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

        // Create an instance of the API class
        ApplicationRESTServiceApi apiInstance = new ApplicationRESTServiceApi();
         UNKNOWN_PARAMETER_NAME = 1001; //  | ExtID of the application
        String continuationToken = continuationToken_example; // String | 
        Integer limit = 56; // Integer | 

        try {
            ItemsWrapperForApplicationGetDTO result = apiInstance.getAllApplications(UNKNOWN_PARAMETER_NAME, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationRESTServiceApi#getAllApplications");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final  UNKNOWN_PARAMETER_NAME = new (); //  | ExtID of the application
final String continuationToken = new String(); // String | 
final Integer limit = new Integer(); // Integer | 

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

import org.openapitools.client.api.ApplicationRESTServiceApi;

public class ApplicationRESTServiceApiExample {
    public static void main(String[] args) {
        ApplicationRESTServiceApi apiInstance = new ApplicationRESTServiceApi();
         UNKNOWN_PARAMETER_NAME = 1001; //  | ExtID of the application
        String continuationToken = continuationToken_example; // String | 
        Integer limit = 56; // Integer | 

        try {
            ItemsWrapperForApplicationGetDTO result = apiInstance.getAllApplications(UNKNOWN_PARAMETER_NAME, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationRESTServiceApi#getAllApplications");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApplicationRESTServiceApi *apiInstance = [[ApplicationRESTServiceApi alloc] init];
 *UNKNOWN_PARAMETER_NAME = 1001; // ExtID of the application
String *continuationToken = continuationToken_example; //  (optional) (default to )
Integer *limit = 56; //  (optional) (default to 0)

// Get application
[apiInstance getAllApplicationsWith:UNKNOWN_PARAMETER_NAME
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForApplicationGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ApplicationRESTServiceApi()
var UNKNOWN_PARAMETER_NAME = 1001; // {} ExtID of the application
var opts = {
  'continuationToken': continuationToken_example, // {String} 
  'limit': 56 // {Integer} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new ApplicationRESTServiceApi();
            var UNKNOWN_PARAMETER_NAME = new (); //  | ExtID of the application
            var continuationToken = continuationToken_example;  // String |  (optional)  (default to )
            var limit = 56;  // Integer |  (optional)  (default to 0)

            try {
                // Get application
                ItemsWrapperForApplicationGetDTO result = apiInstance.getAllApplications(UNKNOWN_PARAMETER_NAME, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApplicationRESTServiceApi.getAllApplications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApplicationRESTServiceApi();
$UNKNOWN_PARAMETER_NAME = 1001; //  | ExtID of the application
$continuationToken = continuationToken_example; // String | 
$limit = 56; // Integer | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApplicationRESTServiceApi->new();
my $UNKNOWN_PARAMETER_NAME = 1001; #  | ExtID of the application
my $continuationToken = continuationToken_example; # String | 
my $limit = 56; # Integer | 

eval {
    my $result = $api_instance->getAllApplications(UNKNOWN_PARAMETER_NAME => $UNKNOWN_PARAMETER_NAME, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApplicationRESTServiceApi->getAllApplications: $@\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.ApplicationRESTServiceApi()
UNKNOWN_PARAMETER_NAME = 1001 #  | ExtID of the application
continuationToken = continuationToken_example # String |  (optional) (default to )
limit = 56 # Integer |  (optional) (default to 0)

try:
    # Get application
    api_response = api_instance.get_all_applications(UNKNOWN_PARAMETER_NAME, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationRESTServiceApi->getAllApplications: %s\n" % e)
extern crate ApplicationRESTServiceApi;

pub fn main() {
    let UNKNOWN_PARAMETER_NAME = 1001; // 
    let continuationToken = continuationToken_example; // String
    let limit = 56; // Integer

    let mut context = ApplicationRESTServiceApi::Context::default();
    let result = client.getAllApplications(UNKNOWN_PARAMETER_NAME, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
extId*
ExtID of the application
Required
continuationToken
String
limit
Integer (int32)

Responses


getApplication

getApplication
get/core/v1/applications/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.ApplicationView` Returns the application with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/applications/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApplicationRESTServiceApi;

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

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

        // Create an instance of the API class
        ApplicationRESTServiceApi apiInstance = new ApplicationRESTServiceApi();
        String extId = 1001; // String | ExtID of the application

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

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the application

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

import org.openapitools.client.api.ApplicationRESTServiceApi;

public class ApplicationRESTServiceApiExample {
    public static void main(String[] args) {
        ApplicationRESTServiceApi apiInstance = new ApplicationRESTServiceApi();
        String extId = 1001; // String | ExtID of the application

        try {
            ApplicationGetDTO result = apiInstance.getApplication(extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationRESTServiceApi#getApplication");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApplicationRESTServiceApi *apiInstance = [[ApplicationRESTServiceApi alloc] init];
String *extId = 1001; // ExtID of the application (default to null)

// Get application
[apiInstance getApplicationWith:extId
              completionHandler: ^(ApplicationGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ApplicationRESTServiceApi()
var extId = 1001; // {String} ExtID of the application

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

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

            // Create an instance of the API class
            var apiInstance = new ApplicationRESTServiceApi();
            var extId = 1001;  // String | ExtID of the application (default to null)

            try {
                // Get application
                ApplicationGetDTO result = apiInstance.getApplication(extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApplicationRESTServiceApi.getApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApplicationRESTServiceApi();
$extId = 1001; // String | ExtID of the application

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApplicationRESTServiceApi->new();
my $extId = 1001; # String | ExtID of the application

eval {
    my $result = $api_instance->getApplication(extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApplicationRESTServiceApi->getApplication: $@\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.ApplicationRESTServiceApi()
extId = 1001 # String | ExtID of the application (default to null)

try:
    # Get application
    api_response = api_instance.get_application(extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationRESTServiceApi->getApplication: %s\n" % e)
extern crate ApplicationRESTServiceApi;

pub fn main() {
    let extId = 1001; // String

    let mut context = ApplicationRESTServiceApi::Context::default();
    let result = client.getApplication(extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the application
Required

Responses


getProperties3

getProperties3
get/core/v1/applications/{extId}/properties

**Since:** 2.74.0 **Required permission(s):** `AccessControl.ApplicationView,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView` Returns all properties of the application with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/applications/{extId}/properties"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApplicationRESTServiceApi;

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

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

        // Create an instance of the API class
        ApplicationRESTServiceApi apiInstance = new ApplicationRESTServiceApi();
        String extId = 1001; // String | ExtID of the application

        try {
            map['String', 'String'] result = apiInstance.getProperties3(extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationRESTServiceApi#getProperties3");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the application

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

import org.openapitools.client.api.ApplicationRESTServiceApi;

public class ApplicationRESTServiceApiExample {
    public static void main(String[] args) {
        ApplicationRESTServiceApi apiInstance = new ApplicationRESTServiceApi();
        String extId = 1001; // String | ExtID of the application

        try {
            map['String', 'String'] result = apiInstance.getProperties3(extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationRESTServiceApi#getProperties3");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApplicationRESTServiceApi *apiInstance = [[ApplicationRESTServiceApi alloc] init];
String *extId = 1001; // ExtID of the application (default to null)

// Get properties
[apiInstance getProperties3With:extId
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ApplicationRESTServiceApi()
var extId = 1001; // {String} ExtID of the application

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

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

            // Create an instance of the API class
            var apiInstance = new ApplicationRESTServiceApi();
            var extId = 1001;  // String | ExtID of the application (default to null)

            try {
                // Get properties
                map['String', 'String'] result = apiInstance.getProperties3(extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApplicationRESTServiceApi.getProperties3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApplicationRESTServiceApi();
$extId = 1001; // String | ExtID of the application

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApplicationRESTServiceApi->new();
my $extId = 1001; # String | ExtID of the application

eval {
    my $result = $api_instance->getProperties3(extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApplicationRESTServiceApi->getProperties3: $@\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.ApplicationRESTServiceApi()
extId = 1001 # String | ExtID of the application (default to null)

try:
    # Get properties
    api_response = api_instance.get_properties3(extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationRESTServiceApi->getProperties3: %s\n" % e)
extern crate ApplicationRESTServiceApi;

pub fn main() {
    let extId = 1001; // String

    let mut context = ApplicationRESTServiceApi::Context::default();
    let result = client.getProperties3(extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the application
Required

Responses


getRoles

getRoles
get/core/v1/applications/{extId}/roles

**Since:** 2.71.0 **Required permission(s):** `AccessControl.ApplicationView,AccessControl.RoleView` Returns all roles of the application with the given external ID

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/applications/{extId}/roles?continuationToken=continuationToken_example&limit=100"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApplicationRESTServiceApi;

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

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

        // Create an instance of the API class
        ApplicationRESTServiceApi apiInstance = new ApplicationRESTServiceApi();
        String extId = 1001; // String | ExtID of the application
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperForRoleGetDTO result = apiInstance.getRoles(extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationRESTServiceApi#getRoles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the application
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

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

import org.openapitools.client.api.ApplicationRESTServiceApi;

public class ApplicationRESTServiceApiExample {
    public static void main(String[] args) {
        ApplicationRESTServiceApi apiInstance = new ApplicationRESTServiceApi();
        String extId = 1001; // String | ExtID of the application
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperForRoleGetDTO result = apiInstance.getRoles(extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationRESTServiceApi#getRoles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApplicationRESTServiceApi *apiInstance = [[ApplicationRESTServiceApi alloc] init];
String *extId = 1001; // ExtID of the application (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 100; // Pagination limit (optional) (default to 0)

// Get application roles
[apiInstance getRolesWith:extId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForRoleGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ApplicationRESTServiceApi()
var extId = 1001; // {String} ExtID of the application
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 100 // {Integer} Pagination limit
};

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

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

            // Create an instance of the API class
            var apiInstance = new ApplicationRESTServiceApi();
            var extId = 1001;  // String | ExtID of the application (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 100;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get application roles
                ItemsWrapperForRoleGetDTO result = apiInstance.getRoles(extId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApplicationRESTServiceApi.getRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApplicationRESTServiceApi();
$extId = 1001; // String | ExtID of the application
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 100; // Integer | Pagination limit

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApplicationRESTServiceApi->new();
my $extId = 1001; # String | ExtID of the application
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 100; # Integer | Pagination limit

eval {
    my $result = $api_instance->getRoles(extId => $extId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApplicationRESTServiceApi->getRoles: $@\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.ApplicationRESTServiceApi()
extId = 1001 # String | ExtID of the application (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 100 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get application roles
    api_response = api_instance.get_roles(extId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationRESTServiceApi->getRoles: %s\n" % e)
extern crate ApplicationRESTServiceApi;

pub fn main() {
    let extId = 1001; // String
    let continuationToken = continuationToken_example; // String
    let limit = 100; // Integer

    let mut context = ApplicationRESTServiceApi::Context::default();
    let result = client.getRoles(extId, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the application
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


updateApplication

updateApplication
patch/core/v1/applications/{extId}

**Since:** 2.74.0 Updates the application with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/applications/{extId}" \
 -d '{
  "displayed" : true,
  "displayName" : {
    "EN" : "Application Name in English",
    "DE" : "Application Name in German",
    "FR" : "Application Name in French",
    "IT" : "Application Name in Italian"
  },
  "name" : "MyApplication",
  "description" : "This is a sample application.",
  "version" : 1,
  "url" : "https://example.com"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApplicationRESTServiceApi;

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

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

        // Create an instance of the API class
        ApplicationRESTServiceApi apiInstance = new ApplicationRESTServiceApi();
        String extId = 1001; // String | ExtID of the application
        ApplicationPatchDTO applicationPatchDTO = {"version":10,"name":"Confluence","description":"Confluence is used to store documents.","url":"www.example.com/confluence/","displayed":true,"displayName":{"EN":"Confluence","DE":"Confli","FR":"Confluence","IT":"Confluence"}}; // ApplicationPatchDTO | 

        try {
            ApplicationGetDTO result = apiInstance.updateApplication(extId, applicationPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationRESTServiceApi#updateApplication");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the application
final ApplicationPatchDTO applicationPatchDTO = new ApplicationPatchDTO(); // ApplicationPatchDTO | 

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

import org.openapitools.client.api.ApplicationRESTServiceApi;

public class ApplicationRESTServiceApiExample {
    public static void main(String[] args) {
        ApplicationRESTServiceApi apiInstance = new ApplicationRESTServiceApi();
        String extId = 1001; // String | ExtID of the application
        ApplicationPatchDTO applicationPatchDTO = {"version":10,"name":"Confluence","description":"Confluence is used to store documents.","url":"www.example.com/confluence/","displayed":true,"displayName":{"EN":"Confluence","DE":"Confli","FR":"Confluence","IT":"Confluence"}}; // ApplicationPatchDTO | 

        try {
            ApplicationGetDTO result = apiInstance.updateApplication(extId, applicationPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationRESTServiceApi#updateApplication");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApplicationRESTServiceApi *apiInstance = [[ApplicationRESTServiceApi alloc] init];
String *extId = 1001; // ExtID of the application (default to null)
ApplicationPatchDTO *applicationPatchDTO = {"version":10,"name":"Confluence","description":"Confluence is used to store documents.","url":"www.example.com/confluence/","displayed":true,"displayName":{"EN":"Confluence","DE":"Confli","FR":"Confluence","IT":"Confluence"}}; // 

// Update application
[apiInstance updateApplicationWith:extId
    applicationPatchDTO:applicationPatchDTO
              completionHandler: ^(ApplicationGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ApplicationRESTServiceApi()
var extId = 1001; // {String} ExtID of the application
var applicationPatchDTO = {"version":10,"name":"Confluence","description":"Confluence is used to store documents.","url":"www.example.com/confluence/","displayed":true,"displayName":{"EN":"Confluence","DE":"Confli","FR":"Confluence","IT":"Confluence"}}; // {ApplicationPatchDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new ApplicationRESTServiceApi();
            var extId = 1001;  // String | ExtID of the application (default to null)
            var applicationPatchDTO = new ApplicationPatchDTO(); // ApplicationPatchDTO | 

            try {
                // Update application
                ApplicationGetDTO result = apiInstance.updateApplication(extId, applicationPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApplicationRESTServiceApi.updateApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApplicationRESTServiceApi();
$extId = 1001; // String | ExtID of the application
$applicationPatchDTO = {"version":10,"name":"Confluence","description":"Confluence is used to store documents.","url":"www.example.com/confluence/","displayed":true,"displayName":{"EN":"Confluence","DE":"Confli","FR":"Confluence","IT":"Confluence"}}; // ApplicationPatchDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApplicationRESTServiceApi->new();
my $extId = 1001; # String | ExtID of the application
my $applicationPatchDTO = WWW::OPenAPIClient::Object::ApplicationPatchDTO->new(); # ApplicationPatchDTO | 

eval {
    my $result = $api_instance->updateApplication(extId => $extId, applicationPatchDTO => $applicationPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApplicationRESTServiceApi->updateApplication: $@\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.ApplicationRESTServiceApi()
extId = 1001 # String | ExtID of the application (default to null)
applicationPatchDTO = {"version":10,"name":"Confluence","description":"Confluence is used to store documents.","url":"www.example.com/confluence/","displayed":true,"displayName":{"EN":"Confluence","DE":"Confli","FR":"Confluence","IT":"Confluence"}} # ApplicationPatchDTO | 

try:
    # Update application
    api_response = api_instance.update_application(extId, applicationPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationRESTServiceApi->updateApplication: %s\n" % e)
extern crate ApplicationRESTServiceApi;

pub fn main() {
    let extId = 1001; // String
    let applicationPatchDTO = {"version":10,"name":"Confluence","description":"Confluence is used to store documents.","url":"www.example.com/confluence/","displayed":true,"displayName":{"EN":"Confluence","DE":"Confli","FR":"Confluence","IT":"Confluence"}}; // ApplicationPatchDTO

    let mut context = ApplicationRESTServiceApi::Context::default();
    let result = client.updateApplication(extId, applicationPatchDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the application
Required
Body parameters
Name Description
applicationPatchDTO *

Responses


updateProperties6

updateProperties6
patch/core/v1/applications/{extId}/properties

**Since:** 2.74.0 **Required permission(s):** `AccessControl.ApplicationView,AccessControl.ApplicationModify,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView,AccessControl.PropertyValueCreate,AccessControl.PropertyValueDelete,AccessControl.PropertyValueModify` Updates the properties of the application with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/applications/{extId}/properties" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApplicationRESTServiceApi;

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

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

        // Create an instance of the API class
        ApplicationRESTServiceApi apiInstance = new ApplicationRESTServiceApi();
        String extId = 1001; // String | ExtID of the application
        map[String, String] requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String] | 

        try {
            map['String', 'String'] result = apiInstance.updateProperties6(extId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationRESTServiceApi#updateProperties6");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the application
final map[String, String] requestBody = new map[String, String](); // map[String, String] | 

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

import org.openapitools.client.api.ApplicationRESTServiceApi;

public class ApplicationRESTServiceApiExample {
    public static void main(String[] args) {
        ApplicationRESTServiceApi apiInstance = new ApplicationRESTServiceApi();
        String extId = 1001; // String | ExtID of the application
        map[String, String] requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String] | 

        try {
            map['String', 'String'] result = apiInstance.updateProperties6(extId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationRESTServiceApi#updateProperties6");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApplicationRESTServiceApi *apiInstance = [[ApplicationRESTServiceApi alloc] init];
String *extId = 1001; // ExtID of the application (default to null)
map[String, String] *requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // 

// Update application properties
[apiInstance updateProperties6With:extId
    requestBody:requestBody
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ApplicationRESTServiceApi()
var extId = 1001; // {String} ExtID of the application
var requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // {map[String, String]} 

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

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

            // Create an instance of the API class
            var apiInstance = new ApplicationRESTServiceApi();
            var extId = 1001;  // String | ExtID of the application (default to null)
            var requestBody = new map[String, String](); // map[String, String] | 

            try {
                // Update application properties
                map['String', 'String'] result = apiInstance.updateProperties6(extId, requestBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApplicationRESTServiceApi.updateProperties6: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApplicationRESTServiceApi();
$extId = 1001; // String | ExtID of the application
$requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApplicationRESTServiceApi->new();
my $extId = 1001; # String | ExtID of the application
my $requestBody = WWW::OPenAPIClient::Object::map[String, String]->new(); # map[String, String] | 

eval {
    my $result = $api_instance->updateProperties6(extId => $extId, requestBody => $requestBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApplicationRESTServiceApi->updateProperties6: $@\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.ApplicationRESTServiceApi()
extId = 1001 # String | ExtID of the application (default to null)
requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3} # map[String, String] | 

try:
    # Update application properties
    api_response = api_instance.update_properties6(extId, requestBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationRESTServiceApi->updateProperties6: %s\n" % e)
extern crate ApplicationRESTServiceApi;

pub fn main() {
    let extId = 1001; // String
    let requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String]

    let mut context = ApplicationRESTServiceApi::Context::default();
    let result = client.updateProperties6(extId, requestBody, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the application
Required
Body parameters
Name Description
requestBody *

Responses


AuthorizationsRESTService

createAuthorization

createAuthorization
post/core/v1/{clientExtId}/profiles/{profileExtId}/authorizations

**Since:** 2.71.0 Creates a new authorization for the specified profile.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{profileExtId}/authorizations" \
 -d '{
  "clientGlobal" : true,
  "unitGlobal" : true,
  "enterpriseRoleGlobal" : true,
  "extId" : "auth-12345",
  "validity" : {
    "from" : "2023-01-01T00:00:00Z",
    "to" : "2033-12-31T23:59:59Z"
  },
  "roleExtId" : "role-12345",
  "appGlobal" : true
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthorizationsRESTServiceApi;

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

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

        // Create an instance of the API class
        AuthorizationsRESTServiceApi apiInstance = new AuthorizationsRESTServiceApi();
        String clientExtId = clientExtId_example; // String | External ID of the client
        String profileExtId = profileExtId_example; // String | External ID of the profile
        AuthorizationCreateDTO authorizationCreateDTO = ; // AuthorizationCreateDTO | 

        try {
            apiInstance.createAuthorization(clientExtId, profileExtId, authorizationCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizationsRESTServiceApi#createAuthorization");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | External ID of the client
final String profileExtId = new String(); // String | External ID of the profile
final AuthorizationCreateDTO authorizationCreateDTO = new AuthorizationCreateDTO(); // AuthorizationCreateDTO | 

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

import org.openapitools.client.api.AuthorizationsRESTServiceApi;

public class AuthorizationsRESTServiceApiExample {
    public static void main(String[] args) {
        AuthorizationsRESTServiceApi apiInstance = new AuthorizationsRESTServiceApi();
        String clientExtId = clientExtId_example; // String | External ID of the client
        String profileExtId = profileExtId_example; // String | External ID of the profile
        AuthorizationCreateDTO authorizationCreateDTO = ; // AuthorizationCreateDTO | 

        try {
            apiInstance.createAuthorization(clientExtId, profileExtId, authorizationCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizationsRESTServiceApi#createAuthorization");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AuthorizationsRESTServiceApi *apiInstance = [[AuthorizationsRESTServiceApi alloc] init];
String *clientExtId = clientExtId_example; // External ID of the client (default to null)
String *profileExtId = profileExtId_example; // External ID of the profile (default to null)
AuthorizationCreateDTO *authorizationCreateDTO = ; // 

// Create a new authorization
[apiInstance createAuthorizationWith:clientExtId
    profileExtId:profileExtId
    authorizationCreateDTO:authorizationCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.AuthorizationsRESTServiceApi()
var clientExtId = clientExtId_example; // {String} External ID of the client
var profileExtId = profileExtId_example; // {String} External ID of the profile
var authorizationCreateDTO = ; // {AuthorizationCreateDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new AuthorizationsRESTServiceApi();
            var clientExtId = clientExtId_example;  // String | External ID of the client (default to null)
            var profileExtId = profileExtId_example;  // String | External ID of the profile (default to null)
            var authorizationCreateDTO = new AuthorizationCreateDTO(); // AuthorizationCreateDTO | 

            try {
                // Create a new authorization
                apiInstance.createAuthorization(clientExtId, profileExtId, authorizationCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthorizationsRESTServiceApi.createAuthorization: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthorizationsRESTServiceApi();
$clientExtId = clientExtId_example; // String | External ID of the client
$profileExtId = profileExtId_example; // String | External ID of the profile
$authorizationCreateDTO = ; // AuthorizationCreateDTO | 

try {
    $api_instance->createAuthorization($clientExtId, $profileExtId, $authorizationCreateDTO);
} catch (Exception $e) {
    echo 'Exception when calling AuthorizationsRESTServiceApi->createAuthorization: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthorizationsRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthorizationsRESTServiceApi->new();
my $clientExtId = clientExtId_example; # String | External ID of the client
my $profileExtId = profileExtId_example; # String | External ID of the profile
my $authorizationCreateDTO = WWW::OPenAPIClient::Object::AuthorizationCreateDTO->new(); # AuthorizationCreateDTO | 

eval {
    $api_instance->createAuthorization(clientExtId => $clientExtId, profileExtId => $profileExtId, authorizationCreateDTO => $authorizationCreateDTO);
};
if ($@) {
    warn "Exception when calling AuthorizationsRESTServiceApi->createAuthorization: $@\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.AuthorizationsRESTServiceApi()
clientExtId = clientExtId_example # String | External ID of the client (default to null)
profileExtId = profileExtId_example # String | External ID of the profile (default to null)
authorizationCreateDTO =  # AuthorizationCreateDTO | 

try:
    # Create a new authorization
    api_instance.create_authorization(clientExtId, profileExtId, authorizationCreateDTO)
except ApiException as e:
    print("Exception when calling AuthorizationsRESTServiceApi->createAuthorization: %s\n" % e)
extern crate AuthorizationsRESTServiceApi;

pub fn main() {
    let clientExtId = clientExtId_example; // String
    let profileExtId = profileExtId_example; // String
    let authorizationCreateDTO = ; // AuthorizationCreateDTO

    let mut context = AuthorizationsRESTServiceApi::Context::default();
    let result = client.createAuthorization(clientExtId, profileExtId, authorizationCreateDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
External ID of the client
Required
profileExtId*
String
External ID of the profile
Required
Body parameters
Name Description
authorizationCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

deleteAuthorization

deleteAuthorization
delete/core/v1/{clientExtId}/profiles/{profileExtId}/authorizations/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.AuthorizationDelete` Deletes an authorization by its external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{profileExtId}/authorizations/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthorizationsRESTServiceApi;

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

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

        // Create an instance of the API class
        AuthorizationsRESTServiceApi apiInstance = new AuthorizationsRESTServiceApi();
        String clientExtId = clientExtId_example; // String | External ID of the client
        String profileExtId = profileExtId_example; // String | External ID of the profile
        String extId = extId_example; // String | External ID of the authorization

        try {
            apiInstance.deleteAuthorization(clientExtId, profileExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizationsRESTServiceApi#deleteAuthorization");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | External ID of the client
final String profileExtId = new String(); // String | External ID of the profile
final String extId = new String(); // String | External ID of the authorization

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

import org.openapitools.client.api.AuthorizationsRESTServiceApi;

public class AuthorizationsRESTServiceApiExample {
    public static void main(String[] args) {
        AuthorizationsRESTServiceApi apiInstance = new AuthorizationsRESTServiceApi();
        String clientExtId = clientExtId_example; // String | External ID of the client
        String profileExtId = profileExtId_example; // String | External ID of the profile
        String extId = extId_example; // String | External ID of the authorization

        try {
            apiInstance.deleteAuthorization(clientExtId, profileExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizationsRESTServiceApi#deleteAuthorization");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AuthorizationsRESTServiceApi *apiInstance = [[AuthorizationsRESTServiceApi alloc] init];
String *clientExtId = clientExtId_example; // External ID of the client (default to null)
String *profileExtId = profileExtId_example; // External ID of the profile (default to null)
String *extId = extId_example; // External ID of the authorization (default to null)

// Delete an authorization
[apiInstance deleteAuthorizationWith:clientExtId
    profileExtId:profileExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.AuthorizationsRESTServiceApi()
var clientExtId = clientExtId_example; // {String} External ID of the client
var profileExtId = profileExtId_example; // {String} External ID of the profile
var extId = extId_example; // {String} External ID of the authorization

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

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

            // Create an instance of the API class
            var apiInstance = new AuthorizationsRESTServiceApi();
            var clientExtId = clientExtId_example;  // String | External ID of the client (default to null)
            var profileExtId = profileExtId_example;  // String | External ID of the profile (default to null)
            var extId = extId_example;  // String | External ID of the authorization (default to null)

            try {
                // Delete an authorization
                apiInstance.deleteAuthorization(clientExtId, profileExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthorizationsRESTServiceApi.deleteAuthorization: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthorizationsRESTServiceApi();
$clientExtId = clientExtId_example; // String | External ID of the client
$profileExtId = profileExtId_example; // String | External ID of the profile
$extId = extId_example; // String | External ID of the authorization

try {
    $api_instance->deleteAuthorization($clientExtId, $profileExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling AuthorizationsRESTServiceApi->deleteAuthorization: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthorizationsRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthorizationsRESTServiceApi->new();
my $clientExtId = clientExtId_example; # String | External ID of the client
my $profileExtId = profileExtId_example; # String | External ID of the profile
my $extId = extId_example; # String | External ID of the authorization

eval {
    $api_instance->deleteAuthorization(clientExtId => $clientExtId, profileExtId => $profileExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling AuthorizationsRESTServiceApi->deleteAuthorization: $@\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.AuthorizationsRESTServiceApi()
clientExtId = clientExtId_example # String | External ID of the client (default to null)
profileExtId = profileExtId_example # String | External ID of the profile (default to null)
extId = extId_example # String | External ID of the authorization (default to null)

try:
    # Delete an authorization
    api_instance.delete_authorization(clientExtId, profileExtId, extId)
except ApiException as e:
    print("Exception when calling AuthorizationsRESTServiceApi->deleteAuthorization: %s\n" % e)
extern crate AuthorizationsRESTServiceApi;

pub fn main() {
    let clientExtId = clientExtId_example; // String
    let profileExtId = profileExtId_example; // String
    let extId = extId_example; // String

    let mut context = AuthorizationsRESTServiceApi::Context::default();
    let result = client.deleteAuthorization(clientExtId, profileExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
External ID of the client
Required
profileExtId*
String
External ID of the profile
Required
extId*
String
External ID of the authorization
Required

Responses


getAllAuthorizationsOfProfile

getAllAuthorizationsOfProfile
get/core/v1/{clientExtId}/profiles/{profileExtId}/authorizations

**Since:** 2.71.0 **Required permission(s):** `AccessControl.AuthorizationView` or `SelfAdmin` Role Returns a paginated list of authorizations for the specified profile.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{profileExtId}/authorizations?continuationToken=continuationToken_example&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthorizationsRESTServiceApi;

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

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

        // Create an instance of the API class
        AuthorizationsRESTServiceApi apiInstance = new AuthorizationsRESTServiceApi();
        String clientExtId = clientExtId_example; // String | External ID of the client
        String profileExtId = profileExtId_example; // String | External ID of the profile
        String continuationToken = continuationToken_example; // String | Continuation token for pagination
        Integer limit = 56; // Integer | Limit for pagination

        try {
            ItemsWrapperForAuthorizationGetDTO result = apiInstance.getAllAuthorizationsOfProfile(clientExtId, profileExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizationsRESTServiceApi#getAllAuthorizationsOfProfile");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | External ID of the client
final String profileExtId = new String(); // String | External ID of the profile
final String continuationToken = new String(); // String | Continuation token for pagination
final Integer limit = new Integer(); // Integer | Limit for pagination

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

import org.openapitools.client.api.AuthorizationsRESTServiceApi;

public class AuthorizationsRESTServiceApiExample {
    public static void main(String[] args) {
        AuthorizationsRESTServiceApi apiInstance = new AuthorizationsRESTServiceApi();
        String clientExtId = clientExtId_example; // String | External ID of the client
        String profileExtId = profileExtId_example; // String | External ID of the profile
        String continuationToken = continuationToken_example; // String | Continuation token for pagination
        Integer limit = 56; // Integer | Limit for pagination

        try {
            ItemsWrapperForAuthorizationGetDTO result = apiInstance.getAllAuthorizationsOfProfile(clientExtId, profileExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizationsRESTServiceApi#getAllAuthorizationsOfProfile");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AuthorizationsRESTServiceApi *apiInstance = [[AuthorizationsRESTServiceApi alloc] init];
String *clientExtId = clientExtId_example; // External ID of the client (default to null)
String *profileExtId = profileExtId_example; // External ID of the profile (default to null)
String *continuationToken = continuationToken_example; // Continuation token for pagination (optional) (default to )
Integer *limit = 56; // Limit for pagination (optional) (default to 0)

// Get all authorizations of a profile
[apiInstance getAllAuthorizationsOfProfileWith:clientExtId
    profileExtId:profileExtId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForAuthorizationGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.AuthorizationsRESTServiceApi()
var clientExtId = clientExtId_example; // {String} External ID of the client
var profileExtId = profileExtId_example; // {String} External ID of the profile
var opts = {
  'continuationToken': continuationToken_example, // {String} Continuation token for pagination
  'limit': 56 // {Integer} Limit for pagination
};

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

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

            // Create an instance of the API class
            var apiInstance = new AuthorizationsRESTServiceApi();
            var clientExtId = clientExtId_example;  // String | External ID of the client (default to null)
            var profileExtId = profileExtId_example;  // String | External ID of the profile (default to null)
            var continuationToken = continuationToken_example;  // String | Continuation token for pagination (optional)  (default to )
            var limit = 56;  // Integer | Limit for pagination (optional)  (default to 0)

            try {
                // Get all authorizations of a profile
                ItemsWrapperForAuthorizationGetDTO result = apiInstance.getAllAuthorizationsOfProfile(clientExtId, profileExtId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthorizationsRESTServiceApi.getAllAuthorizationsOfProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthorizationsRESTServiceApi();
$clientExtId = clientExtId_example; // String | External ID of the client
$profileExtId = profileExtId_example; // String | External ID of the profile
$continuationToken = continuationToken_example; // String | Continuation token for pagination
$limit = 56; // Integer | Limit for pagination

try {
    $result = $api_instance->getAllAuthorizationsOfProfile($clientExtId, $profileExtId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthorizationsRESTServiceApi->getAllAuthorizationsOfProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthorizationsRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthorizationsRESTServiceApi->new();
my $clientExtId = clientExtId_example; # String | External ID of the client
my $profileExtId = profileExtId_example; # String | External ID of the profile
my $continuationToken = continuationToken_example; # String | Continuation token for pagination
my $limit = 56; # Integer | Limit for pagination

eval {
    my $result = $api_instance->getAllAuthorizationsOfProfile(clientExtId => $clientExtId, profileExtId => $profileExtId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthorizationsRESTServiceApi->getAllAuthorizationsOfProfile: $@\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.AuthorizationsRESTServiceApi()
clientExtId = clientExtId_example # String | External ID of the client (default to null)
profileExtId = profileExtId_example # String | External ID of the profile (default to null)
continuationToken = continuationToken_example # String | Continuation token for pagination (optional) (default to )
limit = 56 # Integer | Limit for pagination (optional) (default to 0)

try:
    # Get all authorizations of a profile
    api_response = api_instance.get_all_authorizations_of_profile(clientExtId, profileExtId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthorizationsRESTServiceApi->getAllAuthorizationsOfProfile: %s\n" % e)
extern crate AuthorizationsRESTServiceApi;

pub fn main() {
    let clientExtId = clientExtId_example; // String
    let profileExtId = profileExtId_example; // String
    let continuationToken = continuationToken_example; // String
    let limit = 56; // Integer

    let mut context = AuthorizationsRESTServiceApi::Context::default();
    let result = client.getAllAuthorizationsOfProfile(clientExtId, profileExtId, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
External ID of the client
Required
profileExtId*
String
External ID of the profile
Required
Query parameters
Name Description
continuationToken
String
Continuation token for pagination
limit
Integer (int32)
Limit for pagination

Responses


getAuthorizationOfProfile

getAuthorizationOfProfile
get/core/v1/{clientExtId}/profiles/{profileExtId}/authorizations/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.AuthorizationView` or `SelfAdmin` Role Returns the details of a specific authorization by its external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{profileExtId}/authorizations/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthorizationsRESTServiceApi;

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

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

        // Create an instance of the API class
        AuthorizationsRESTServiceApi apiInstance = new AuthorizationsRESTServiceApi();
        String clientExtId = clientExtId_example; // String | External ID of the client
        String profileExtId = profileExtId_example; // String | External ID of the profile
        String extId = extId_example; // String | External ID of the authorization

        try {
            AuthorizationGetDTO result = apiInstance.getAuthorizationOfProfile(clientExtId, profileExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizationsRESTServiceApi#getAuthorizationOfProfile");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | External ID of the client
final String profileExtId = new String(); // String | External ID of the profile
final String extId = new String(); // String | External ID of the authorization

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

import org.openapitools.client.api.AuthorizationsRESTServiceApi;

public class AuthorizationsRESTServiceApiExample {
    public static void main(String[] args) {
        AuthorizationsRESTServiceApi apiInstance = new AuthorizationsRESTServiceApi();
        String clientExtId = clientExtId_example; // String | External ID of the client
        String profileExtId = profileExtId_example; // String | External ID of the profile
        String extId = extId_example; // String | External ID of the authorization

        try {
            AuthorizationGetDTO result = apiInstance.getAuthorizationOfProfile(clientExtId, profileExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizationsRESTServiceApi#getAuthorizationOfProfile");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AuthorizationsRESTServiceApi *apiInstance = [[AuthorizationsRESTServiceApi alloc] init];
String *clientExtId = clientExtId_example; // External ID of the client (default to null)
String *profileExtId = profileExtId_example; // External ID of the profile (default to null)
String *extId = extId_example; // External ID of the authorization (default to null)

// Get a specific authorization
[apiInstance getAuthorizationOfProfileWith:clientExtId
    profileExtId:profileExtId
    extId:extId
              completionHandler: ^(AuthorizationGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.AuthorizationsRESTServiceApi()
var clientExtId = clientExtId_example; // {String} External ID of the client
var profileExtId = profileExtId_example; // {String} External ID of the profile
var extId = extId_example; // {String} External ID of the authorization

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

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

            // Create an instance of the API class
            var apiInstance = new AuthorizationsRESTServiceApi();
            var clientExtId = clientExtId_example;  // String | External ID of the client (default to null)
            var profileExtId = profileExtId_example;  // String | External ID of the profile (default to null)
            var extId = extId_example;  // String | External ID of the authorization (default to null)

            try {
                // Get a specific authorization
                AuthorizationGetDTO result = apiInstance.getAuthorizationOfProfile(clientExtId, profileExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthorizationsRESTServiceApi.getAuthorizationOfProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthorizationsRESTServiceApi();
$clientExtId = clientExtId_example; // String | External ID of the client
$profileExtId = profileExtId_example; // String | External ID of the profile
$extId = extId_example; // String | External ID of the authorization

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthorizationsRESTServiceApi->new();
my $clientExtId = clientExtId_example; # String | External ID of the client
my $profileExtId = profileExtId_example; # String | External ID of the profile
my $extId = extId_example; # String | External ID of the authorization

eval {
    my $result = $api_instance->getAuthorizationOfProfile(clientExtId => $clientExtId, profileExtId => $profileExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthorizationsRESTServiceApi->getAuthorizationOfProfile: $@\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.AuthorizationsRESTServiceApi()
clientExtId = clientExtId_example # String | External ID of the client (default to null)
profileExtId = profileExtId_example # String | External ID of the profile (default to null)
extId = extId_example # String | External ID of the authorization (default to null)

try:
    # Get a specific authorization
    api_response = api_instance.get_authorization_of_profile(clientExtId, profileExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthorizationsRESTServiceApi->getAuthorizationOfProfile: %s\n" % e)
extern crate AuthorizationsRESTServiceApi;

pub fn main() {
    let clientExtId = clientExtId_example; // String
    let profileExtId = profileExtId_example; // String
    let extId = extId_example; // String

    let mut context = AuthorizationsRESTServiceApi::Context::default();
    let result = client.getAuthorizationOfProfile(clientExtId, profileExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
External ID of the client
Required
profileExtId*
String
External ID of the profile
Required
extId*
String
External ID of the authorization
Required

Responses


getAuthorizationProperties

getAuthorizationProperties
get/core/v1/{clientExtId}/profiles/{profileExtId}/authorizations/{extId}/properties

**Since:** 2.79.0 **Required permission(s):** `AccessControl.AuthorizationView` Returns the properties of a specific authorization.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{profileExtId}/authorizations/{extId}/properties"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthorizationsRESTServiceApi;

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

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

        // Create an instance of the API class
        AuthorizationsRESTServiceApi apiInstance = new AuthorizationsRESTServiceApi();
        String clientExtId = clientExtId_example; // String | External ID of the client
        String profileExtId = profileExtId_example; // String | External ID of the profile
        String extId = extId_example; // String | External ID of the authorization

        try {
            map['String', 'String'] result = apiInstance.getAuthorizationProperties(clientExtId, profileExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizationsRESTServiceApi#getAuthorizationProperties");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | External ID of the client
final String profileExtId = new String(); // String | External ID of the profile
final String extId = new String(); // String | External ID of the authorization

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

import org.openapitools.client.api.AuthorizationsRESTServiceApi;

public class AuthorizationsRESTServiceApiExample {
    public static void main(String[] args) {
        AuthorizationsRESTServiceApi apiInstance = new AuthorizationsRESTServiceApi();
        String clientExtId = clientExtId_example; // String | External ID of the client
        String profileExtId = profileExtId_example; // String | External ID of the profile
        String extId = extId_example; // String | External ID of the authorization

        try {
            map['String', 'String'] result = apiInstance.getAuthorizationProperties(clientExtId, profileExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizationsRESTServiceApi#getAuthorizationProperties");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AuthorizationsRESTServiceApi *apiInstance = [[AuthorizationsRESTServiceApi alloc] init];
String *clientExtId = clientExtId_example; // External ID of the client (default to null)
String *profileExtId = profileExtId_example; // External ID of the profile (default to null)
String *extId = extId_example; // External ID of the authorization (default to null)

// Get authorization properties
[apiInstance getAuthorizationPropertiesWith:clientExtId
    profileExtId:profileExtId
    extId:extId
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.AuthorizationsRESTServiceApi()
var clientExtId = clientExtId_example; // {String} External ID of the client
var profileExtId = profileExtId_example; // {String} External ID of the profile
var extId = extId_example; // {String} External ID of the authorization

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

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

            // Create an instance of the API class
            var apiInstance = new AuthorizationsRESTServiceApi();
            var clientExtId = clientExtId_example;  // String | External ID of the client (default to null)
            var profileExtId = profileExtId_example;  // String | External ID of the profile (default to null)
            var extId = extId_example;  // String | External ID of the authorization (default to null)

            try {
                // Get authorization properties
                map['String', 'String'] result = apiInstance.getAuthorizationProperties(clientExtId, profileExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthorizationsRESTServiceApi.getAuthorizationProperties: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthorizationsRESTServiceApi();
$clientExtId = clientExtId_example; // String | External ID of the client
$profileExtId = profileExtId_example; // String | External ID of the profile
$extId = extId_example; // String | External ID of the authorization

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthorizationsRESTServiceApi->new();
my $clientExtId = clientExtId_example; # String | External ID of the client
my $profileExtId = profileExtId_example; # String | External ID of the profile
my $extId = extId_example; # String | External ID of the authorization

eval {
    my $result = $api_instance->getAuthorizationProperties(clientExtId => $clientExtId, profileExtId => $profileExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthorizationsRESTServiceApi->getAuthorizationProperties: $@\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.AuthorizationsRESTServiceApi()
clientExtId = clientExtId_example # String | External ID of the client (default to null)
profileExtId = profileExtId_example # String | External ID of the profile (default to null)
extId = extId_example # String | External ID of the authorization (default to null)

try:
    # Get authorization properties
    api_response = api_instance.get_authorization_properties(clientExtId, profileExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthorizationsRESTServiceApi->getAuthorizationProperties: %s\n" % e)
extern crate AuthorizationsRESTServiceApi;

pub fn main() {
    let clientExtId = clientExtId_example; // String
    let profileExtId = profileExtId_example; // String
    let extId = extId_example; // String

    let mut context = AuthorizationsRESTServiceApi::Context::default();
    let result = client.getAuthorizationProperties(clientExtId, profileExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
External ID of the client
Required
profileExtId*
String
External ID of the profile
Required
extId*
String
External ID of the authorization
Required

Responses


updateAuthorization

updateAuthorization
patch/core/v1/{clientExtId}/profiles/{profileExtId}/authorizations/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.AuthorizationModify,AccessControl.AuthorizationView` Updates an existing authorization for the specified profile.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{profileExtId}/authorizations/{extId}" \
 -d '{
  "clientGlobal" : true,
  "unitGlobal" : true,
  "enterpriseRoleGlobal" : true,
  "validity" : {
    "from" : "2023-01-01T00:00:00Z",
    "to" : "2033-12-31T23:59:59Z"
  },
  "appGlobal" : true,
  "version" : 1
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthorizationsRESTServiceApi;

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

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

        // Create an instance of the API class
        AuthorizationsRESTServiceApi apiInstance = new AuthorizationsRESTServiceApi();
        String clientExtId = clientExtId_example; // String | External ID of the client
        String profileExtId = profileExtId_example; // String | External ID of the profile
        String extId = extId_example; // String | External ID of the authorization
        AuthorizationPatchDTO authorizationPatchDTO = ; // AuthorizationPatchDTO | 

        try {
            AuthorizationGetDTO result = apiInstance.updateAuthorization(clientExtId, profileExtId, extId, authorizationPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizationsRESTServiceApi#updateAuthorization");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | External ID of the client
final String profileExtId = new String(); // String | External ID of the profile
final String extId = new String(); // String | External ID of the authorization
final AuthorizationPatchDTO authorizationPatchDTO = new AuthorizationPatchDTO(); // AuthorizationPatchDTO | 

try {
    final result = await api_instance.updateAuthorization(clientExtId, profileExtId, extId, authorizationPatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateAuthorization: $e\n');
}

import org.openapitools.client.api.AuthorizationsRESTServiceApi;

public class AuthorizationsRESTServiceApiExample {
    public static void main(String[] args) {
        AuthorizationsRESTServiceApi apiInstance = new AuthorizationsRESTServiceApi();
        String clientExtId = clientExtId_example; // String | External ID of the client
        String profileExtId = profileExtId_example; // String | External ID of the profile
        String extId = extId_example; // String | External ID of the authorization
        AuthorizationPatchDTO authorizationPatchDTO = ; // AuthorizationPatchDTO | 

        try {
            AuthorizationGetDTO result = apiInstance.updateAuthorization(clientExtId, profileExtId, extId, authorizationPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizationsRESTServiceApi#updateAuthorization");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AuthorizationsRESTServiceApi *apiInstance = [[AuthorizationsRESTServiceApi alloc] init];
String *clientExtId = clientExtId_example; // External ID of the client (default to null)
String *profileExtId = profileExtId_example; // External ID of the profile (default to null)
String *extId = extId_example; // External ID of the authorization (default to null)
AuthorizationPatchDTO *authorizationPatchDTO = ; // 

// Update an authorization
[apiInstance updateAuthorizationWith:clientExtId
    profileExtId:profileExtId
    extId:extId
    authorizationPatchDTO:authorizationPatchDTO
              completionHandler: ^(AuthorizationGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.AuthorizationsRESTServiceApi()
var clientExtId = clientExtId_example; // {String} External ID of the client
var profileExtId = profileExtId_example; // {String} External ID of the profile
var extId = extId_example; // {String} External ID of the authorization
var authorizationPatchDTO = ; // {AuthorizationPatchDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new AuthorizationsRESTServiceApi();
            var clientExtId = clientExtId_example;  // String | External ID of the client (default to null)
            var profileExtId = profileExtId_example;  // String | External ID of the profile (default to null)
            var extId = extId_example;  // String | External ID of the authorization (default to null)
            var authorizationPatchDTO = new AuthorizationPatchDTO(); // AuthorizationPatchDTO | 

            try {
                // Update an authorization
                AuthorizationGetDTO result = apiInstance.updateAuthorization(clientExtId, profileExtId, extId, authorizationPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthorizationsRESTServiceApi.updateAuthorization: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthorizationsRESTServiceApi();
$clientExtId = clientExtId_example; // String | External ID of the client
$profileExtId = profileExtId_example; // String | External ID of the profile
$extId = extId_example; // String | External ID of the authorization
$authorizationPatchDTO = ; // AuthorizationPatchDTO | 

try {
    $result = $api_instance->updateAuthorization($clientExtId, $profileExtId, $extId, $authorizationPatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthorizationsRESTServiceApi->updateAuthorization: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthorizationsRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthorizationsRESTServiceApi->new();
my $clientExtId = clientExtId_example; # String | External ID of the client
my $profileExtId = profileExtId_example; # String | External ID of the profile
my $extId = extId_example; # String | External ID of the authorization
my $authorizationPatchDTO = WWW::OPenAPIClient::Object::AuthorizationPatchDTO->new(); # AuthorizationPatchDTO | 

eval {
    my $result = $api_instance->updateAuthorization(clientExtId => $clientExtId, profileExtId => $profileExtId, extId => $extId, authorizationPatchDTO => $authorizationPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthorizationsRESTServiceApi->updateAuthorization: $@\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.AuthorizationsRESTServiceApi()
clientExtId = clientExtId_example # String | External ID of the client (default to null)
profileExtId = profileExtId_example # String | External ID of the profile (default to null)
extId = extId_example # String | External ID of the authorization (default to null)
authorizationPatchDTO =  # AuthorizationPatchDTO | 

try:
    # Update an authorization
    api_response = api_instance.update_authorization(clientExtId, profileExtId, extId, authorizationPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthorizationsRESTServiceApi->updateAuthorization: %s\n" % e)
extern crate AuthorizationsRESTServiceApi;

pub fn main() {
    let clientExtId = clientExtId_example; // String
    let profileExtId = profileExtId_example; // String
    let extId = extId_example; // String
    let authorizationPatchDTO = ; // AuthorizationPatchDTO

    let mut context = AuthorizationsRESTServiceApi::Context::default();
    let result = client.updateAuthorization(clientExtId, profileExtId, extId, authorizationPatchDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
External ID of the client
Required
profileExtId*
String
External ID of the profile
Required
extId*
String
External ID of the authorization
Required
Body parameters
Name Description
authorizationPatchDTO *

Responses


updateProperties2

updateProperties2
patch/core/v1/{clientExtId}/profiles/{profileExtId}/authorizations/{extId}/properties

**Since:** 2.79.0 Updates the properties of a specific authorization.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{profileExtId}/authorizations/{extId}/properties" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthorizationsRESTServiceApi;

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

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

        // Create an instance of the API class
        AuthorizationsRESTServiceApi apiInstance = new AuthorizationsRESTServiceApi();
        String clientExtId = clientExtId_example; // String | External ID of the client
        String profileExtId = profileExtId_example; // String | External ID of the profile
        String extId = extId_example; // String | External ID of the authorization
        map[String, String] requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String] | 

        try {
            map['String', 'String'] result = apiInstance.updateProperties2(clientExtId, profileExtId, extId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizationsRESTServiceApi#updateProperties2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | External ID of the client
final String profileExtId = new String(); // String | External ID of the profile
final String extId = new String(); // String | External ID of the authorization
final map[String, String] requestBody = new map[String, String](); // map[String, String] | 

try {
    final result = await api_instance.updateProperties2(clientExtId, profileExtId, extId, requestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateProperties2: $e\n');
}

import org.openapitools.client.api.AuthorizationsRESTServiceApi;

public class AuthorizationsRESTServiceApiExample {
    public static void main(String[] args) {
        AuthorizationsRESTServiceApi apiInstance = new AuthorizationsRESTServiceApi();
        String clientExtId = clientExtId_example; // String | External ID of the client
        String profileExtId = profileExtId_example; // String | External ID of the profile
        String extId = extId_example; // String | External ID of the authorization
        map[String, String] requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String] | 

        try {
            map['String', 'String'] result = apiInstance.updateProperties2(clientExtId, profileExtId, extId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizationsRESTServiceApi#updateProperties2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AuthorizationsRESTServiceApi *apiInstance = [[AuthorizationsRESTServiceApi alloc] init];
String *clientExtId = clientExtId_example; // External ID of the client (default to null)
String *profileExtId = profileExtId_example; // External ID of the profile (default to null)
String *extId = extId_example; // External ID of the authorization (default to null)
map[String, String] *requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // 

// Update authorization properties
[apiInstance updateProperties2With:clientExtId
    profileExtId:profileExtId
    extId:extId
    requestBody:requestBody
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.AuthorizationsRESTServiceApi()
var clientExtId = clientExtId_example; // {String} External ID of the client
var profileExtId = profileExtId_example; // {String} External ID of the profile
var extId = extId_example; // {String} External ID of the authorization
var requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // {map[String, String]} 

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

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

            // Create an instance of the API class
            var apiInstance = new AuthorizationsRESTServiceApi();
            var clientExtId = clientExtId_example;  // String | External ID of the client (default to null)
            var profileExtId = profileExtId_example;  // String | External ID of the profile (default to null)
            var extId = extId_example;  // String | External ID of the authorization (default to null)
            var requestBody = new map[String, String](); // map[String, String] | 

            try {
                // Update authorization properties
                map['String', 'String'] result = apiInstance.updateProperties2(clientExtId, profileExtId, extId, requestBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthorizationsRESTServiceApi.updateProperties2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthorizationsRESTServiceApi();
$clientExtId = clientExtId_example; // String | External ID of the client
$profileExtId = profileExtId_example; // String | External ID of the profile
$extId = extId_example; // String | External ID of the authorization
$requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String] | 

try {
    $result = $api_instance->updateProperties2($clientExtId, $profileExtId, $extId, $requestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthorizationsRESTServiceApi->updateProperties2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthorizationsRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthorizationsRESTServiceApi->new();
my $clientExtId = clientExtId_example; # String | External ID of the client
my $profileExtId = profileExtId_example; # String | External ID of the profile
my $extId = extId_example; # String | External ID of the authorization
my $requestBody = WWW::OPenAPIClient::Object::map[String, String]->new(); # map[String, String] | 

eval {
    my $result = $api_instance->updateProperties2(clientExtId => $clientExtId, profileExtId => $profileExtId, extId => $extId, requestBody => $requestBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthorizationsRESTServiceApi->updateProperties2: $@\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.AuthorizationsRESTServiceApi()
clientExtId = clientExtId_example # String | External ID of the client (default to null)
profileExtId = profileExtId_example # String | External ID of the profile (default to null)
extId = extId_example # String | External ID of the authorization (default to null)
requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3} # map[String, String] | 

try:
    # Update authorization properties
    api_response = api_instance.update_properties2(clientExtId, profileExtId, extId, requestBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthorizationsRESTServiceApi->updateProperties2: %s\n" % e)
extern crate AuthorizationsRESTServiceApi;

pub fn main() {
    let clientExtId = clientExtId_example; // String
    let profileExtId = profileExtId_example; // String
    let extId = extId_example; // String
    let requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String]

    let mut context = AuthorizationsRESTServiceApi::Context::default();
    let result = client.updateProperties2(clientExtId, profileExtId, extId, requestBody, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
External ID of the client
Required
profileExtId*
String
External ID of the profile
Required
extId*
String
External ID of the authorization
Required
Body parameters
Name Description
requestBody *

Responses


CertificateRESTService

createCertificate

createCertificate
post/core/v1/{clientExtId}/users/{userExtId}/certificates

**Since:** 2.71.0 **Required permission(s):** `AccessControl.CredentialCreate,AccessControl.CredentialChangeState` or `SelfAdmin` Role Creates a new certificate credential for the user with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/certificates" \
 -d '{
  "policyExtId" : "policyExtId",
  "stateName" : "INITIAL",
  "certificate" : "certificate",
  "extId" : "extId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CertificateRESTServiceApi;

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

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

        // Create an instance of the API class
        CertificateRESTServiceApi apiInstance = new CertificateRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        CertificateCreateDTO certificateCreateDTO = {"extId":"4254","policyExtId":"104","stateName":"active","certificate":"-----BEGIN CERTIFICATE-----\nMIICSTCCAfMCFHf+gz+2mWrvXo0TZieIJtRCW+tLMA0GCSqGSIb3DQEBCwUAMIGl\nMQswCQYDVQQGEwJDSDEYMBYGA1UECAwPRXhhbXBsZS1FeGFtcGxlMRAwDgYDVQQH\nDAdFeGFtcGxlMRgwFgYDVQQKDA9FeGFtcGxlIENvbXBhbnkxFTATBgNVBAsMDEV4\nYW1wbGUgVW5pdDEVMBMGA1UEAwwMRXhhbXBsZSBVc2VyMSIwIAYJKoZIhvcNAQkB\nFhNleGFtcGxlQGV4YW1wbGUuY29tMB4XDTI1MTAwNjE0MTQwNVoXDTI2MTAwNjE0\nMTQwNVowgaUxCzAJBgNVBAYTAkNIMRgwFgYDVQQIDA9FeGFtcGxlLUV4YW1wbGUx\nEDAOBgNVBAcMB0V4YW1wbGUxGDAWBgNVBAoMD0V4YW1wbGUgQ29tcGFueTEVMBMG\nA1UECwwMRXhhbXBsZSBVbml0MRUwEwYDVQQDDAxFeGFtcGxlIFVzZXIxIjAgBgkq\nhkiG9w0BCQEWE2V4YW1wbGVAZXhhbXBsZS5jb20wXDANBgkqhkiG9w0BAQEFAANL\nADBIAkEArRf1nhlJYbdOdN7EvY4YlVGl4qsh85UK3MKa5ywnBHUqfMtsKCxx2TGN\nsrgpyyyxfH8uo5chrubHEgIBv7h6pwIDAQABMA0GCSqGSIb3DQEBCwUAA0EAj199\nvbnlFA++xZ4hI+WyAv7w/9OSu2uVfyQxeW06oYW2oKlmy3WrkVgyfM2QrGx/f7iB\nHRAks/MlZMXSyW0YsQ==\n-----END CERTIFICATE-----"}; // CertificateCreateDTO | 

        try {
            apiInstance.createCertificate(clientExtId, userExtId, certificateCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificateRESTServiceApi#createCertificate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final CertificateCreateDTO certificateCreateDTO = new CertificateCreateDTO(); // CertificateCreateDTO | 

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

import org.openapitools.client.api.CertificateRESTServiceApi;

public class CertificateRESTServiceApiExample {
    public static void main(String[] args) {
        CertificateRESTServiceApi apiInstance = new CertificateRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        CertificateCreateDTO certificateCreateDTO = {"extId":"4254","policyExtId":"104","stateName":"active","certificate":"-----BEGIN CERTIFICATE-----\nMIICSTCCAfMCFHf+gz+2mWrvXo0TZieIJtRCW+tLMA0GCSqGSIb3DQEBCwUAMIGl\nMQswCQYDVQQGEwJDSDEYMBYGA1UECAwPRXhhbXBsZS1FeGFtcGxlMRAwDgYDVQQH\nDAdFeGFtcGxlMRgwFgYDVQQKDA9FeGFtcGxlIENvbXBhbnkxFTATBgNVBAsMDEV4\nYW1wbGUgVW5pdDEVMBMGA1UEAwwMRXhhbXBsZSBVc2VyMSIwIAYJKoZIhvcNAQkB\nFhNleGFtcGxlQGV4YW1wbGUuY29tMB4XDTI1MTAwNjE0MTQwNVoXDTI2MTAwNjE0\nMTQwNVowgaUxCzAJBgNVBAYTAkNIMRgwFgYDVQQIDA9FeGFtcGxlLUV4YW1wbGUx\nEDAOBgNVBAcMB0V4YW1wbGUxGDAWBgNVBAoMD0V4YW1wbGUgQ29tcGFueTEVMBMG\nA1UECwwMRXhhbXBsZSBVbml0MRUwEwYDVQQDDAxFeGFtcGxlIFVzZXIxIjAgBgkq\nhkiG9w0BCQEWE2V4YW1wbGVAZXhhbXBsZS5jb20wXDANBgkqhkiG9w0BAQEFAANL\nADBIAkEArRf1nhlJYbdOdN7EvY4YlVGl4qsh85UK3MKa5ywnBHUqfMtsKCxx2TGN\nsrgpyyyxfH8uo5chrubHEgIBv7h6pwIDAQABMA0GCSqGSIb3DQEBCwUAA0EAj199\nvbnlFA++xZ4hI+WyAv7w/9OSu2uVfyQxeW06oYW2oKlmy3WrkVgyfM2QrGx/f7iB\nHRAks/MlZMXSyW0YsQ==\n-----END CERTIFICATE-----"}; // CertificateCreateDTO | 

        try {
            apiInstance.createCertificate(clientExtId, userExtId, certificateCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificateRESTServiceApi#createCertificate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CertificateRESTServiceApi *apiInstance = [[CertificateRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
CertificateCreateDTO *certificateCreateDTO = {"extId":"4254","policyExtId":"104","stateName":"active","certificate":"-----BEGIN CERTIFICATE-----\nMIICSTCCAfMCFHf+gz+2mWrvXo0TZieIJtRCW+tLMA0GCSqGSIb3DQEBCwUAMIGl\nMQswCQYDVQQGEwJDSDEYMBYGA1UECAwPRXhhbXBsZS1FeGFtcGxlMRAwDgYDVQQH\nDAdFeGFtcGxlMRgwFgYDVQQKDA9FeGFtcGxlIENvbXBhbnkxFTATBgNVBAsMDEV4\nYW1wbGUgVW5pdDEVMBMGA1UEAwwMRXhhbXBsZSBVc2VyMSIwIAYJKoZIhvcNAQkB\nFhNleGFtcGxlQGV4YW1wbGUuY29tMB4XDTI1MTAwNjE0MTQwNVoXDTI2MTAwNjE0\nMTQwNVowgaUxCzAJBgNVBAYTAkNIMRgwFgYDVQQIDA9FeGFtcGxlLUV4YW1wbGUx\nEDAOBgNVBAcMB0V4YW1wbGUxGDAWBgNVBAoMD0V4YW1wbGUgQ29tcGFueTEVMBMG\nA1UECwwMRXhhbXBsZSBVbml0MRUwEwYDVQQDDAxFeGFtcGxlIFVzZXIxIjAgBgkq\nhkiG9w0BCQEWE2V4YW1wbGVAZXhhbXBsZS5jb20wXDANBgkqhkiG9w0BAQEFAANL\nADBIAkEArRf1nhlJYbdOdN7EvY4YlVGl4qsh85UK3MKa5ywnBHUqfMtsKCxx2TGN\nsrgpyyyxfH8uo5chrubHEgIBv7h6pwIDAQABMA0GCSqGSIb3DQEBCwUAA0EAj199\nvbnlFA++xZ4hI+WyAv7w/9OSu2uVfyQxeW06oYW2oKlmy3WrkVgyfM2QrGx/f7iB\nHRAks/MlZMXSyW0YsQ==\n-----END CERTIFICATE-----"}; // 

// Create certificate
[apiInstance createCertificateWith:clientExtId
    userExtId:userExtId
    certificateCreateDTO:certificateCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.CertificateRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var certificateCreateDTO = {"extId":"4254","policyExtId":"104","stateName":"active","certificate":"-----BEGIN CERTIFICATE-----\nMIICSTCCAfMCFHf+gz+2mWrvXo0TZieIJtRCW+tLMA0GCSqGSIb3DQEBCwUAMIGl\nMQswCQYDVQQGEwJDSDEYMBYGA1UECAwPRXhhbXBsZS1FeGFtcGxlMRAwDgYDVQQH\nDAdFeGFtcGxlMRgwFgYDVQQKDA9FeGFtcGxlIENvbXBhbnkxFTATBgNVBAsMDEV4\nYW1wbGUgVW5pdDEVMBMGA1UEAwwMRXhhbXBsZSBVc2VyMSIwIAYJKoZIhvcNAQkB\nFhNleGFtcGxlQGV4YW1wbGUuY29tMB4XDTI1MTAwNjE0MTQwNVoXDTI2MTAwNjE0\nMTQwNVowgaUxCzAJBgNVBAYTAkNIMRgwFgYDVQQIDA9FeGFtcGxlLUV4YW1wbGUx\nEDAOBgNVBAcMB0V4YW1wbGUxGDAWBgNVBAoMD0V4YW1wbGUgQ29tcGFueTEVMBMG\nA1UECwwMRXhhbXBsZSBVbml0MRUwEwYDVQQDDAxFeGFtcGxlIFVzZXIxIjAgBgkq\nhkiG9w0BCQEWE2V4YW1wbGVAZXhhbXBsZS5jb20wXDANBgkqhkiG9w0BAQEFAANL\nADBIAkEArRf1nhlJYbdOdN7EvY4YlVGl4qsh85UK3MKa5ywnBHUqfMtsKCxx2TGN\nsrgpyyyxfH8uo5chrubHEgIBv7h6pwIDAQABMA0GCSqGSIb3DQEBCwUAA0EAj199\nvbnlFA++xZ4hI+WyAv7w/9OSu2uVfyQxeW06oYW2oKlmy3WrkVgyfM2QrGx/f7iB\nHRAks/MlZMXSyW0YsQ==\n-----END CERTIFICATE-----"}; // {CertificateCreateDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new CertificateRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var certificateCreateDTO = new CertificateCreateDTO(); // CertificateCreateDTO | 

            try {
                // Create certificate
                apiInstance.createCertificate(clientExtId, userExtId, certificateCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling CertificateRESTServiceApi.createCertificate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CertificateRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$certificateCreateDTO = {"extId":"4254","policyExtId":"104","stateName":"active","certificate":"-----BEGIN CERTIFICATE-----\nMIICSTCCAfMCFHf+gz+2mWrvXo0TZieIJtRCW+tLMA0GCSqGSIb3DQEBCwUAMIGl\nMQswCQYDVQQGEwJDSDEYMBYGA1UECAwPRXhhbXBsZS1FeGFtcGxlMRAwDgYDVQQH\nDAdFeGFtcGxlMRgwFgYDVQQKDA9FeGFtcGxlIENvbXBhbnkxFTATBgNVBAsMDEV4\nYW1wbGUgVW5pdDEVMBMGA1UEAwwMRXhhbXBsZSBVc2VyMSIwIAYJKoZIhvcNAQkB\nFhNleGFtcGxlQGV4YW1wbGUuY29tMB4XDTI1MTAwNjE0MTQwNVoXDTI2MTAwNjE0\nMTQwNVowgaUxCzAJBgNVBAYTAkNIMRgwFgYDVQQIDA9FeGFtcGxlLUV4YW1wbGUx\nEDAOBgNVBAcMB0V4YW1wbGUxGDAWBgNVBAoMD0V4YW1wbGUgQ29tcGFueTEVMBMG\nA1UECwwMRXhhbXBsZSBVbml0MRUwEwYDVQQDDAxFeGFtcGxlIFVzZXIxIjAgBgkq\nhkiG9w0BCQEWE2V4YW1wbGVAZXhhbXBsZS5jb20wXDANBgkqhkiG9w0BAQEFAANL\nADBIAkEArRf1nhlJYbdOdN7EvY4YlVGl4qsh85UK3MKa5ywnBHUqfMtsKCxx2TGN\nsrgpyyyxfH8uo5chrubHEgIBv7h6pwIDAQABMA0GCSqGSIb3DQEBCwUAA0EAj199\nvbnlFA++xZ4hI+WyAv7w/9OSu2uVfyQxeW06oYW2oKlmy3WrkVgyfM2QrGx/f7iB\nHRAks/MlZMXSyW0YsQ==\n-----END CERTIFICATE-----"}; // CertificateCreateDTO | 

try {
    $api_instance->createCertificate($clientExtId, $userExtId, $certificateCreateDTO);
} catch (Exception $e) {
    echo 'Exception when calling CertificateRESTServiceApi->createCertificate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CertificateRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CertificateRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $certificateCreateDTO = WWW::OPenAPIClient::Object::CertificateCreateDTO->new(); # CertificateCreateDTO | 

eval {
    $api_instance->createCertificate(clientExtId => $clientExtId, userExtId => $userExtId, certificateCreateDTO => $certificateCreateDTO);
};
if ($@) {
    warn "Exception when calling CertificateRESTServiceApi->createCertificate: $@\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.CertificateRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
certificateCreateDTO = {"extId":"4254","policyExtId":"104","stateName":"active","certificate":"-----BEGIN CERTIFICATE-----\nMIICSTCCAfMCFHf+gz+2mWrvXo0TZieIJtRCW+tLMA0GCSqGSIb3DQEBCwUAMIGl\nMQswCQYDVQQGEwJDSDEYMBYGA1UECAwPRXhhbXBsZS1FeGFtcGxlMRAwDgYDVQQH\nDAdFeGFtcGxlMRgwFgYDVQQKDA9FeGFtcGxlIENvbXBhbnkxFTATBgNVBAsMDEV4\nYW1wbGUgVW5pdDEVMBMGA1UEAwwMRXhhbXBsZSBVc2VyMSIwIAYJKoZIhvcNAQkB\nFhNleGFtcGxlQGV4YW1wbGUuY29tMB4XDTI1MTAwNjE0MTQwNVoXDTI2MTAwNjE0\nMTQwNVowgaUxCzAJBgNVBAYTAkNIMRgwFgYDVQQIDA9FeGFtcGxlLUV4YW1wbGUx\nEDAOBgNVBAcMB0V4YW1wbGUxGDAWBgNVBAoMD0V4YW1wbGUgQ29tcGFueTEVMBMG\nA1UECwwMRXhhbXBsZSBVbml0MRUwEwYDVQQDDAxFeGFtcGxlIFVzZXIxIjAgBgkq\nhkiG9w0BCQEWE2V4YW1wbGVAZXhhbXBsZS5jb20wXDANBgkqhkiG9w0BAQEFAANL\nADBIAkEArRf1nhlJYbdOdN7EvY4YlVGl4qsh85UK3MKa5ywnBHUqfMtsKCxx2TGN\nsrgpyyyxfH8uo5chrubHEgIBv7h6pwIDAQABMA0GCSqGSIb3DQEBCwUAA0EAj199\nvbnlFA++xZ4hI+WyAv7w/9OSu2uVfyQxeW06oYW2oKlmy3WrkVgyfM2QrGx/f7iB\nHRAks/MlZMXSyW0YsQ==\n-----END CERTIFICATE-----"} # CertificateCreateDTO | 

try:
    # Create certificate
    api_instance.create_certificate(clientExtId, userExtId, certificateCreateDTO)
except ApiException as e:
    print("Exception when calling CertificateRESTServiceApi->createCertificate: %s\n" % e)
extern crate CertificateRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let certificateCreateDTO = {"extId":"4254","policyExtId":"104","stateName":"active","certificate":"-----BEGIN CERTIFICATE-----\nMIICSTCCAfMCFHf+gz+2mWrvXo0TZieIJtRCW+tLMA0GCSqGSIb3DQEBCwUAMIGl\nMQswCQYDVQQGEwJDSDEYMBYGA1UECAwPRXhhbXBsZS1FeGFtcGxlMRAwDgYDVQQH\nDAdFeGFtcGxlMRgwFgYDVQQKDA9FeGFtcGxlIENvbXBhbnkxFTATBgNVBAsMDEV4\nYW1wbGUgVW5pdDEVMBMGA1UEAwwMRXhhbXBsZSBVc2VyMSIwIAYJKoZIhvcNAQkB\nFhNleGFtcGxlQGV4YW1wbGUuY29tMB4XDTI1MTAwNjE0MTQwNVoXDTI2MTAwNjE0\nMTQwNVowgaUxCzAJBgNVBAYTAkNIMRgwFgYDVQQIDA9FeGFtcGxlLUV4YW1wbGUx\nEDAOBgNVBAcMB0V4YW1wbGUxGDAWBgNVBAoMD0V4YW1wbGUgQ29tcGFueTEVMBMG\nA1UECwwMRXhhbXBsZSBVbml0MRUwEwYDVQQDDAxFeGFtcGxlIFVzZXIxIjAgBgkq\nhkiG9w0BCQEWE2V4YW1wbGVAZXhhbXBsZS5jb20wXDANBgkqhkiG9w0BAQEFAANL\nADBIAkEArRf1nhlJYbdOdN7EvY4YlVGl4qsh85UK3MKa5ywnBHUqfMtsKCxx2TGN\nsrgpyyyxfH8uo5chrubHEgIBv7h6pwIDAQABMA0GCSqGSIb3DQEBCwUAA0EAj199\nvbnlFA++xZ4hI+WyAv7w/9OSu2uVfyQxeW06oYW2oKlmy3WrkVgyfM2QrGx/f7iB\nHRAks/MlZMXSyW0YsQ==\n-----END CERTIFICATE-----"}; // CertificateCreateDTO

    let mut context = CertificateRESTServiceApi::Context::default();
    let result = client.createCertificate(clientExtId, userExtId, certificateCreateDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
certificateCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

deleteCertificate

deleteCertificate
delete/core/v1/{clientExtId}/users/{userExtId}/certificates/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.CredentialDelete` or `SelfAdmin` Role Deletes the certificate credential with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/certificates/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CertificateRESTServiceApi;

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

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

        // Create an instance of the API class
        CertificateRESTServiceApi apiInstance = new CertificateRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000033; // String | ExtID of the certificate credential

        try {
            apiInstance.deleteCertificate(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificateRESTServiceApi#deleteCertificate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the certificate credential

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

import org.openapitools.client.api.CertificateRESTServiceApi;

public class CertificateRESTServiceApiExample {
    public static void main(String[] args) {
        CertificateRESTServiceApi apiInstance = new CertificateRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000033; // String | ExtID of the certificate credential

        try {
            apiInstance.deleteCertificate(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificateRESTServiceApi#deleteCertificate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CertificateRESTServiceApi *apiInstance = [[CertificateRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000033; // ExtID of the certificate credential (default to null)

// Delete certificate
[apiInstance deleteCertificateWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.CertificateRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000033; // {String} ExtID of the certificate credential

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

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

            // Create an instance of the API class
            var apiInstance = new CertificateRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000033;  // String | ExtID of the certificate credential (default to null)

            try {
                // Delete certificate
                apiInstance.deleteCertificate(clientExtId, userExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling CertificateRESTServiceApi.deleteCertificate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CertificateRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000033; // String | ExtID of the certificate credential

try {
    $api_instance->deleteCertificate($clientExtId, $userExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling CertificateRESTServiceApi->deleteCertificate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CertificateRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CertificateRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000033; # String | ExtID of the certificate credential

eval {
    $api_instance->deleteCertificate(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling CertificateRESTServiceApi->deleteCertificate: $@\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.CertificateRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000033 # String | ExtID of the certificate credential (default to null)

try:
    # Delete certificate
    api_instance.delete_certificate(clientExtId, userExtId, extId)
except ApiException as e:
    print("Exception when calling CertificateRESTServiceApi->deleteCertificate: %s\n" % e)
extern crate CertificateRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000033; // String

    let mut context = CertificateRESTServiceApi::Context::default();
    let result = client.deleteCertificate(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the certificate credential
Required

Responses


getAllCertificates

getAllCertificates
get/core/v1/{clientExtId}/users/{userExtId}/certificates

**Since:** 2.71.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns all certificate credentials of the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/certificates?continuationToken=continuationToken_example&limit=1000"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CertificateRESTServiceApi;

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

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

        // Create an instance of the API class
        CertificateRESTServiceApi apiInstance = new CertificateRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForCertificateInfoGetDTO result = apiInstance.getAllCertificates(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificateRESTServiceApi#getAllCertificates");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

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

import org.openapitools.client.api.CertificateRESTServiceApi;

public class CertificateRESTServiceApiExample {
    public static void main(String[] args) {
        CertificateRESTServiceApi apiInstance = new CertificateRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForCertificateInfoGetDTO result = apiInstance.getAllCertificates(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificateRESTServiceApi#getAllCertificates");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CertificateRESTServiceApi *apiInstance = [[CertificateRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 1000; // Pagination limit (optional) (default to 0)

// Get all certificates
[apiInstance getAllCertificatesWith:clientExtId
    userExtId:userExtId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForCertificateInfoGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.CertificateRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 1000 // {Integer} Pagination limit
};

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

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

            // Create an instance of the API class
            var apiInstance = new CertificateRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 1000;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get all certificates
                ItemsWrapperForCertificateInfoGetDTO result = apiInstance.getAllCertificates(clientExtId, userExtId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CertificateRESTServiceApi.getAllCertificates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CertificateRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 1000; // Integer | Pagination limit

try {
    $result = $api_instance->getAllCertificates($clientExtId, $userExtId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CertificateRESTServiceApi->getAllCertificates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CertificateRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CertificateRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 1000; # Integer | Pagination limit

eval {
    my $result = $api_instance->getAllCertificates(clientExtId => $clientExtId, userExtId => $userExtId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CertificateRESTServiceApi->getAllCertificates: $@\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.CertificateRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 1000 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get all certificates
    api_response = api_instance.get_all_certificates(clientExtId, userExtId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CertificateRESTServiceApi->getAllCertificates: %s\n" % e)
extern crate CertificateRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let continuationToken = continuationToken_example; // String
    let limit = 1000; // Integer

    let mut context = CertificateRESTServiceApi::Context::default();
    let result = client.getAllCertificates(clientExtId, userExtId, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


getCertificate

getCertificate
get/core/v1/{clientExtId}/users/{userExtId}/certificates/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns the certificate credential with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/certificates/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CertificateRESTServiceApi;

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

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

        // Create an instance of the API class
        CertificateRESTServiceApi apiInstance = new CertificateRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000033; // String | ExtID of the certificate credential

        try {
            CertificateGetDTO result = apiInstance.getCertificate(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificateRESTServiceApi#getCertificate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the certificate credential

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

import org.openapitools.client.api.CertificateRESTServiceApi;

public class CertificateRESTServiceApiExample {
    public static void main(String[] args) {
        CertificateRESTServiceApi apiInstance = new CertificateRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000033; // String | ExtID of the certificate credential

        try {
            CertificateGetDTO result = apiInstance.getCertificate(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificateRESTServiceApi#getCertificate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CertificateRESTServiceApi *apiInstance = [[CertificateRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000033; // ExtID of the certificate credential (default to null)

// Get certificate
[apiInstance getCertificateWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(CertificateGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.CertificateRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000033; // {String} ExtID of the certificate credential

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

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

            // Create an instance of the API class
            var apiInstance = new CertificateRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000033;  // String | ExtID of the certificate credential (default to null)

            try {
                // Get certificate
                CertificateGetDTO result = apiInstance.getCertificate(clientExtId, userExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CertificateRESTServiceApi.getCertificate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CertificateRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000033; // String | ExtID of the certificate credential

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CertificateRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000033; # String | ExtID of the certificate credential

eval {
    my $result = $api_instance->getCertificate(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CertificateRESTServiceApi->getCertificate: $@\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.CertificateRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000033 # String | ExtID of the certificate credential (default to null)

try:
    # Get certificate
    api_response = api_instance.get_certificate(clientExtId, userExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CertificateRESTServiceApi->getCertificate: %s\n" % e)
extern crate CertificateRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000033; // String

    let mut context = CertificateRESTServiceApi::Context::default();
    let result = client.getCertificate(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the certificate credential
Required

Responses


getCertificateProperties

getCertificateProperties
get/core/v1/{clientExtId}/users/{userExtId}/certificates/{extId}/properties

**Since:** 2.73.0 **Required permission(s):** `AccessControl.CredentialView,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView` Returns all properties of the certificate credential with the given external ID, as an object of key-value pairs.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/certificates/{extId}/properties"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CertificateRESTServiceApi;

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

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

        // Create an instance of the API class
        CertificateRESTServiceApi apiInstance = new CertificateRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000033; // String | ExtID of the certificate credential

        try {
            map['String', 'String'] result = apiInstance.getCertificateProperties(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificateRESTServiceApi#getCertificateProperties");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the certificate credential

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

import org.openapitools.client.api.CertificateRESTServiceApi;

public class CertificateRESTServiceApiExample {
    public static void main(String[] args) {
        CertificateRESTServiceApi apiInstance = new CertificateRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000033; // String | ExtID of the certificate credential

        try {
            map['String', 'String'] result = apiInstance.getCertificateProperties(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificateRESTServiceApi#getCertificateProperties");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CertificateRESTServiceApi *apiInstance = [[CertificateRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000033; // ExtID of the certificate credential (default to null)

// Get certificate properties
[apiInstance getCertificatePropertiesWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.CertificateRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000033; // {String} ExtID of the certificate credential

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

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

            // Create an instance of the API class
            var apiInstance = new CertificateRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000033;  // String | ExtID of the certificate credential (default to null)

            try {
                // Get certificate properties
                map['String', 'String'] result = apiInstance.getCertificateProperties(clientExtId, userExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CertificateRESTServiceApi.getCertificateProperties: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CertificateRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000033; // String | ExtID of the certificate credential

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CertificateRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000033; # String | ExtID of the certificate credential

eval {
    my $result = $api_instance->getCertificateProperties(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CertificateRESTServiceApi->getCertificateProperties: $@\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.CertificateRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000033 # String | ExtID of the certificate credential (default to null)

try:
    # Get certificate properties
    api_response = api_instance.get_certificate_properties(clientExtId, userExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CertificateRESTServiceApi->getCertificateProperties: %s\n" % e)
extern crate CertificateRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000033; // String

    let mut context = CertificateRESTServiceApi::Context::default();
    let result = client.getCertificateProperties(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the certificate credential
Required

Responses


patchCertificate

patchCertificate
patch/core/v1/{clientExtId}/users/{userExtId}/certificates/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.CredentialModify,AccessControl.CredentialView` or `SelfAdmin` Role Updates the certificate credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/certificates/{extId}" \
 -d '{
  "stateName" : "INITIAL",
  "modificationComment" : "modificationComment",
  "certificate" : "certificate",
  "version" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CertificateRESTServiceApi;

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

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

        // Create an instance of the API class
        CertificateRESTServiceApi apiInstance = new CertificateRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000033; // String | ExtID of the certificate credential
        CertificatePatchDTO certificatePatchDTO = {
    "certificate": "-----BEGIN CERTIFICATE-----\nMIICSTCCAfMCFHf+gz+2mWrvXo0TZieIJtRCW\n+tLMA0GCSqGSIb3DQEBCwUAMIGl\nMQswCQYDVQQGEwJDSDEYMBYGA1UECAwPRXhhbXBsZS1FeGFtcGxlMRAwDgYDVQQH\nDAdFeGFtcGxlMRgwFgYDVQQKDA9FeGFtcGxlIENvbXBhbnkxFTATBgNVBAsMDEV4\nYW1wbGUgVW5pdDEVMBMGA1UEAwwMRXhhbXBsZSBVc2VyMSIwIAYJKoZIhvcNAQkB\nFhNleGFtcGxlQGV4YW1wbGUuY29tMB4XDTI1MTAwNjE0MTQwNVoXDTI2MTAwNjE0\nMTQwNVowgaUxCzAJBgNVBAYTAkNIMRgwFgYDVQQIDA9FeGFtcGxlLUV4YW1wbGUx\nEDAOBgNVBAcMB0V4YW1wbGUxGDAWBgNVBAoMD0V4YW1wbGUgQ29tcGFueTEVMBMG\nA1UECwwMRXhhbXBsZSBVbml0MRUwEwYDVQQDDAxFeGFtcGxlIFVzZXIxIjAgBgkq\nhkiG9w0BCQEWE2V4YW1wbGVAZXhhbXBsZS5jb20wXDANBgkqhkiG9w0BAQEFAANL\nADBIAkEArRf1nhlJYbdOdN7EvY4YlVGl4qsh85UK3MKa5ywnBHUqfMtsKCxx2TGN\nsrgpyyyxfH8uo5chrubHEgIBv7h6pwIDAQABMA0GCSqGSIb3DQEBCwUAA0EAj199\nvbnlFA++xZ4hI+WyAv7w/9OSu2uVfyQxeW06oYW2oKlmy3WrkVgyfM2QrGx/f7iB\nHRAks/MlZMXSyW0YsQ==\n-----END CERTIFICATE-----",
    "stateName": "active",
    "modificationComment": "changed-by-admin"
    "version": 5
}
; // CertificatePatchDTO | 

        try {
            CertificateGetDTO result = apiInstance.patchCertificate(clientExtId, userExtId, extId, certificatePatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificateRESTServiceApi#patchCertificate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the certificate credential
final CertificatePatchDTO certificatePatchDTO = new CertificatePatchDTO(); // CertificatePatchDTO | 

try {
    final result = await api_instance.patchCertificate(clientExtId, userExtId, extId, certificatePatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchCertificate: $e\n');
}

import org.openapitools.client.api.CertificateRESTServiceApi;

public class CertificateRESTServiceApiExample {
    public static void main(String[] args) {
        CertificateRESTServiceApi apiInstance = new CertificateRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000033; // String | ExtID of the certificate credential
        CertificatePatchDTO certificatePatchDTO = {
    "certificate": "-----BEGIN CERTIFICATE-----\nMIICSTCCAfMCFHf+gz+2mWrvXo0TZieIJtRCW\n+tLMA0GCSqGSIb3DQEBCwUAMIGl\nMQswCQYDVQQGEwJDSDEYMBYGA1UECAwPRXhhbXBsZS1FeGFtcGxlMRAwDgYDVQQH\nDAdFeGFtcGxlMRgwFgYDVQQKDA9FeGFtcGxlIENvbXBhbnkxFTATBgNVBAsMDEV4\nYW1wbGUgVW5pdDEVMBMGA1UEAwwMRXhhbXBsZSBVc2VyMSIwIAYJKoZIhvcNAQkB\nFhNleGFtcGxlQGV4YW1wbGUuY29tMB4XDTI1MTAwNjE0MTQwNVoXDTI2MTAwNjE0\nMTQwNVowgaUxCzAJBgNVBAYTAkNIMRgwFgYDVQQIDA9FeGFtcGxlLUV4YW1wbGUx\nEDAOBgNVBAcMB0V4YW1wbGUxGDAWBgNVBAoMD0V4YW1wbGUgQ29tcGFueTEVMBMG\nA1UECwwMRXhhbXBsZSBVbml0MRUwEwYDVQQDDAxFeGFtcGxlIFVzZXIxIjAgBgkq\nhkiG9w0BCQEWE2V4YW1wbGVAZXhhbXBsZS5jb20wXDANBgkqhkiG9w0BAQEFAANL\nADBIAkEArRf1nhlJYbdOdN7EvY4YlVGl4qsh85UK3MKa5ywnBHUqfMtsKCxx2TGN\nsrgpyyyxfH8uo5chrubHEgIBv7h6pwIDAQABMA0GCSqGSIb3DQEBCwUAA0EAj199\nvbnlFA++xZ4hI+WyAv7w/9OSu2uVfyQxeW06oYW2oKlmy3WrkVgyfM2QrGx/f7iB\nHRAks/MlZMXSyW0YsQ==\n-----END CERTIFICATE-----",
    "stateName": "active",
    "modificationComment": "changed-by-admin"
    "version": 5
}
; // CertificatePatchDTO | 

        try {
            CertificateGetDTO result = apiInstance.patchCertificate(clientExtId, userExtId, extId, certificatePatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificateRESTServiceApi#patchCertificate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CertificateRESTServiceApi *apiInstance = [[CertificateRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000033; // ExtID of the certificate credential (default to null)
CertificatePatchDTO *certificatePatchDTO = {
    "certificate": "-----BEGIN CERTIFICATE-----\nMIICSTCCAfMCFHf+gz+2mWrvXo0TZieIJtRCW\n+tLMA0GCSqGSIb3DQEBCwUAMIGl\nMQswCQYDVQQGEwJDSDEYMBYGA1UECAwPRXhhbXBsZS1FeGFtcGxlMRAwDgYDVQQH\nDAdFeGFtcGxlMRgwFgYDVQQKDA9FeGFtcGxlIENvbXBhbnkxFTATBgNVBAsMDEV4\nYW1wbGUgVW5pdDEVMBMGA1UEAwwMRXhhbXBsZSBVc2VyMSIwIAYJKoZIhvcNAQkB\nFhNleGFtcGxlQGV4YW1wbGUuY29tMB4XDTI1MTAwNjE0MTQwNVoXDTI2MTAwNjE0\nMTQwNVowgaUxCzAJBgNVBAYTAkNIMRgwFgYDVQQIDA9FeGFtcGxlLUV4YW1wbGUx\nEDAOBgNVBAcMB0V4YW1wbGUxGDAWBgNVBAoMD0V4YW1wbGUgQ29tcGFueTEVMBMG\nA1UECwwMRXhhbXBsZSBVbml0MRUwEwYDVQQDDAxFeGFtcGxlIFVzZXIxIjAgBgkq\nhkiG9w0BCQEWE2V4YW1wbGVAZXhhbXBsZS5jb20wXDANBgkqhkiG9w0BAQEFAANL\nADBIAkEArRf1nhlJYbdOdN7EvY4YlVGl4qsh85UK3MKa5ywnBHUqfMtsKCxx2TGN\nsrgpyyyxfH8uo5chrubHEgIBv7h6pwIDAQABMA0GCSqGSIb3DQEBCwUAA0EAj199\nvbnlFA++xZ4hI+WyAv7w/9OSu2uVfyQxeW06oYW2oKlmy3WrkVgyfM2QrGx/f7iB\nHRAks/MlZMXSyW0YsQ==\n-----END CERTIFICATE-----",
    "stateName": "active",
    "modificationComment": "changed-by-admin"
    "version": 5
}
; // 

// Update certificate
[apiInstance patchCertificateWith:clientExtId
    userExtId:userExtId
    extId:extId
    certificatePatchDTO:certificatePatchDTO
              completionHandler: ^(CertificateGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.CertificateRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000033; // {String} ExtID of the certificate credential
var certificatePatchDTO = {
    "certificate": "-----BEGIN CERTIFICATE-----\nMIICSTCCAfMCFHf+gz+2mWrvXo0TZieIJtRCW\n+tLMA0GCSqGSIb3DQEBCwUAMIGl\nMQswCQYDVQQGEwJDSDEYMBYGA1UECAwPRXhhbXBsZS1FeGFtcGxlMRAwDgYDVQQH\nDAdFeGFtcGxlMRgwFgYDVQQKDA9FeGFtcGxlIENvbXBhbnkxFTATBgNVBAsMDEV4\nYW1wbGUgVW5pdDEVMBMGA1UEAwwMRXhhbXBsZSBVc2VyMSIwIAYJKoZIhvcNAQkB\nFhNleGFtcGxlQGV4YW1wbGUuY29tMB4XDTI1MTAwNjE0MTQwNVoXDTI2MTAwNjE0\nMTQwNVowgaUxCzAJBgNVBAYTAkNIMRgwFgYDVQQIDA9FeGFtcGxlLUV4YW1wbGUx\nEDAOBgNVBAcMB0V4YW1wbGUxGDAWBgNVBAoMD0V4YW1wbGUgQ29tcGFueTEVMBMG\nA1UECwwMRXhhbXBsZSBVbml0MRUwEwYDVQQDDAxFeGFtcGxlIFVzZXIxIjAgBgkq\nhkiG9w0BCQEWE2V4YW1wbGVAZXhhbXBsZS5jb20wXDANBgkqhkiG9w0BAQEFAANL\nADBIAkEArRf1nhlJYbdOdN7EvY4YlVGl4qsh85UK3MKa5ywnBHUqfMtsKCxx2TGN\nsrgpyyyxfH8uo5chrubHEgIBv7h6pwIDAQABMA0GCSqGSIb3DQEBCwUAA0EAj199\nvbnlFA++xZ4hI+WyAv7w/9OSu2uVfyQxeW06oYW2oKlmy3WrkVgyfM2QrGx/f7iB\nHRAks/MlZMXSyW0YsQ==\n-----END CERTIFICATE-----",
    "stateName": "active",
    "modificationComment": "changed-by-admin"
    "version": 5
}
; // {CertificatePatchDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new CertificateRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000033;  // String | ExtID of the certificate credential (default to null)
            var certificatePatchDTO = new CertificatePatchDTO(); // CertificatePatchDTO | 

            try {
                // Update certificate
                CertificateGetDTO result = apiInstance.patchCertificate(clientExtId, userExtId, extId, certificatePatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CertificateRESTServiceApi.patchCertificate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CertificateRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000033; // String | ExtID of the certificate credential
$certificatePatchDTO = {
    "certificate": "-----BEGIN CERTIFICATE-----\nMIICSTCCAfMCFHf+gz+2mWrvXo0TZieIJtRCW\n+tLMA0GCSqGSIb3DQEBCwUAMIGl\nMQswCQYDVQQGEwJDSDEYMBYGA1UECAwPRXhhbXBsZS1FeGFtcGxlMRAwDgYDVQQH\nDAdFeGFtcGxlMRgwFgYDVQQKDA9FeGFtcGxlIENvbXBhbnkxFTATBgNVBAsMDEV4\nYW1wbGUgVW5pdDEVMBMGA1UEAwwMRXhhbXBsZSBVc2VyMSIwIAYJKoZIhvcNAQkB\nFhNleGFtcGxlQGV4YW1wbGUuY29tMB4XDTI1MTAwNjE0MTQwNVoXDTI2MTAwNjE0\nMTQwNVowgaUxCzAJBgNVBAYTAkNIMRgwFgYDVQQIDA9FeGFtcGxlLUV4YW1wbGUx\nEDAOBgNVBAcMB0V4YW1wbGUxGDAWBgNVBAoMD0V4YW1wbGUgQ29tcGFueTEVMBMG\nA1UECwwMRXhhbXBsZSBVbml0MRUwEwYDVQQDDAxFeGFtcGxlIFVzZXIxIjAgBgkq\nhkiG9w0BCQEWE2V4YW1wbGVAZXhhbXBsZS5jb20wXDANBgkqhkiG9w0BAQEFAANL\nADBIAkEArRf1nhlJYbdOdN7EvY4YlVGl4qsh85UK3MKa5ywnBHUqfMtsKCxx2TGN\nsrgpyyyxfH8uo5chrubHEgIBv7h6pwIDAQABMA0GCSqGSIb3DQEBCwUAA0EAj199\nvbnlFA++xZ4hI+WyAv7w/9OSu2uVfyQxeW06oYW2oKlmy3WrkVgyfM2QrGx/f7iB\nHRAks/MlZMXSyW0YsQ==\n-----END CERTIFICATE-----",
    "stateName": "active",
    "modificationComment": "changed-by-admin"
    "version": 5
}
; // CertificatePatchDTO | 

try {
    $result = $api_instance->patchCertificate($clientExtId, $userExtId, $extId, $certificatePatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CertificateRESTServiceApi->patchCertificate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CertificateRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CertificateRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000033; # String | ExtID of the certificate credential
my $certificatePatchDTO = WWW::OPenAPIClient::Object::CertificatePatchDTO->new(); # CertificatePatchDTO | 

eval {
    my $result = $api_instance->patchCertificate(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId, certificatePatchDTO => $certificatePatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CertificateRESTServiceApi->patchCertificate: $@\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.CertificateRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000033 # String | ExtID of the certificate credential (default to null)
certificatePatchDTO = {
    "certificate": "-----BEGIN CERTIFICATE-----\nMIICSTCCAfMCFHf+gz+2mWrvXo0TZieIJtRCW\n+tLMA0GCSqGSIb3DQEBCwUAMIGl\nMQswCQYDVQQGEwJDSDEYMBYGA1UECAwPRXhhbXBsZS1FeGFtcGxlMRAwDgYDVQQH\nDAdFeGFtcGxlMRgwFgYDVQQKDA9FeGFtcGxlIENvbXBhbnkxFTATBgNVBAsMDEV4\nYW1wbGUgVW5pdDEVMBMGA1UEAwwMRXhhbXBsZSBVc2VyMSIwIAYJKoZIhvcNAQkB\nFhNleGFtcGxlQGV4YW1wbGUuY29tMB4XDTI1MTAwNjE0MTQwNVoXDTI2MTAwNjE0\nMTQwNVowgaUxCzAJBgNVBAYTAkNIMRgwFgYDVQQIDA9FeGFtcGxlLUV4YW1wbGUx\nEDAOBgNVBAcMB0V4YW1wbGUxGDAWBgNVBAoMD0V4YW1wbGUgQ29tcGFueTEVMBMG\nA1UECwwMRXhhbXBsZSBVbml0MRUwEwYDVQQDDAxFeGFtcGxlIFVzZXIxIjAgBgkq\nhkiG9w0BCQEWE2V4YW1wbGVAZXhhbXBsZS5jb20wXDANBgkqhkiG9w0BAQEFAANL\nADBIAkEArRf1nhlJYbdOdN7EvY4YlVGl4qsh85UK3MKa5ywnBHUqfMtsKCxx2TGN\nsrgpyyyxfH8uo5chrubHEgIBv7h6pwIDAQABMA0GCSqGSIb3DQEBCwUAA0EAj199\nvbnlFA++xZ4hI+WyAv7w/9OSu2uVfyQxeW06oYW2oKlmy3WrkVgyfM2QrGx/f7iB\nHRAks/MlZMXSyW0YsQ==\n-----END CERTIFICATE-----",
    "stateName": "active",
    "modificationComment": "changed-by-admin"
    "version": 5
}
 # CertificatePatchDTO | 

try:
    # Update certificate
    api_response = api_instance.patch_certificate(clientExtId, userExtId, extId, certificatePatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CertificateRESTServiceApi->patchCertificate: %s\n" % e)
extern crate CertificateRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000033; // String
    let certificatePatchDTO = {
    "certificate": "-----BEGIN CERTIFICATE-----\nMIICSTCCAfMCFHf+gz+2mWrvXo0TZieIJtRCW\n+tLMA0GCSqGSIb3DQEBCwUAMIGl\nMQswCQYDVQQGEwJDSDEYMBYGA1UECAwPRXhhbXBsZS1FeGFtcGxlMRAwDgYDVQQH\nDAdFeGFtcGxlMRgwFgYDVQQKDA9FeGFtcGxlIENvbXBhbnkxFTATBgNVBAsMDEV4\nYW1wbGUgVW5pdDEVMBMGA1UEAwwMRXhhbXBsZSBVc2VyMSIwIAYJKoZIhvcNAQkB\nFhNleGFtcGxlQGV4YW1wbGUuY29tMB4XDTI1MTAwNjE0MTQwNVoXDTI2MTAwNjE0\nMTQwNVowgaUxCzAJBgNVBAYTAkNIMRgwFgYDVQQIDA9FeGFtcGxlLUV4YW1wbGUx\nEDAOBgNVBAcMB0V4YW1wbGUxGDAWBgNVBAoMD0V4YW1wbGUgQ29tcGFueTEVMBMG\nA1UECwwMRXhhbXBsZSBVbml0MRUwEwYDVQQDDAxFeGFtcGxlIFVzZXIxIjAgBgkq\nhkiG9w0BCQEWE2V4YW1wbGVAZXhhbXBsZS5jb20wXDANBgkqhkiG9w0BAQEFAANL\nADBIAkEArRf1nhlJYbdOdN7EvY4YlVGl4qsh85UK3MKa5ywnBHUqfMtsKCxx2TGN\nsrgpyyyxfH8uo5chrubHEgIBv7h6pwIDAQABMA0GCSqGSIb3DQEBCwUAA0EAj199\nvbnlFA++xZ4hI+WyAv7w/9OSu2uVfyQxeW06oYW2oKlmy3WrkVgyfM2QrGx/f7iB\nHRAks/MlZMXSyW0YsQ==\n-----END CERTIFICATE-----",
    "stateName": "active",
    "modificationComment": "changed-by-admin"
    "version": 5
}
; // CertificatePatchDTO

    let mut context = CertificateRESTServiceApi::Context::default();
    let result = client.patchCertificate(clientExtId, userExtId, extId, certificatePatchDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the certificate credential
Required
Body parameters
Name Description
certificatePatchDTO *

Responses


updateCertificateProperties

updateCertificateProperties
patch/core/v1/{clientExtId}/users/{userExtId}/certificates/{extId}/properties

**Since:** 2.73.0 **Required permission(s):** `AccessControl.CredentialView,AccessControl.CredentialModify,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView,AccessControl.PropertyValueCreate,AccessControl.PropertyValueDelete,AccessControl.PropertyValueModify` Updates the properties of the certificate with the given external ID, belonging to the user and client with given external IDs.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/certificates/{extId}/properties" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CertificateRESTServiceApi;

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

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

        // Create an instance of the API class
        CertificateRESTServiceApi apiInstance = new CertificateRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000033; // String | ExtID of the certificate credential
        map[String, String] requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String] | 

        try {
            map['String', 'String'] result = apiInstance.updateCertificateProperties(clientExtId, userExtId, extId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificateRESTServiceApi#updateCertificateProperties");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the certificate credential
final map[String, String] requestBody = new map[String, String](); // map[String, String] | 

try {
    final result = await api_instance.updateCertificateProperties(clientExtId, userExtId, extId, requestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateCertificateProperties: $e\n');
}

import org.openapitools.client.api.CertificateRESTServiceApi;

public class CertificateRESTServiceApiExample {
    public static void main(String[] args) {
        CertificateRESTServiceApi apiInstance = new CertificateRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000033; // String | ExtID of the certificate credential
        map[String, String] requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String] | 

        try {
            map['String', 'String'] result = apiInstance.updateCertificateProperties(clientExtId, userExtId, extId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificateRESTServiceApi#updateCertificateProperties");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CertificateRESTServiceApi *apiInstance = [[CertificateRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000033; // ExtID of the certificate credential (default to null)
map[String, String] *requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // 

// Update certificate properties
[apiInstance updateCertificatePropertiesWith:clientExtId
    userExtId:userExtId
    extId:extId
    requestBody:requestBody
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.CertificateRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000033; // {String} ExtID of the certificate credential
var requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // {map[String, String]} 

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

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

            // Create an instance of the API class
            var apiInstance = new CertificateRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000033;  // String | ExtID of the certificate credential (default to null)
            var requestBody = new map[String, String](); // map[String, String] | 

            try {
                // Update certificate properties
                map['String', 'String'] result = apiInstance.updateCertificateProperties(clientExtId, userExtId, extId, requestBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CertificateRESTServiceApi.updateCertificateProperties: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CertificateRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000033; // String | ExtID of the certificate credential
$requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String] | 

try {
    $result = $api_instance->updateCertificateProperties($clientExtId, $userExtId, $extId, $requestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CertificateRESTServiceApi->updateCertificateProperties: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CertificateRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CertificateRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000033; # String | ExtID of the certificate credential
my $requestBody = WWW::OPenAPIClient::Object::map[String, String]->new(); # map[String, String] | 

eval {
    my $result = $api_instance->updateCertificateProperties(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId, requestBody => $requestBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CertificateRESTServiceApi->updateCertificateProperties: $@\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.CertificateRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000033 # String | ExtID of the certificate credential (default to null)
requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3} # map[String, String] | 

try:
    # Update certificate properties
    api_response = api_instance.update_certificate_properties(clientExtId, userExtId, extId, requestBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CertificateRESTServiceApi->updateCertificateProperties: %s\n" % e)
extern crate CertificateRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000033; // String
    let requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String]

    let mut context = CertificateRESTServiceApi::Context::default();
    let result = client.updateCertificateProperties(clientExtId, userExtId, extId, requestBody, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the certificate credential
Required
Body parameters
Name Description
requestBody *

Responses


ClientRESTService

assignApplicationToClient

assignApplicationToClient
put/core/v1/clients/{extId}/applications/{appExtId}

**Since:** 2.74.0 **Required permission(s):** `AccessControl.ClientApplAssign` Assigns the application with the given external ID to the client with the given external ID.

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/clients/{extId}/applications/{appExtId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientRESTServiceApi;

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

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

        // Create an instance of the API class
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        String appExtId = 1000; // String | ExtID of the application to be assigned

        try {
            'String' result = apiInstance.assignApplicationToClient(extId, appExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#assignApplicationToClient");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the client
final String appExtId = new String(); // String | ExtID of the application to be assigned

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

import org.openapitools.client.api.ClientRESTServiceApi;

public class ClientRESTServiceApiExample {
    public static void main(String[] args) {
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        String appExtId = 1000; // String | ExtID of the application to be assigned

        try {
            'String' result = apiInstance.assignApplicationToClient(extId, appExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#assignApplicationToClient");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClientRESTServiceApi *apiInstance = [[ClientRESTServiceApi alloc] init];
String *extId = 1000; // ExtID of the client (default to null)
String *appExtId = 1000; // ExtID of the application to be assigned (default to null)

// Assign application
[apiInstance assignApplicationToClientWith:extId
    appExtId:appExtId
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ClientRESTServiceApi()
var extId = 1000; // {String} ExtID of the client
var appExtId = 1000; // {String} ExtID of the application to be assigned

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

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

            // Create an instance of the API class
            var apiInstance = new ClientRESTServiceApi();
            var extId = 1000;  // String | ExtID of the client (default to null)
            var appExtId = 1000;  // String | ExtID of the application to be assigned (default to null)

            try {
                // Assign application
                'String' result = apiInstance.assignApplicationToClient(extId, appExtId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClientRESTServiceApi.assignApplicationToClient: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClientRESTServiceApi();
$extId = 1000; // String | ExtID of the client
$appExtId = 1000; // String | ExtID of the application to be assigned

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClientRESTServiceApi->new();
my $extId = 1000; # String | ExtID of the client
my $appExtId = 1000; # String | ExtID of the application to be assigned

eval {
    my $result = $api_instance->assignApplicationToClient(extId => $extId, appExtId => $appExtId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientRESTServiceApi->assignApplicationToClient: $@\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.ClientRESTServiceApi()
extId = 1000 # String | ExtID of the client (default to null)
appExtId = 1000 # String | ExtID of the application to be assigned (default to null)

try:
    # Assign application
    api_response = api_instance.assign_application_to_client(extId, appExtId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientRESTServiceApi->assignApplicationToClient: %s\n" % e)
extern crate ClientRESTServiceApi;

pub fn main() {
    let extId = 1000; // String
    let appExtId = 1000; // String

    let mut context = ClientRESTServiceApi::Context::default();
    let result = client.assignApplicationToClient(extId, appExtId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the client
Required
appExtId*
String
ExtID of the application to be assigned
Required

Responses


countUsers

countUsers
get/core/v1/clients/{clientExtId}/users/count

**Since:** 2.80.0 **Required permission(s):** `AccessControl.ClientView,AccessControl.UserView` Returns the count of users in the client with the given external ID. Supports filtering.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/clients/{clientExtId}/users/count?allParams=Object"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientRESTServiceApi;

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

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

        // Create an instance of the API class
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        map[String, String] allParams = Object; // map[String, String] | 

        try {
            CountDto result = apiInstance.countUsers(clientExtId, allParams);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#countUsers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final map[String, String] allParams = new map[String, String](); // map[String, String] | 

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

import org.openapitools.client.api.ClientRESTServiceApi;

public class ClientRESTServiceApiExample {
    public static void main(String[] args) {
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        map[String, String] allParams = Object; // map[String, String] | 

        try {
            CountDto result = apiInstance.countUsers(clientExtId, allParams);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#countUsers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClientRESTServiceApi *apiInstance = [[ClientRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
map[String, String] *allParams = Object; //  (default to null)

// Count client users
[apiInstance countUsersWith:clientExtId
    allParams:allParams
              completionHandler: ^(CountDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ClientRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var allParams = Object; // {map[String, String]} 

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

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

            // Create an instance of the API class
            var apiInstance = new ClientRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var allParams = new map[String, String](); // map[String, String] |  (default to null)

            try {
                // Count client users
                CountDto result = apiInstance.countUsers(clientExtId, allParams);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClientRESTServiceApi.countUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClientRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$allParams = Object; // map[String, String] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClientRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $allParams = Object; # map[String, String] | 

eval {
    my $result = $api_instance->countUsers(clientExtId => $clientExtId, allParams => $allParams);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientRESTServiceApi->countUsers: $@\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.ClientRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
allParams = Object # map[String, String] |  (default to null)

try:
    # Count client users
    api_response = api_instance.count_users(clientExtId, allParams)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientRESTServiceApi->countUsers: %s\n" % e)
extern crate ClientRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let allParams = Object; // map[String, String]

    let mut context = ClientRESTServiceApi::Context::default();
    let result = client.countUsers(clientExtId, allParams, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
Query parameters
Name Description
allParams*
map[String, String]
Required

Responses


deleteApplicationToClientMapping

deleteApplicationToClientMapping
delete/core/v1/clients/{extId}/applications/{appExtId}

**Since:** 2.74.0 **Required permission(s):** `AccessControl.ClientApplDelete` Unassigns the application with the given external ID from the client with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/clients/{extId}/applications/{appExtId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientRESTServiceApi;

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

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

        // Create an instance of the API class
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        String appExtId = 1000; // String | ExtID of the application to be unassigned

        try {
            'String' result = apiInstance.deleteApplicationToClientMapping(extId, appExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#deleteApplicationToClientMapping");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the client
final String appExtId = new String(); // String | ExtID of the application to be unassigned

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

import org.openapitools.client.api.ClientRESTServiceApi;

public class ClientRESTServiceApiExample {
    public static void main(String[] args) {
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        String appExtId = 1000; // String | ExtID of the application to be unassigned

        try {
            'String' result = apiInstance.deleteApplicationToClientMapping(extId, appExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#deleteApplicationToClientMapping");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClientRESTServiceApi *apiInstance = [[ClientRESTServiceApi alloc] init];
String *extId = 1000; // ExtID of the client (default to null)
String *appExtId = 1000; // ExtID of the application to be unassigned (default to null)

// Unassign application
[apiInstance deleteApplicationToClientMappingWith:extId
    appExtId:appExtId
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ClientRESTServiceApi()
var extId = 1000; // {String} ExtID of the client
var appExtId = 1000; // {String} ExtID of the application to be unassigned

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

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

            // Create an instance of the API class
            var apiInstance = new ClientRESTServiceApi();
            var extId = 1000;  // String | ExtID of the client (default to null)
            var appExtId = 1000;  // String | ExtID of the application to be unassigned (default to null)

            try {
                // Unassign application
                'String' result = apiInstance.deleteApplicationToClientMapping(extId, appExtId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClientRESTServiceApi.deleteApplicationToClientMapping: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClientRESTServiceApi();
$extId = 1000; // String | ExtID of the client
$appExtId = 1000; // String | ExtID of the application to be unassigned

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClientRESTServiceApi->new();
my $extId = 1000; # String | ExtID of the client
my $appExtId = 1000; # String | ExtID of the application to be unassigned

eval {
    my $result = $api_instance->deleteApplicationToClientMapping(extId => $extId, appExtId => $appExtId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientRESTServiceApi->deleteApplicationToClientMapping: $@\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.ClientRESTServiceApi()
extId = 1000 # String | ExtID of the client (default to null)
appExtId = 1000 # String | ExtID of the application to be unassigned (default to null)

try:
    # Unassign application
    api_response = api_instance.delete_application_to_client_mapping(extId, appExtId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientRESTServiceApi->deleteApplicationToClientMapping: %s\n" % e)
extern crate ClientRESTServiceApi;

pub fn main() {
    let extId = 1000; // String
    let appExtId = 1000; // String

    let mut context = ClientRESTServiceApi::Context::default();
    let result = client.deleteApplicationToClientMapping(extId, appExtId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the client
Required
appExtId*
String
ExtID of the application to be unassigned
Required

Responses


deleteGenericCredential1

deleteGenericCredential1
delete/core/v1/clients/{clientExtId}/generic-credentials/{credentialExtId}

**Since:** 7.2405.0, 8.2405.0 **Required permission(s):** `AccessControl.ClientView,AccessControl.CredentialView` Deletes the generic credential with the given credentialExtId from the client with the given clientExtId.

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/clients/{clientExtId}/generic-credentials/{credentialExtId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientRESTServiceApi;

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

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

        // Create an instance of the API class
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String credentialExtId = cred123; // String | ExtID of the credential to be deleted

        try {
            'String' result = apiInstance.deleteGenericCredential1(clientExtId, credentialExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#deleteGenericCredential1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String credentialExtId = new String(); // String | ExtID of the credential to be deleted

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

import org.openapitools.client.api.ClientRESTServiceApi;

public class ClientRESTServiceApiExample {
    public static void main(String[] args) {
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String credentialExtId = cred123; // String | ExtID of the credential to be deleted

        try {
            'String' result = apiInstance.deleteGenericCredential1(clientExtId, credentialExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#deleteGenericCredential1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClientRESTServiceApi *apiInstance = [[ClientRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *credentialExtId = cred123; // ExtID of the credential to be deleted (default to null)

// Delete client generic credential
[apiInstance deleteGenericCredential1With:clientExtId
    credentialExtId:credentialExtId
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ClientRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var credentialExtId = cred123; // {String} ExtID of the credential to be deleted

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

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

            // Create an instance of the API class
            var apiInstance = new ClientRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var credentialExtId = cred123;  // String | ExtID of the credential to be deleted (default to null)

            try {
                // Delete client generic credential
                'String' result = apiInstance.deleteGenericCredential1(clientExtId, credentialExtId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClientRESTServiceApi.deleteGenericCredential1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClientRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$credentialExtId = cred123; // String | ExtID of the credential to be deleted

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClientRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $credentialExtId = cred123; # String | ExtID of the credential to be deleted

eval {
    my $result = $api_instance->deleteGenericCredential1(clientExtId => $clientExtId, credentialExtId => $credentialExtId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientRESTServiceApi->deleteGenericCredential1: $@\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.ClientRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
credentialExtId = cred123 # String | ExtID of the credential to be deleted (default to null)

try:
    # Delete client generic credential
    api_response = api_instance.delete_generic_credential1(clientExtId, credentialExtId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientRESTServiceApi->deleteGenericCredential1: %s\n" % e)
extern crate ClientRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let credentialExtId = cred123; // String

    let mut context = ClientRESTServiceApi::Context::default();
    let result = client.deleteGenericCredential1(clientExtId, credentialExtId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
credentialExtId*
String
ExtID of the credential to be deleted
Required

Responses


findAllGenericCredential

findAllGenericCredential
get/core/v1/clients/{extId}/generic-credentials

**Since:** 7.2405.0, 8.2405.0 **Required permission(s):** `AccessControl.ClientView,AccessControl.CredentialView` Returns all generic credentials related to the client with the given extId.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/clients/{extId}/generic-credentials?continuationToken=continuationToken_example&limit=1000&sortBy=sortBy_example&offset=56&returnTotalResultCount=true&allParams=Object"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientRESTServiceApi;

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

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

        // Create an instance of the API class
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        map[String, String] allParams = Object; // map[String, String] | 
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit
        String sortBy = sortBy_example; // String | Sort by field
        Integer offset = 56; // Integer | Offset for pagination
        Boolean returnTotalResultCount = true; // Boolean | Return total result count

        try {
            ItemsWrapperForGenericCredentialGetDTO result = apiInstance.findAllGenericCredential(extId, allParams, continuationToken, limit, sortBy, offset, returnTotalResultCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#findAllGenericCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the client
final map[String, String] allParams = new map[String, String](); // map[String, String] | 
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit
final String sortBy = new String(); // String | Sort by field
final Integer offset = new Integer(); // Integer | Offset for pagination
final Boolean returnTotalResultCount = new Boolean(); // Boolean | Return total result count

try {
    final result = await api_instance.findAllGenericCredential(extId, allParams, continuationToken, limit, sortBy, offset, returnTotalResultCount);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->findAllGenericCredential: $e\n');
}

import org.openapitools.client.api.ClientRESTServiceApi;

public class ClientRESTServiceApiExample {
    public static void main(String[] args) {
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        map[String, String] allParams = Object; // map[String, String] | 
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit
        String sortBy = sortBy_example; // String | Sort by field
        Integer offset = 56; // Integer | Offset for pagination
        Boolean returnTotalResultCount = true; // Boolean | Return total result count

        try {
            ItemsWrapperForGenericCredentialGetDTO result = apiInstance.findAllGenericCredential(extId, allParams, continuationToken, limit, sortBy, offset, returnTotalResultCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#findAllGenericCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClientRESTServiceApi *apiInstance = [[ClientRESTServiceApi alloc] init];
String *extId = 1000; // ExtID of the client (default to null)
map[String, String] *allParams = Object; //  (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 1000; // Pagination limit (optional) (default to 0)
String *sortBy = sortBy_example; // Sort by field (optional) (default to )
Integer *offset = 56; // Offset for pagination (optional) (default to null)
Boolean *returnTotalResultCount = true; // Return total result count (optional) (default to false)

// Get client generic credentials
[apiInstance findAllGenericCredentialWith:extId
    allParams:allParams
    continuationToken:continuationToken
    limit:limit
    sortBy:sortBy
    offset:offset
    returnTotalResultCount:returnTotalResultCount
              completionHandler: ^(ItemsWrapperForGenericCredentialGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ClientRESTServiceApi()
var extId = 1000; // {String} ExtID of the client
var allParams = Object; // {map[String, String]} 
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 1000, // {Integer} Pagination limit
  'sortBy': sortBy_example, // {String} Sort by field
  'offset': 56, // {Integer} Offset for pagination
  'returnTotalResultCount': true // {Boolean} Return total result count
};

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

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

            // Create an instance of the API class
            var apiInstance = new ClientRESTServiceApi();
            var extId = 1000;  // String | ExtID of the client (default to null)
            var allParams = new map[String, String](); // map[String, String] |  (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 1000;  // Integer | Pagination limit (optional)  (default to 0)
            var sortBy = sortBy_example;  // String | Sort by field (optional)  (default to )
            var offset = 56;  // Integer | Offset for pagination (optional)  (default to null)
            var returnTotalResultCount = true;  // Boolean | Return total result count (optional)  (default to false)

            try {
                // Get client generic credentials
                ItemsWrapperForGenericCredentialGetDTO result = apiInstance.findAllGenericCredential(extId, allParams, continuationToken, limit, sortBy, offset, returnTotalResultCount);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClientRESTServiceApi.findAllGenericCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClientRESTServiceApi();
$extId = 1000; // String | ExtID of the client
$allParams = Object; // map[String, String] | 
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 1000; // Integer | Pagination limit
$sortBy = sortBy_example; // String | Sort by field
$offset = 56; // Integer | Offset for pagination
$returnTotalResultCount = true; // Boolean | Return total result count

try {
    $result = $api_instance->findAllGenericCredential($extId, $allParams, $continuationToken, $limit, $sortBy, $offset, $returnTotalResultCount);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClientRESTServiceApi->findAllGenericCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ClientRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClientRESTServiceApi->new();
my $extId = 1000; # String | ExtID of the client
my $allParams = Object; # map[String, String] | 
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 1000; # Integer | Pagination limit
my $sortBy = sortBy_example; # String | Sort by field
my $offset = 56; # Integer | Offset for pagination
my $returnTotalResultCount = true; # Boolean | Return total result count

eval {
    my $result = $api_instance->findAllGenericCredential(extId => $extId, allParams => $allParams, continuationToken => $continuationToken, limit => $limit, sortBy => $sortBy, offset => $offset, returnTotalResultCount => $returnTotalResultCount);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientRESTServiceApi->findAllGenericCredential: $@\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.ClientRESTServiceApi()
extId = 1000 # String | ExtID of the client (default to null)
allParams = Object # map[String, String] |  (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 1000 # Integer | Pagination limit (optional) (default to 0)
sortBy = sortBy_example # String | Sort by field (optional) (default to )
offset = 56 # Integer | Offset for pagination (optional) (default to null)
returnTotalResultCount = true # Boolean | Return total result count (optional) (default to false)

try:
    # Get client generic credentials
    api_response = api_instance.find_all_generic_credential(extId, allParams, continuationToken=continuationToken, limit=limit, sortBy=sortBy, offset=offset, returnTotalResultCount=returnTotalResultCount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientRESTServiceApi->findAllGenericCredential: %s\n" % e)
extern crate ClientRESTServiceApi;

pub fn main() {
    let extId = 1000; // String
    let allParams = Object; // map[String, String]
    let continuationToken = continuationToken_example; // String
    let limit = 1000; // Integer
    let sortBy = sortBy_example; // String
    let offset = 56; // Integer
    let returnTotalResultCount = true; // Boolean

    let mut context = ClientRESTServiceApi::Context::default();
    let result = client.findAllGenericCredential(extId, allParams, continuationToken, limit, sortBy, offset, returnTotalResultCount, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the client
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit
sortBy
String
Sort by field
offset
Integer (int32)
Offset for pagination
returnTotalResultCount
Boolean
Return total result count
allParams*
map[String, String]
Required

Responses


getApplications1

getApplications1
get/core/v1/clients/{extId}/applications

**Since:** 2.71.0 **Required permission(s):** `AccessControl.ClientView,AccessControl.ApplicationView` Returns all applications of the client with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/clients/{extId}/applications?continuationToken=continuationToken_example&limit=100"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientRESTServiceApi;

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

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

        // Create an instance of the API class
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperDTO result = apiInstance.getApplications1(extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#getApplications1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the client
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

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

import org.openapitools.client.api.ClientRESTServiceApi;

public class ClientRESTServiceApiExample {
    public static void main(String[] args) {
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperDTO result = apiInstance.getApplications1(extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#getApplications1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClientRESTServiceApi *apiInstance = [[ClientRESTServiceApi alloc] init];
String *extId = 1000; // ExtID of the client (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 100; // Pagination limit (optional) (default to 0)

// Get client applications
[apiInstance getApplications1With:extId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ClientRESTServiceApi()
var extId = 1000; // {String} ExtID of the client
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 100 // {Integer} Pagination limit
};

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

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

            // Create an instance of the API class
            var apiInstance = new ClientRESTServiceApi();
            var extId = 1000;  // String | ExtID of the client (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 100;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get client applications
                ItemsWrapperDTO result = apiInstance.getApplications1(extId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClientRESTServiceApi.getApplications1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClientRESTServiceApi();
$extId = 1000; // String | ExtID of the client
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 100; // Integer | Pagination limit

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClientRESTServiceApi->new();
my $extId = 1000; # String | ExtID of the client
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 100; # Integer | Pagination limit

eval {
    my $result = $api_instance->getApplications1(extId => $extId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientRESTServiceApi->getApplications1: $@\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.ClientRESTServiceApi()
extId = 1000 # String | ExtID of the client (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 100 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get client applications
    api_response = api_instance.get_applications1(extId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientRESTServiceApi->getApplications1: %s\n" % e)
extern crate ClientRESTServiceApi;

pub fn main() {
    let extId = 1000; // String
    let continuationToken = continuationToken_example; // String
    let limit = 100; // Integer

    let mut context = ClientRESTServiceApi::Context::default();
    let result = client.getApplications1(extId, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the client
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


getClient

getClient
get/core/v1/clients/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.ClientView` Returns the client with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/clients/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientRESTServiceApi;

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

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

        // Create an instance of the API class
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client

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

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the client

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

import org.openapitools.client.api.ClientRESTServiceApi;

public class ClientRESTServiceApiExample {
    public static void main(String[] args) {
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client

        try {
            ClientGetDTO result = apiInstance.getClient(extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#getClient");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClientRESTServiceApi *apiInstance = [[ClientRESTServiceApi alloc] init];
String *extId = 1000; // ExtID of the client (default to null)

// Get client
[apiInstance getClientWith:extId
              completionHandler: ^(ClientGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ClientRESTServiceApi()
var extId = 1000; // {String} ExtID of the client

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

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

            // Create an instance of the API class
            var apiInstance = new ClientRESTServiceApi();
            var extId = 1000;  // String | ExtID of the client (default to null)

            try {
                // Get client
                ClientGetDTO result = apiInstance.getClient(extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClientRESTServiceApi.getClient: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClientRESTServiceApi();
$extId = 1000; // String | ExtID of the client

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClientRESTServiceApi->new();
my $extId = 1000; # String | ExtID of the client

eval {
    my $result = $api_instance->getClient(extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientRESTServiceApi->getClient: $@\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.ClientRESTServiceApi()
extId = 1000 # String | ExtID of the client (default to null)

try:
    # Get client
    api_response = api_instance.get_client(extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientRESTServiceApi->getClient: %s\n" % e)
extern crate ClientRESTServiceApi;

pub fn main() {
    let extId = 1000; // String

    let mut context = ClientRESTServiceApi::Context::default();
    let result = client.getClient(extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the client
Required

Responses


getClients

getClients
get/core/v1/clients

**Since:** 2.73.0 **Required permission(s):** `AccessControl.ClientView` Returns all clients in the system.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/clients?continuationToken=continuationToken_example&limit=1000"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientRESTServiceApi;

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

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

        // Create an instance of the API class
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForClientGetDTO result = apiInstance.getClients(continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#getClients");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

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

import org.openapitools.client.api.ClientRESTServiceApi;

public class ClientRESTServiceApiExample {
    public static void main(String[] args) {
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForClientGetDTO result = apiInstance.getClients(continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#getClients");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClientRESTServiceApi *apiInstance = [[ClientRESTServiceApi alloc] init];
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 1000; // Pagination limit (optional) (default to 0)

// Get clients
[apiInstance getClientsWith:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForClientGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ClientRESTServiceApi()
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 1000 // {Integer} Pagination limit
};

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

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

            // Create an instance of the API class
            var apiInstance = new ClientRESTServiceApi();
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 1000;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get clients
                ItemsWrapperForClientGetDTO result = apiInstance.getClients(continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClientRESTServiceApi.getClients: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClientRESTServiceApi();
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 1000; // Integer | Pagination limit

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClientRESTServiceApi->new();
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 1000; # Integer | Pagination limit

eval {
    my $result = $api_instance->getClients(continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientRESTServiceApi->getClients: $@\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.ClientRESTServiceApi()
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 1000 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get clients
    api_response = api_instance.get_clients(continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientRESTServiceApi->getClients: %s\n" % e)
extern crate ClientRESTServiceApi;

pub fn main() {
    let continuationToken = continuationToken_example; // String
    let limit = 1000; // Integer

    let mut context = ClientRESTServiceApi::Context::default();
    let result = client.getClients(continuationToken, limit, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


getEnterpriseRoles1

getEnterpriseRoles1
get/core/v1/clients/{extId}/eroles

**Since:** 2.75.2, 2.76.0 **Required permission(s):** `AccessControl.ClientView,AccessControl.EnterpriseRoleView` Returns all enterprise roles of the client with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/clients/{extId}/eroles?continuationToken=continuationToken_example&limit=100"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientRESTServiceApi;

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

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

        // Create an instance of the API class
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperDTO result = apiInstance.getEnterpriseRoles1(extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#getEnterpriseRoles1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the client
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

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

import org.openapitools.client.api.ClientRESTServiceApi;

public class ClientRESTServiceApiExample {
    public static void main(String[] args) {
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperDTO result = apiInstance.getEnterpriseRoles1(extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#getEnterpriseRoles1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClientRESTServiceApi *apiInstance = [[ClientRESTServiceApi alloc] init];
String *extId = 1000; // ExtID of the client (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 100; // Pagination limit (optional) (default to 0)

// Get client eroles
[apiInstance getEnterpriseRoles1With:extId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ClientRESTServiceApi()
var extId = 1000; // {String} ExtID of the client
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 100 // {Integer} Pagination limit
};

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

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

            // Create an instance of the API class
            var apiInstance = new ClientRESTServiceApi();
            var extId = 1000;  // String | ExtID of the client (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 100;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get client eroles
                ItemsWrapperDTO result = apiInstance.getEnterpriseRoles1(extId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClientRESTServiceApi.getEnterpriseRoles1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClientRESTServiceApi();
$extId = 1000; // String | ExtID of the client
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 100; // Integer | Pagination limit

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClientRESTServiceApi->new();
my $extId = 1000; # String | ExtID of the client
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 100; # Integer | Pagination limit

eval {
    my $result = $api_instance->getEnterpriseRoles1(extId => $extId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientRESTServiceApi->getEnterpriseRoles1: $@\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.ClientRESTServiceApi()
extId = 1000 # String | ExtID of the client (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 100 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get client eroles
    api_response = api_instance.get_enterprise_roles1(extId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientRESTServiceApi->getEnterpriseRoles1: %s\n" % e)
extern crate ClientRESTServiceApi;

pub fn main() {
    let extId = 1000; // String
    let continuationToken = continuationToken_example; // String
    let limit = 100; // Integer

    let mut context = ClientRESTServiceApi::Context::default();
    let result = client.getEnterpriseRoles1(extId, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the client
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


getPolicyConfigurations

getPolicyConfigurations
get/core/v1/clients/{extId}/policies

**Since:** 2.79.0 **Required permission(s):** `AccessControl.ClientView,AccessControl.PolicyConfigurationView` Returns all policies of the client with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/clients/{extId}/policies?continuationToken=continuationToken_example&limit=100"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientRESTServiceApi;

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

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

        // Create an instance of the API class
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperForPolicyConfigurationGetDTO result = apiInstance.getPolicyConfigurations(extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#getPolicyConfigurations");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the client
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

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

import org.openapitools.client.api.ClientRESTServiceApi;

public class ClientRESTServiceApiExample {
    public static void main(String[] args) {
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperForPolicyConfigurationGetDTO result = apiInstance.getPolicyConfigurations(extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#getPolicyConfigurations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClientRESTServiceApi *apiInstance = [[ClientRESTServiceApi alloc] init];
String *extId = 1000; // ExtID of the client (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 100; // Pagination limit (optional) (default to 0)

// Get client policies
[apiInstance getPolicyConfigurationsWith:extId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForPolicyConfigurationGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ClientRESTServiceApi()
var extId = 1000; // {String} ExtID of the client
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 100 // {Integer} Pagination limit
};

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

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

            // Create an instance of the API class
            var apiInstance = new ClientRESTServiceApi();
            var extId = 1000;  // String | ExtID of the client (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 100;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get client policies
                ItemsWrapperForPolicyConfigurationGetDTO result = apiInstance.getPolicyConfigurations(extId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClientRESTServiceApi.getPolicyConfigurations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClientRESTServiceApi();
$extId = 1000; // String | ExtID of the client
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 100; // Integer | Pagination limit

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClientRESTServiceApi->new();
my $extId = 1000; # String | ExtID of the client
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 100; # Integer | Pagination limit

eval {
    my $result = $api_instance->getPolicyConfigurations(extId => $extId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientRESTServiceApi->getPolicyConfigurations: $@\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.ClientRESTServiceApi()
extId = 1000 # String | ExtID of the client (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 100 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get client policies
    api_response = api_instance.get_policy_configurations(extId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientRESTServiceApi->getPolicyConfigurations: %s\n" % e)
extern crate ClientRESTServiceApi;

pub fn main() {
    let extId = 1000; // String
    let continuationToken = continuationToken_example; // String
    let limit = 100; // Integer

    let mut context = ClientRESTServiceApi::Context::default();
    let result = client.getPolicyConfigurations(extId, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the client
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


getUnits

getUnits
get/core/v1/clients/{extId}/units

**Since:** 2.73.0 **Required permission(s):** `AccessControl.ClientView,AccessControl.UnitView` Returns all units of the client with the given external ID. Supports filtering and pagination.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/clients/{extId}/units?continuationToken=continuationToken_example&limit=100&allParams=Object"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientRESTServiceApi;

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

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

        // Create an instance of the API class
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        map[String, String] allParams = Object; // map[String, String] | 
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperDTO result = apiInstance.getUnits(extId, allParams, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#getUnits");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the client
final map[String, String] allParams = new map[String, String](); // map[String, String] | 
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

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

import org.openapitools.client.api.ClientRESTServiceApi;

public class ClientRESTServiceApiExample {
    public static void main(String[] args) {
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        map[String, String] allParams = Object; // map[String, String] | 
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperDTO result = apiInstance.getUnits(extId, allParams, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#getUnits");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClientRESTServiceApi *apiInstance = [[ClientRESTServiceApi alloc] init];
String *extId = 1000; // ExtID of the client (default to null)
map[String, String] *allParams = Object; //  (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 100; // Pagination limit (optional) (default to 0)

// Get client units
[apiInstance getUnitsWith:extId
    allParams:allParams
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ClientRESTServiceApi()
var extId = 1000; // {String} ExtID of the client
var allParams = Object; // {map[String, String]} 
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 100 // {Integer} Pagination limit
};

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

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

            // Create an instance of the API class
            var apiInstance = new ClientRESTServiceApi();
            var extId = 1000;  // String | ExtID of the client (default to null)
            var allParams = new map[String, String](); // map[String, String] |  (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 100;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get client units
                ItemsWrapperDTO result = apiInstance.getUnits(extId, allParams, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClientRESTServiceApi.getUnits: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClientRESTServiceApi();
$extId = 1000; // String | ExtID of the client
$allParams = Object; // map[String, String] | 
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 100; // Integer | Pagination limit

try {
    $result = $api_instance->getUnits($extId, $allParams, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClientRESTServiceApi->getUnits: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ClientRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClientRESTServiceApi->new();
my $extId = 1000; # String | ExtID of the client
my $allParams = Object; # map[String, String] | 
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 100; # Integer | Pagination limit

eval {
    my $result = $api_instance->getUnits(extId => $extId, allParams => $allParams, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientRESTServiceApi->getUnits: $@\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.ClientRESTServiceApi()
extId = 1000 # String | ExtID of the client (default to null)
allParams = Object # map[String, String] |  (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 100 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get client units
    api_response = api_instance.get_units(extId, allParams, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientRESTServiceApi->getUnits: %s\n" % e)
extern crate ClientRESTServiceApi;

pub fn main() {
    let extId = 1000; // String
    let allParams = Object; // map[String, String]
    let continuationToken = continuationToken_example; // String
    let limit = 100; // Integer

    let mut context = ClientRESTServiceApi::Context::default();
    let result = client.getUnits(extId, allParams, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the client
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit
allParams*
map[String, String]
Required

Responses


getUsers

getUsers
get/core/v1/clients/{extId}/users

**Since:** 2.71.0 **Required permission(s):** `AccessControl.ClientView,AccessControl.UserView,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView` Returns all users of the client with the given external ID. Supports sorting result via sortBy query parameter. Possible values: - extId, - loginId, - isTechnicalUser, - name.title, - name.firstName, - name.familyName, - birthDate, - address.countryCode, - address.city, - address.postalCode, - address.addressline1, - address.addressline2, - address.street, - address.houseNumber, - address.dwellingNumber, - address.postOfficeBoxText, - address.postOfficeBoxNumber, - address.locality, - contacts.telephone, - contacts.telefax, - contacts.mobile, - contacts.email, - validity.to, - validity.from, - remarks, - version, - created, - lastModified Supports offset-based pagination. The offset query parameter specifies the offset of the first result to be returned. If both continuation token and offset are provided, the continuation token is ignored. Filtering is supported by property or any user field. Supported filter fields: - extId - userState - loginId - languageCode - isTechnicalUser - name.title - name.firstName - name.familyName - sex - gender - birthDate - address.countryCode - address.city - address.postalCode - address.addressline1 - address.addressline2 - address.street - address.houseNumber - address.dwellingNumber - address.postOfficeBoxText - address.postOfficeBoxNumber - address.locality - contacts.telephone - contacts.telefax - contacts.email - contacts.mobile - validity.from - validity.to - remarks - modificationComment - version - created - lastModified Modifiers for extId and loginId: _SW (starts with), _IEQ (case-insensitive full match). Example filter queries: - ?property.user%20global%20test%201=ffgg&property.user%20global%20test%20status=ACTIVE - ?extId=100&userState=ACTIVE - ?extId_SW=boo&userState=ACTIVE - ?loginId_IEQ=BOOTSTRAP&languageCode=en - ?isTechnicalUser=false&name.title=Mr. - ?address.street=Roentgenstrasse&address.houseNumber=22 - ?contacts.telephone=0444444444&contacts.email=[email protected] Example sort queries:- ?sortBy=extId - ?sortBy=extId_DESC - ?sortBy=extId_ASC Total result count is displayed in totalResult in _pagination if returnTotalResultCount is set to true.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/clients/{extId}/users?continuationToken=continuationToken_example&limit=100&sortBy=sortBy_example&returnTotalResultCount=true&offset=56&allParams=Object"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientRESTServiceApi;

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

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

        // Create an instance of the API class
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        map[String, String] allParams = Object; // map[String, String] | 
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit
        String sortBy = sortBy_example; // String | Sort by field
        Boolean returnTotalResultCount = true; // Boolean | Return total result count
        Integer offset = 56; // Integer | Offset for pagination

        try {
            ItemsWrapperForUserGetDTO result = apiInstance.getUsers(extId, allParams, continuationToken, limit, sortBy, returnTotalResultCount, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#getUsers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the client
final map[String, String] allParams = new map[String, String](); // map[String, String] | 
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit
final String sortBy = new String(); // String | Sort by field
final Boolean returnTotalResultCount = new Boolean(); // Boolean | Return total result count
final Integer offset = new Integer(); // Integer | Offset for pagination

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

import org.openapitools.client.api.ClientRESTServiceApi;

public class ClientRESTServiceApiExample {
    public static void main(String[] args) {
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        map[String, String] allParams = Object; // map[String, String] | 
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit
        String sortBy = sortBy_example; // String | Sort by field
        Boolean returnTotalResultCount = true; // Boolean | Return total result count
        Integer offset = 56; // Integer | Offset for pagination

        try {
            ItemsWrapperForUserGetDTO result = apiInstance.getUsers(extId, allParams, continuationToken, limit, sortBy, returnTotalResultCount, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#getUsers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClientRESTServiceApi *apiInstance = [[ClientRESTServiceApi alloc] init];
String *extId = 1000; // ExtID of the client (default to null)
map[String, String] *allParams = Object; //  (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 100; // Pagination limit (optional) (default to 0)
String *sortBy = sortBy_example; // Sort by field (optional) (default to )
Boolean *returnTotalResultCount = true; // Return total result count (optional) (default to false)
Integer *offset = 56; // Offset for pagination (optional) (default to null)

// Get client users
[apiInstance getUsersWith:extId
    allParams:allParams
    continuationToken:continuationToken
    limit:limit
    sortBy:sortBy
    returnTotalResultCount:returnTotalResultCount
    offset:offset
              completionHandler: ^(ItemsWrapperForUserGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ClientRESTServiceApi()
var extId = 1000; // {String} ExtID of the client
var allParams = Object; // {map[String, String]} 
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 100, // {Integer} Pagination limit
  'sortBy': sortBy_example, // {String} Sort by field
  'returnTotalResultCount': true, // {Boolean} Return total result count
  'offset': 56 // {Integer} Offset for pagination
};

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

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

            // Create an instance of the API class
            var apiInstance = new ClientRESTServiceApi();
            var extId = 1000;  // String | ExtID of the client (default to null)
            var allParams = new map[String, String](); // map[String, String] |  (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 100;  // Integer | Pagination limit (optional)  (default to 0)
            var sortBy = sortBy_example;  // String | Sort by field (optional)  (default to )
            var returnTotalResultCount = true;  // Boolean | Return total result count (optional)  (default to false)
            var offset = 56;  // Integer | Offset for pagination (optional)  (default to null)

            try {
                // Get client users
                ItemsWrapperForUserGetDTO result = apiInstance.getUsers(extId, allParams, continuationToken, limit, sortBy, returnTotalResultCount, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClientRESTServiceApi.getUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClientRESTServiceApi();
$extId = 1000; // String | ExtID of the client
$allParams = Object; // map[String, String] | 
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 100; // Integer | Pagination limit
$sortBy = sortBy_example; // String | Sort by field
$returnTotalResultCount = true; // Boolean | Return total result count
$offset = 56; // Integer | Offset for pagination

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClientRESTServiceApi->new();
my $extId = 1000; # String | ExtID of the client
my $allParams = Object; # map[String, String] | 
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 100; # Integer | Pagination limit
my $sortBy = sortBy_example; # String | Sort by field
my $returnTotalResultCount = true; # Boolean | Return total result count
my $offset = 56; # Integer | Offset for pagination

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

# Create an instance of the API class
api_instance = openapi_client.ClientRESTServiceApi()
extId = 1000 # String | ExtID of the client (default to null)
allParams = Object # map[String, String] |  (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 100 # Integer | Pagination limit (optional) (default to 0)
sortBy = sortBy_example # String | Sort by field (optional) (default to )
returnTotalResultCount = true # Boolean | Return total result count (optional) (default to false)
offset = 56 # Integer | Offset for pagination (optional) (default to null)

try:
    # Get client users
    api_response = api_instance.get_users(extId, allParams, continuationToken=continuationToken, limit=limit, sortBy=sortBy, returnTotalResultCount=returnTotalResultCount, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientRESTServiceApi->getUsers: %s\n" % e)
extern crate ClientRESTServiceApi;

pub fn main() {
    let extId = 1000; // String
    let allParams = Object; // map[String, String]
    let continuationToken = continuationToken_example; // String
    let limit = 100; // Integer
    let sortBy = sortBy_example; // String
    let returnTotalResultCount = true; // Boolean
    let offset = 56; // Integer

    let mut context = ClientRESTServiceApi::Context::default();
    let result = client.getUsers(extId, allParams, continuationToken, limit, sortBy, returnTotalResultCount, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the client
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit
sortBy
String
Sort by field
returnTotalResultCount
Boolean
Return total result count
offset
Integer (int32)
Offset for pagination
allParams*
map[String, String]
Required

Responses


listAllFido2Credential

listAllFido2Credential
get/core/v1/clients/{extId}/fido2

**Since:** 2.86.0 **Required permission(s):** `AccessControl.ClientView,AccessControl.CredentialView` Returns all FIDO2 credentials related to the client with the given extId. Supports sorting via sortBy query parameter. Possible values: - extId, - validity.to, - validity.from, - version, - created, - lastModified, - aaguid, - rpId, - userFriendlyName Supports offset-based pagination. The offset query parameter specifies the offset of the first result to be returned. If both continuation token and offset are provided, the continuation token is ignored. Filtering is supported by: - userFriendlyName - extId - hashedCredentialId - stateName Modifiers for extId and userFriendlyName: _SW (starts with), _IEQ (case-insensitive full match). Example filter queries: - ?userFriendlyName=NEVIS%20Android%20phone&stateName=active - ?userFriendlyName_IEQ=nevis%20Android%20phone&stateName=active - ?userFriendlyName_SW=NEVIS&stateName=active - ?hashedCredentialId=hashedCredentialId - ?extId=fido2TestExtId - ?extId_SW=fido2TestExtId - ?extId_IEQ=fido2TestExtId Example sort queries: - ?sortBy=extId - ?sortBy=extId_DESC - ?sortBy=extId_ASC Total result count is displayed in totalResult in _pagination if returnTotalResultCount is set to true.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/clients/{extId}/fido2?continuationToken=continuationToken_example&limit=1000&sortBy=sortBy_example&returnTotalResultCount=true&offset=56&filter=&allParams=Object"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientRESTServiceApi;

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

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

        // Create an instance of the API class
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        map[String, String] allParams = Object; // map[String, String] | 
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit
        String sortBy = sortBy_example; // String | Sort by field
        Boolean returnTotalResultCount = true; // Boolean | Return total result count
        Integer offset = 56; // Integer | Offset for pagination
         UNKNOWN_PARAMETER_NAME = ; //  | Filtering parameters are documented in the description

        try {
            ItemsWrapperForFido2GetDTO result = apiInstance.listAllFido2Credential(extId, allParams, continuationToken, limit, sortBy, returnTotalResultCount, offset, UNKNOWN_PARAMETER_NAME);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#listAllFido2Credential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the client
final map[String, String] allParams = new map[String, String](); // map[String, String] | 
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit
final String sortBy = new String(); // String | Sort by field
final Boolean returnTotalResultCount = new Boolean(); // Boolean | Return total result count
final Integer offset = new Integer(); // Integer | Offset for pagination
final  UNKNOWN_PARAMETER_NAME = new (); //  | Filtering parameters are documented in the description

try {
    final result = await api_instance.listAllFido2Credential(extId, allParams, continuationToken, limit, sortBy, returnTotalResultCount, offset, UNKNOWN_PARAMETER_NAME);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listAllFido2Credential: $e\n');
}

import org.openapitools.client.api.ClientRESTServiceApi;

public class ClientRESTServiceApiExample {
    public static void main(String[] args) {
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        map[String, String] allParams = Object; // map[String, String] | 
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit
        String sortBy = sortBy_example; // String | Sort by field
        Boolean returnTotalResultCount = true; // Boolean | Return total result count
        Integer offset = 56; // Integer | Offset for pagination
         UNKNOWN_PARAMETER_NAME = ; //  | Filtering parameters are documented in the description

        try {
            ItemsWrapperForFido2GetDTO result = apiInstance.listAllFido2Credential(extId, allParams, continuationToken, limit, sortBy, returnTotalResultCount, offset, UNKNOWN_PARAMETER_NAME);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#listAllFido2Credential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClientRESTServiceApi *apiInstance = [[ClientRESTServiceApi alloc] init];
String *extId = 1000; // ExtID of the client (default to null)
map[String, String] *allParams = Object; //  (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 1000; // Pagination limit (optional) (default to 0)
String *sortBy = sortBy_example; // Sort by field (optional) (default to )
Boolean *returnTotalResultCount = true; // Return total result count (optional) (default to false)
Integer *offset = 56; // Offset for pagination (optional) (default to null)
 *UNKNOWN_PARAMETER_NAME = ; // Filtering parameters are documented in the description (optional)

// Get client FIDO2 credentials
[apiInstance listAllFido2CredentialWith:extId
    allParams:allParams
    continuationToken:continuationToken
    limit:limit
    sortBy:sortBy
    returnTotalResultCount:returnTotalResultCount
    offset:offset
    UNKNOWN_PARAMETER_NAME:UNKNOWN_PARAMETER_NAME
              completionHandler: ^(ItemsWrapperForFido2GetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ClientRESTServiceApi()
var extId = 1000; // {String} ExtID of the client
var allParams = Object; // {map[String, String]} 
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 1000, // {Integer} Pagination limit
  'sortBy': sortBy_example, // {String} Sort by field
  'returnTotalResultCount': true, // {Boolean} Return total result count
  'offset': 56, // {Integer} Offset for pagination
  'UNKNOWN_PARAMETER_NAME':  // {} Filtering parameters are documented in the description
};

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

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

            // Create an instance of the API class
            var apiInstance = new ClientRESTServiceApi();
            var extId = 1000;  // String | ExtID of the client (default to null)
            var allParams = new map[String, String](); // map[String, String] |  (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 1000;  // Integer | Pagination limit (optional)  (default to 0)
            var sortBy = sortBy_example;  // String | Sort by field (optional)  (default to )
            var returnTotalResultCount = true;  // Boolean | Return total result count (optional)  (default to false)
            var offset = 56;  // Integer | Offset for pagination (optional)  (default to null)
            var UNKNOWN_PARAMETER_NAME = new (); //  | Filtering parameters are documented in the description (optional) 

            try {
                // Get client FIDO2 credentials
                ItemsWrapperForFido2GetDTO result = apiInstance.listAllFido2Credential(extId, allParams, continuationToken, limit, sortBy, returnTotalResultCount, offset, UNKNOWN_PARAMETER_NAME);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClientRESTServiceApi.listAllFido2Credential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClientRESTServiceApi();
$extId = 1000; // String | ExtID of the client
$allParams = Object; // map[String, String] | 
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 1000; // Integer | Pagination limit
$sortBy = sortBy_example; // String | Sort by field
$returnTotalResultCount = true; // Boolean | Return total result count
$offset = 56; // Integer | Offset for pagination
$UNKNOWN_PARAMETER_NAME = ; //  | Filtering parameters are documented in the description

try {
    $result = $api_instance->listAllFido2Credential($extId, $allParams, $continuationToken, $limit, $sortBy, $returnTotalResultCount, $offset, $UNKNOWN_PARAMETER_NAME);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClientRESTServiceApi->listAllFido2Credential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ClientRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClientRESTServiceApi->new();
my $extId = 1000; # String | ExtID of the client
my $allParams = Object; # map[String, String] | 
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 1000; # Integer | Pagination limit
my $sortBy = sortBy_example; # String | Sort by field
my $returnTotalResultCount = true; # Boolean | Return total result count
my $offset = 56; # Integer | Offset for pagination
my $UNKNOWN_PARAMETER_NAME = ; #  | Filtering parameters are documented in the description

eval {
    my $result = $api_instance->listAllFido2Credential(extId => $extId, allParams => $allParams, continuationToken => $continuationToken, limit => $limit, sortBy => $sortBy, returnTotalResultCount => $returnTotalResultCount, offset => $offset, UNKNOWN_PARAMETER_NAME => $UNKNOWN_PARAMETER_NAME);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientRESTServiceApi->listAllFido2Credential: $@\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.ClientRESTServiceApi()
extId = 1000 # String | ExtID of the client (default to null)
allParams = Object # map[String, String] |  (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 1000 # Integer | Pagination limit (optional) (default to 0)
sortBy = sortBy_example # String | Sort by field (optional) (default to )
returnTotalResultCount = true # Boolean | Return total result count (optional) (default to false)
offset = 56 # Integer | Offset for pagination (optional) (default to null)
UNKNOWN_PARAMETER_NAME =  #  | Filtering parameters are documented in the description (optional)

try:
    # Get client FIDO2 credentials
    api_response = api_instance.list_all_fido2_credential(extId, allParams, continuationToken=continuationToken, limit=limit, sortBy=sortBy, returnTotalResultCount=returnTotalResultCount, offset=offset, UNKNOWN_PARAMETER_NAME=UNKNOWN_PARAMETER_NAME)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientRESTServiceApi->listAllFido2Credential: %s\n" % e)
extern crate ClientRESTServiceApi;

pub fn main() {
    let extId = 1000; // String
    let allParams = Object; // map[String, String]
    let continuationToken = continuationToken_example; // String
    let limit = 1000; // Integer
    let sortBy = sortBy_example; // String
    let returnTotalResultCount = true; // Boolean
    let offset = 56; // Integer
    let UNKNOWN_PARAMETER_NAME = ; // 

    let mut context = ClientRESTServiceApi::Context::default();
    let result = client.listAllFido2Credential(extId, allParams, continuationToken, limit, sortBy, returnTotalResultCount, offset, UNKNOWN_PARAMETER_NAME, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the client
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit
sortBy
String
Sort by field
returnTotalResultCount
Boolean
Return total result count
offset
Integer (int32)
Offset for pagination
filter
Filtering parameters are documented in the description
allParams*
map[String, String]
Required

Responses


listAllFidoUafCredential

listAllFidoUafCredential
get/core/v1/clients/{extId}/fido-uaf

**Since:** 7.2402.0 **Required permission(s):** `AccessControl.ClientView,AccessControl.CredentialView` Returns all FIDO UAF credentials related to the client with the given extId.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/clients/{extId}/fido-uaf?continuationToken=continuationToken_example&limit=1000&allParams=Object"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientRESTServiceApi;

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

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

        // Create an instance of the API class
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        map[String, String] allParams = Object; // map[String, String] | 
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForFidoUafGetDTO result = apiInstance.listAllFidoUafCredential(extId, allParams, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#listAllFidoUafCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the client
final map[String, String] allParams = new map[String, String](); // map[String, String] | 
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

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

import org.openapitools.client.api.ClientRESTServiceApi;

public class ClientRESTServiceApiExample {
    public static void main(String[] args) {
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        map[String, String] allParams = Object; // map[String, String] | 
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForFidoUafGetDTO result = apiInstance.listAllFidoUafCredential(extId, allParams, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#listAllFidoUafCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClientRESTServiceApi *apiInstance = [[ClientRESTServiceApi alloc] init];
String *extId = 1000; // ExtID of the client (default to null)
map[String, String] *allParams = Object; //  (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 1000; // Pagination limit (optional) (default to 0)

// Get client FIDO UAF credentials
[apiInstance listAllFidoUafCredentialWith:extId
    allParams:allParams
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForFidoUafGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ClientRESTServiceApi()
var extId = 1000; // {String} ExtID of the client
var allParams = Object; // {map[String, String]} 
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 1000 // {Integer} Pagination limit
};

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

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

            // Create an instance of the API class
            var apiInstance = new ClientRESTServiceApi();
            var extId = 1000;  // String | ExtID of the client (default to null)
            var allParams = new map[String, String](); // map[String, String] |  (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 1000;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get client FIDO UAF credentials
                ItemsWrapperForFidoUafGetDTO result = apiInstance.listAllFidoUafCredential(extId, allParams, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClientRESTServiceApi.listAllFidoUafCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClientRESTServiceApi();
$extId = 1000; // String | ExtID of the client
$allParams = Object; // map[String, String] | 
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 1000; // Integer | Pagination limit

try {
    $result = $api_instance->listAllFidoUafCredential($extId, $allParams, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClientRESTServiceApi->listAllFidoUafCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ClientRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClientRESTServiceApi->new();
my $extId = 1000; # String | ExtID of the client
my $allParams = Object; # map[String, String] | 
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 1000; # Integer | Pagination limit

eval {
    my $result = $api_instance->listAllFidoUafCredential(extId => $extId, allParams => $allParams, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientRESTServiceApi->listAllFidoUafCredential: $@\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.ClientRESTServiceApi()
extId = 1000 # String | ExtID of the client (default to null)
allParams = Object # map[String, String] |  (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 1000 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get client FIDO UAF credentials
    api_response = api_instance.list_all_fido_uaf_credential(extId, allParams, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientRESTServiceApi->listAllFidoUafCredential: %s\n" % e)
extern crate ClientRESTServiceApi;

pub fn main() {
    let extId = 1000; // String
    let allParams = Object; // map[String, String]
    let continuationToken = continuationToken_example; // String
    let limit = 1000; // Integer

    let mut context = ClientRESTServiceApi::Context::default();
    let result = client.listAllFidoUafCredential(extId, allParams, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the client
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit
allParams*
map[String, String]
Required

Responses


listAllPropertiesForClient

listAllPropertiesForClient
get/core/v1/clients/{extId}/properties

**Since:** 2.85.0 **Required permission(s):** `AccessControl.PropertyView,AccessControl.PropertyAllowedValueView` Returns all the properties related to the client with the given extId.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/clients/{extId}/properties?allParams=Object"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientRESTServiceApi;

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

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

        // Create an instance of the API class
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        map[String, String] allParams = Object; // map[String, String] | 

        try {
            ItemsWrapperDTO result = apiInstance.listAllPropertiesForClient(extId, allParams);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#listAllPropertiesForClient");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the client
final map[String, String] allParams = new map[String, String](); // map[String, String] | 

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

import org.openapitools.client.api.ClientRESTServiceApi;

public class ClientRESTServiceApiExample {
    public static void main(String[] args) {
        ClientRESTServiceApi apiInstance = new ClientRESTServiceApi();
        String extId = 1000; // String | ExtID of the client
        map[String, String] allParams = Object; // map[String, String] | 

        try {
            ItemsWrapperDTO result = apiInstance.listAllPropertiesForClient(extId, allParams);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRESTServiceApi#listAllPropertiesForClient");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClientRESTServiceApi *apiInstance = [[ClientRESTServiceApi alloc] init];
String *extId = 1000; // ExtID of the client (default to null)
map[String, String] *allParams = Object; //  (default to null)

// Get all the properties for a client
[apiInstance listAllPropertiesForClientWith:extId
    allParams:allParams
              completionHandler: ^(ItemsWrapperDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ClientRESTServiceApi()
var extId = 1000; // {String} ExtID of the client
var allParams = Object; // {map[String, String]} 

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

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

            // Create an instance of the API class
            var apiInstance = new ClientRESTServiceApi();
            var extId = 1000;  // String | ExtID of the client (default to null)
            var allParams = new map[String, String](); // map[String, String] |  (default to null)

            try {
                // Get all the properties for a client
                ItemsWrapperDTO result = apiInstance.listAllPropertiesForClient(extId, allParams);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClientRESTServiceApi.listAllPropertiesForClient: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClientRESTServiceApi();
$extId = 1000; // String | ExtID of the client
$allParams = Object; // map[String, String] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClientRESTServiceApi->new();
my $extId = 1000; # String | ExtID of the client
my $allParams = Object; # map[String, String] | 

eval {
    my $result = $api_instance->listAllPropertiesForClient(extId => $extId, allParams => $allParams);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientRESTServiceApi->listAllPropertiesForClient: $@\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.ClientRESTServiceApi()
extId = 1000 # String | ExtID of the client (default to null)
allParams = Object # map[String, String] |  (default to null)

try:
    # Get all the properties for a client
    api_response = api_instance.list_all_properties_for_client(extId, allParams)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientRESTServiceApi->listAllPropertiesForClient: %s\n" % e)
extern crate ClientRESTServiceApi;

pub fn main() {
    let extId = 1000; // String
    let allParams = Object; // map[String, String]

    let mut context = ClientRESTServiceApi::Context::default();
    let result = client.listAllPropertiesForClient(extId, allParams, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the client
Required
Query parameters
Name Description
allParams*
map[String, String]
Required

Responses


ContextPasswordLoginRESTService

contextPasswordLogin

contextPasswordLogin
post/auth/v1/{clientExtId}/users/{userExtId}/context-password/login

**Since:** 2.88.0 Log in with the defined context password credential of the user.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/auth/v1/{clientExtId}/users/{userExtId}/context-password/login" \
 -d '{
  "password" : "1StrongPassword!",
  "context" : "user1-context1"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContextPasswordLoginRESTServiceApi;

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

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

        // Create an instance of the API class
        ContextPasswordLoginRESTServiceApi apiInstance = new ContextPasswordLoginRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        ContextPasswordLoginDTO contextPasswordLoginDTO = {"password":"1StrongPassword!","context":"user1-context1"}; // ContextPasswordLoginDTO | 

        try {
            LoginStatusDTO result = apiInstance.contextPasswordLogin(clientExtId, userExtId, contextPasswordLoginDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContextPasswordLoginRESTServiceApi#contextPasswordLogin");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final ContextPasswordLoginDTO contextPasswordLoginDTO = new ContextPasswordLoginDTO(); // ContextPasswordLoginDTO | 

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

import org.openapitools.client.api.ContextPasswordLoginRESTServiceApi;

public class ContextPasswordLoginRESTServiceApiExample {
    public static void main(String[] args) {
        ContextPasswordLoginRESTServiceApi apiInstance = new ContextPasswordLoginRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        ContextPasswordLoginDTO contextPasswordLoginDTO = {"password":"1StrongPassword!","context":"user1-context1"}; // ContextPasswordLoginDTO | 

        try {
            LoginStatusDTO result = apiInstance.contextPasswordLogin(clientExtId, userExtId, contextPasswordLoginDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContextPasswordLoginRESTServiceApi#contextPasswordLogin");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ContextPasswordLoginRESTServiceApi *apiInstance = [[ContextPasswordLoginRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
ContextPasswordLoginDTO *contextPasswordLoginDTO = {"password":"1StrongPassword!","context":"user1-context1"}; // 

// Login with context password credential
[apiInstance contextPasswordLoginWith:clientExtId
    userExtId:userExtId
    contextPasswordLoginDTO:contextPasswordLoginDTO
              completionHandler: ^(LoginStatusDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ContextPasswordLoginRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var contextPasswordLoginDTO = {"password":"1StrongPassword!","context":"user1-context1"}; // {ContextPasswordLoginDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new ContextPasswordLoginRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var contextPasswordLoginDTO = new ContextPasswordLoginDTO(); // ContextPasswordLoginDTO | 

            try {
                // Login with context password credential
                LoginStatusDTO result = apiInstance.contextPasswordLogin(clientExtId, userExtId, contextPasswordLoginDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContextPasswordLoginRESTServiceApi.contextPasswordLogin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContextPasswordLoginRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$contextPasswordLoginDTO = {"password":"1StrongPassword!","context":"user1-context1"}; // ContextPasswordLoginDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContextPasswordLoginRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $contextPasswordLoginDTO = WWW::OPenAPIClient::Object::ContextPasswordLoginDTO->new(); # ContextPasswordLoginDTO | 

eval {
    my $result = $api_instance->contextPasswordLogin(clientExtId => $clientExtId, userExtId => $userExtId, contextPasswordLoginDTO => $contextPasswordLoginDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContextPasswordLoginRESTServiceApi->contextPasswordLogin: $@\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.ContextPasswordLoginRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
contextPasswordLoginDTO = {"password":"1StrongPassword!","context":"user1-context1"} # ContextPasswordLoginDTO | 

try:
    # Login with context password credential
    api_response = api_instance.context_password_login(clientExtId, userExtId, contextPasswordLoginDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContextPasswordLoginRESTServiceApi->contextPasswordLogin: %s\n" % e)
extern crate ContextPasswordLoginRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let contextPasswordLoginDTO = {"password":"1StrongPassword!","context":"user1-context1"}; // ContextPasswordLoginDTO

    let mut context = ContextPasswordLoginRESTServiceApi::Context::default();
    let result = client.contextPasswordLogin(clientExtId, userExtId, contextPasswordLoginDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
contextPasswordLoginDTO *

Responses


ContextPasswordRESTService

changeContextPassword

changeContextPassword
post/core/v1/{clientExtId}/users/{userExtId}/context-passwords/{extId}/change

**Since:** 2.73.0 **Required permission(s):** `AccessControl.CredentialModify` or `SelfAdmin` Role Changes the context password of the user with the given external ID to the given new password. If the user is a self-admin, the old password must be provided and validated.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/context-passwords/{extId}/change" \
 -d '{
  "oldPassword" : "oldPassword",
  "newPassword" : "newPassword"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContextPasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        ContextPasswordRESTServiceApi apiInstance = new ContextPasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 27000030; // String | ExtID of the credential
        PasswordChangeDTO passwordChangeDTO = {"oldPassword":"oldSecret","newPassword":"newSecret"}; // PasswordChangeDTO | 

        try {
            apiInstance.changeContextPassword(clientExtId, userExtId, extId, passwordChangeDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContextPasswordRESTServiceApi#changeContextPassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential
final PasswordChangeDTO passwordChangeDTO = new PasswordChangeDTO(); // PasswordChangeDTO | 

try {
    final result = await api_instance.changeContextPassword(clientExtId, userExtId, extId, passwordChangeDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->changeContextPassword: $e\n');
}

import org.openapitools.client.api.ContextPasswordRESTServiceApi;

public class ContextPasswordRESTServiceApiExample {
    public static void main(String[] args) {
        ContextPasswordRESTServiceApi apiInstance = new ContextPasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 27000030; // String | ExtID of the credential
        PasswordChangeDTO passwordChangeDTO = {"oldPassword":"oldSecret","newPassword":"newSecret"}; // PasswordChangeDTO | 

        try {
            apiInstance.changeContextPassword(clientExtId, userExtId, extId, passwordChangeDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContextPasswordRESTServiceApi#changeContextPassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ContextPasswordRESTServiceApi *apiInstance = [[ContextPasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 27000030; // ExtID of the credential (default to null)
PasswordChangeDTO *passwordChangeDTO = {"oldPassword":"oldSecret","newPassword":"newSecret"}; // 

// Change context password
[apiInstance changeContextPasswordWith:clientExtId
    userExtId:userExtId
    extId:extId
    passwordChangeDTO:passwordChangeDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ContextPasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 27000030; // {String} ExtID of the credential
var passwordChangeDTO = {"oldPassword":"oldSecret","newPassword":"newSecret"}; // {PasswordChangeDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new ContextPasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 27000030;  // String | ExtID of the credential (default to null)
            var passwordChangeDTO = new PasswordChangeDTO(); // PasswordChangeDTO | 

            try {
                // Change context password
                apiInstance.changeContextPassword(clientExtId, userExtId, extId, passwordChangeDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContextPasswordRESTServiceApi.changeContextPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContextPasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 27000030; // String | ExtID of the credential
$passwordChangeDTO = {"oldPassword":"oldSecret","newPassword":"newSecret"}; // PasswordChangeDTO | 

try {
    $api_instance->changeContextPassword($clientExtId, $userExtId, $extId, $passwordChangeDTO);
} catch (Exception $e) {
    echo 'Exception when calling ContextPasswordRESTServiceApi->changeContextPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContextPasswordRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContextPasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 27000030; # String | ExtID of the credential
my $passwordChangeDTO = WWW::OPenAPIClient::Object::PasswordChangeDTO->new(); # PasswordChangeDTO | 

eval {
    $api_instance->changeContextPassword(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId, passwordChangeDTO => $passwordChangeDTO);
};
if ($@) {
    warn "Exception when calling ContextPasswordRESTServiceApi->changeContextPassword: $@\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.ContextPasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 27000030 # String | ExtID of the credential (default to null)
passwordChangeDTO = {"oldPassword":"oldSecret","newPassword":"newSecret"} # PasswordChangeDTO | 

try:
    # Change context password
    api_instance.change_context_password(clientExtId, userExtId, extId, passwordChangeDTO)
except ApiException as e:
    print("Exception when calling ContextPasswordRESTServiceApi->changeContextPassword: %s\n" % e)
extern crate ContextPasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 27000030; // String
    let passwordChangeDTO = {"oldPassword":"oldSecret","newPassword":"newSecret"}; // PasswordChangeDTO

    let mut context = ContextPasswordRESTServiceApi::Context::default();
    let result = client.changeContextPassword(clientExtId, userExtId, extId, passwordChangeDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required
Body parameters
Name Description
passwordChangeDTO *

Responses


createContextPassword

createContextPassword
post/core/v1/{clientExtId}/users/{userExtId}/context-passwords

**Since:** 2.73.0 **Required permission(s):** `AccessControl.CredentialCreate` Creates a context password for the given user. When resetCodeEnabled is set to false in the given context password policy, or resetCodeLen0 is set to 0 then 201 is returned. Otherwise, 201 with the passwordFragment.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/context-passwords" \
 -d '{
  "policyExtId" : "policyExtId",
  "password" : "password",
  "stateName" : "INITIAL",
  "context" : "context",
  "extId" : "extId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContextPasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        ContextPasswordRESTServiceApi apiInstance = new ContextPasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 27000029; // String | ExtID of the user
        ContextPasswordCreateDTO contextPasswordCreateDTO = {"extId":"1001","policyExtId":"201","stateName":"active","password":"secretpassword","context":"context"}; // ContextPasswordCreateDTO | 

        try {
            ContextPasswordCreatePasswordFragmentDTO result = apiInstance.createContextPassword(clientExtId, userExtId, contextPasswordCreateDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContextPasswordRESTServiceApi#createContextPassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final ContextPasswordCreateDTO contextPasswordCreateDTO = new ContextPasswordCreateDTO(); // ContextPasswordCreateDTO | 

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

import org.openapitools.client.api.ContextPasswordRESTServiceApi;

public class ContextPasswordRESTServiceApiExample {
    public static void main(String[] args) {
        ContextPasswordRESTServiceApi apiInstance = new ContextPasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 27000029; // String | ExtID of the user
        ContextPasswordCreateDTO contextPasswordCreateDTO = {"extId":"1001","policyExtId":"201","stateName":"active","password":"secretpassword","context":"context"}; // ContextPasswordCreateDTO | 

        try {
            ContextPasswordCreatePasswordFragmentDTO result = apiInstance.createContextPassword(clientExtId, userExtId, contextPasswordCreateDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContextPasswordRESTServiceApi#createContextPassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ContextPasswordRESTServiceApi *apiInstance = [[ContextPasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 27000029; // ExtID of the user (default to null)
ContextPasswordCreateDTO *contextPasswordCreateDTO = {"extId":"1001","policyExtId":"201","stateName":"active","password":"secretpassword","context":"context"}; // 

// Create context password
[apiInstance createContextPasswordWith:clientExtId
    userExtId:userExtId
    contextPasswordCreateDTO:contextPasswordCreateDTO
              completionHandler: ^(ContextPasswordCreatePasswordFragmentDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ContextPasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 27000029; // {String} ExtID of the user
var contextPasswordCreateDTO = {"extId":"1001","policyExtId":"201","stateName":"active","password":"secretpassword","context":"context"}; // {ContextPasswordCreateDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new ContextPasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 27000029;  // String | ExtID of the user (default to null)
            var contextPasswordCreateDTO = new ContextPasswordCreateDTO(); // ContextPasswordCreateDTO | 

            try {
                // Create context password
                ContextPasswordCreatePasswordFragmentDTO result = apiInstance.createContextPassword(clientExtId, userExtId, contextPasswordCreateDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContextPasswordRESTServiceApi.createContextPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContextPasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 27000029; // String | ExtID of the user
$contextPasswordCreateDTO = {"extId":"1001","policyExtId":"201","stateName":"active","password":"secretpassword","context":"context"}; // ContextPasswordCreateDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContextPasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 27000029; # String | ExtID of the user
my $contextPasswordCreateDTO = WWW::OPenAPIClient::Object::ContextPasswordCreateDTO->new(); # ContextPasswordCreateDTO | 

eval {
    my $result = $api_instance->createContextPassword(clientExtId => $clientExtId, userExtId => $userExtId, contextPasswordCreateDTO => $contextPasswordCreateDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContextPasswordRESTServiceApi->createContextPassword: $@\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.ContextPasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 27000029 # String | ExtID of the user (default to null)
contextPasswordCreateDTO = {"extId":"1001","policyExtId":"201","stateName":"active","password":"secretpassword","context":"context"} # ContextPasswordCreateDTO | 

try:
    # Create context password
    api_response = api_instance.create_context_password(clientExtId, userExtId, contextPasswordCreateDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContextPasswordRESTServiceApi->createContextPassword: %s\n" % e)
extern crate ContextPasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 27000029; // String
    let contextPasswordCreateDTO = {"extId":"1001","policyExtId":"201","stateName":"active","password":"secretpassword","context":"context"}; // ContextPasswordCreateDTO

    let mut context = ContextPasswordRESTServiceApi::Context::default();
    let result = client.createContextPassword(clientExtId, userExtId, contextPasswordCreateDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
contextPasswordCreateDTO *

Responses


deleteContextPassword

deleteContextPassword
delete/core/v1/{clientExtId}/users/{userExtId}/context-passwords/{extId}

**Since:** 2.73.0 **Required permission(s):** `AccessControl.CredentialDelete` or `SelfAdmin` Role Deletes the context password credential of the user with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/context-passwords/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContextPasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        ContextPasswordRESTServiceApi apiInstance = new ContextPasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 27000029; // String | ExtID of the context password credential

        try {
            apiInstance.deleteContextPassword(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContextPasswordRESTServiceApi#deleteContextPassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the context password credential

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

import org.openapitools.client.api.ContextPasswordRESTServiceApi;

public class ContextPasswordRESTServiceApiExample {
    public static void main(String[] args) {
        ContextPasswordRESTServiceApi apiInstance = new ContextPasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 27000029; // String | ExtID of the context password credential

        try {
            apiInstance.deleteContextPassword(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContextPasswordRESTServiceApi#deleteContextPassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ContextPasswordRESTServiceApi *apiInstance = [[ContextPasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 27000029; // ExtID of the context password credential (default to null)

// Delete context password
[apiInstance deleteContextPasswordWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ContextPasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 27000029; // {String} ExtID of the context password credential

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

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

            // Create an instance of the API class
            var apiInstance = new ContextPasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 27000029;  // String | ExtID of the context password credential (default to null)

            try {
                // Delete context password
                apiInstance.deleteContextPassword(clientExtId, userExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContextPasswordRESTServiceApi.deleteContextPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContextPasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 27000029; // String | ExtID of the context password credential

try {
    $api_instance->deleteContextPassword($clientExtId, $userExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling ContextPasswordRESTServiceApi->deleteContextPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContextPasswordRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContextPasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 27000029; # String | ExtID of the context password credential

eval {
    $api_instance->deleteContextPassword(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling ContextPasswordRESTServiceApi->deleteContextPassword: $@\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.ContextPasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 27000029 # String | ExtID of the context password credential (default to null)

try:
    # Delete context password
    api_instance.delete_context_password(clientExtId, userExtId, extId)
except ApiException as e:
    print("Exception when calling ContextPasswordRESTServiceApi->deleteContextPassword: %s\n" % e)
extern crate ContextPasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 27000029; // String

    let mut context = ContextPasswordRESTServiceApi::Context::default();
    let result = client.deleteContextPassword(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the context password credential
Required

Responses


getContextPassword

getContextPassword
get/core/v1/{clientExtId}/users/{userExtId}/context-passwords/{extId}

**Since:** 2.73.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Gets the context password credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/context-passwords/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContextPasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        ContextPasswordRESTServiceApi apiInstance = new ContextPasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 27000029; // String | ExtID of the context password credential

        try {
            ContextPasswordGetDTO result = apiInstance.getContextPassword(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContextPasswordRESTServiceApi#getContextPassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the context password credential

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

import org.openapitools.client.api.ContextPasswordRESTServiceApi;

public class ContextPasswordRESTServiceApiExample {
    public static void main(String[] args) {
        ContextPasswordRESTServiceApi apiInstance = new ContextPasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 27000029; // String | ExtID of the context password credential

        try {
            ContextPasswordGetDTO result = apiInstance.getContextPassword(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContextPasswordRESTServiceApi#getContextPassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ContextPasswordRESTServiceApi *apiInstance = [[ContextPasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 27000029; // ExtID of the context password credential (default to null)

// Get context password
[apiInstance getContextPasswordWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(ContextPasswordGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ContextPasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 27000029; // {String} ExtID of the context password credential

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

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

            // Create an instance of the API class
            var apiInstance = new ContextPasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 27000029;  // String | ExtID of the context password credential (default to null)

            try {
                // Get context password
                ContextPasswordGetDTO result = apiInstance.getContextPassword(clientExtId, userExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContextPasswordRESTServiceApi.getContextPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContextPasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 27000029; // String | ExtID of the context password credential

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContextPasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 27000029; # String | ExtID of the context password credential

eval {
    my $result = $api_instance->getContextPassword(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContextPasswordRESTServiceApi->getContextPassword: $@\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.ContextPasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 27000029 # String | ExtID of the context password credential (default to null)

try:
    # Get context password
    api_response = api_instance.get_context_password(clientExtId, userExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContextPasswordRESTServiceApi->getContextPassword: %s\n" % e)
extern crate ContextPasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 27000029; // String

    let mut context = ContextPasswordRESTServiceApi::Context::default();
    let result = client.getContextPassword(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the context password credential
Required

Responses


getContextPasswords

getContextPasswords
get/core/v1/{clientExtId}/users/{userExtId}/context-passwords

**Since:** 2.73.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns all context password credentials of the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/context-passwords?continuationToken=continuationToken_example&limit=1000"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContextPasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        ContextPasswordRESTServiceApi apiInstance = new ContextPasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForContextPasswordGetDTO result = apiInstance.getContextPasswords(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContextPasswordRESTServiceApi#getContextPasswords");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

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

import org.openapitools.client.api.ContextPasswordRESTServiceApi;

public class ContextPasswordRESTServiceApiExample {
    public static void main(String[] args) {
        ContextPasswordRESTServiceApi apiInstance = new ContextPasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForContextPasswordGetDTO result = apiInstance.getContextPasswords(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContextPasswordRESTServiceApi#getContextPasswords");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ContextPasswordRESTServiceApi *apiInstance = [[ContextPasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 1000; // Pagination limit (optional) (default to 0)

// Get all context passwords
[apiInstance getContextPasswordsWith:clientExtId
    userExtId:userExtId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForContextPasswordGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ContextPasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 1000 // {Integer} Pagination limit
};

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

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

            // Create an instance of the API class
            var apiInstance = new ContextPasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 1000;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get all context passwords
                ItemsWrapperForContextPasswordGetDTO result = apiInstance.getContextPasswords(clientExtId, userExtId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContextPasswordRESTServiceApi.getContextPasswords: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContextPasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 1000; // Integer | Pagination limit

try {
    $result = $api_instance->getContextPasswords($clientExtId, $userExtId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContextPasswordRESTServiceApi->getContextPasswords: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContextPasswordRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContextPasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 1000; # Integer | Pagination limit

eval {
    my $result = $api_instance->getContextPasswords(clientExtId => $clientExtId, userExtId => $userExtId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContextPasswordRESTServiceApi->getContextPasswords: $@\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.ContextPasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 1000 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get all context passwords
    api_response = api_instance.get_context_passwords(clientExtId, userExtId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContextPasswordRESTServiceApi->getContextPasswords: %s\n" % e)
extern crate ContextPasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let continuationToken = continuationToken_example; // String
    let limit = 1000; // Integer

    let mut context = ContextPasswordRESTServiceApi::Context::default();
    let result = client.getContextPasswords(clientExtId, userExtId, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


resetContextPassword

resetContextPassword
post/core/v1/{clientExtId}/users/{userExtId}/context-passwords/{extId}/reset

**Since:** 2.79.0 **Required permission(s):** `AccessControl.CredentialView,AccessControl.CredentialModify` or `SelfAdmin` Role Resets the context password of the user with the given external ID. Depending on the password policy, the response either contains a part of the generated password in the parameter passwordFragment or no content is returned.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/context-passwords/{extId}/reset"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContextPasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        ContextPasswordRESTServiceApi apiInstance = new ContextPasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 27000030; // String | ExtID of the credential

        try {
            PasswordFragmentDTO result = apiInstance.resetContextPassword(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContextPasswordRESTServiceApi#resetContextPassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential

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

import org.openapitools.client.api.ContextPasswordRESTServiceApi;

public class ContextPasswordRESTServiceApiExample {
    public static void main(String[] args) {
        ContextPasswordRESTServiceApi apiInstance = new ContextPasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 27000030; // String | ExtID of the credential

        try {
            PasswordFragmentDTO result = apiInstance.resetContextPassword(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContextPasswordRESTServiceApi#resetContextPassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ContextPasswordRESTServiceApi *apiInstance = [[ContextPasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 27000030; // ExtID of the credential (default to null)

// Reset context password
[apiInstance resetContextPasswordWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(PasswordFragmentDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ContextPasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 27000030; // {String} ExtID of the credential

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

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

            // Create an instance of the API class
            var apiInstance = new ContextPasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 27000030;  // String | ExtID of the credential (default to null)

            try {
                // Reset context password
                PasswordFragmentDTO result = apiInstance.resetContextPassword(clientExtId, userExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContextPasswordRESTServiceApi.resetContextPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContextPasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 27000030; // String | ExtID of the credential

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContextPasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 27000030; # String | ExtID of the credential

eval {
    my $result = $api_instance->resetContextPassword(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContextPasswordRESTServiceApi->resetContextPassword: $@\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.ContextPasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 27000030 # String | ExtID of the credential (default to null)

try:
    # Reset context password
    api_response = api_instance.reset_context_password(clientExtId, userExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContextPasswordRESTServiceApi->resetContextPassword: %s\n" % e)
extern crate ContextPasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 27000030; // String

    let mut context = ContextPasswordRESTServiceApi::Context::default();
    let result = client.resetContextPassword(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required

Responses


updateContextPassword

updateContextPassword
patch/core/v1/{clientExtId}/users/{userExtId}/context-passwords/{extId}

**Since:** 2.73.0 **Required permission(s):** `AccessControl.CredentialView,AccessControl.CredentialModify` Updates a context password for the given user.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/context-passwords/{extId}" \
 -d '{
  "stateName" : "INITIAL",
  "modificationComment" : "modificationComment",
  "version" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContextPasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        ContextPasswordRESTServiceApi apiInstance = new ContextPasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 27000029; // String | ExtID of the user
        String extId = 27000030; // String | ExtID of the credential
        ContextPasswordPatchDTO contextPasswordPatchDTO = {"stateName":"active","modificationComment":"no comment","version":2}; // ContextPasswordPatchDTO | 

        try {
            ContextPasswordGetDTO result = apiInstance.updateContextPassword(clientExtId, userExtId, extId, contextPasswordPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContextPasswordRESTServiceApi#updateContextPassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential
final ContextPasswordPatchDTO contextPasswordPatchDTO = new ContextPasswordPatchDTO(); // ContextPasswordPatchDTO | 

try {
    final result = await api_instance.updateContextPassword(clientExtId, userExtId, extId, contextPasswordPatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateContextPassword: $e\n');
}

import org.openapitools.client.api.ContextPasswordRESTServiceApi;

public class ContextPasswordRESTServiceApiExample {
    public static void main(String[] args) {
        ContextPasswordRESTServiceApi apiInstance = new ContextPasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 27000029; // String | ExtID of the user
        String extId = 27000030; // String | ExtID of the credential
        ContextPasswordPatchDTO contextPasswordPatchDTO = {"stateName":"active","modificationComment":"no comment","version":2}; // ContextPasswordPatchDTO | 

        try {
            ContextPasswordGetDTO result = apiInstance.updateContextPassword(clientExtId, userExtId, extId, contextPasswordPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContextPasswordRESTServiceApi#updateContextPassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ContextPasswordRESTServiceApi *apiInstance = [[ContextPasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 27000029; // ExtID of the user (default to null)
String *extId = 27000030; // ExtID of the credential (default to null)
ContextPasswordPatchDTO *contextPasswordPatchDTO = {"stateName":"active","modificationComment":"no comment","version":2}; // 

// Update context password
[apiInstance updateContextPasswordWith:clientExtId
    userExtId:userExtId
    extId:extId
    contextPasswordPatchDTO:contextPasswordPatchDTO
              completionHandler: ^(ContextPasswordGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ContextPasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 27000029; // {String} ExtID of the user
var extId = 27000030; // {String} ExtID of the credential
var contextPasswordPatchDTO = {"stateName":"active","modificationComment":"no comment","version":2}; // {ContextPasswordPatchDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new ContextPasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 27000029;  // String | ExtID of the user (default to null)
            var extId = 27000030;  // String | ExtID of the credential (default to null)
            var contextPasswordPatchDTO = new ContextPasswordPatchDTO(); // ContextPasswordPatchDTO | 

            try {
                // Update context password
                ContextPasswordGetDTO result = apiInstance.updateContextPassword(clientExtId, userExtId, extId, contextPasswordPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContextPasswordRESTServiceApi.updateContextPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContextPasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 27000029; // String | ExtID of the user
$extId = 27000030; // String | ExtID of the credential
$contextPasswordPatchDTO = {"stateName":"active","modificationComment":"no comment","version":2}; // ContextPasswordPatchDTO | 

try {
    $result = $api_instance->updateContextPassword($clientExtId, $userExtId, $extId, $contextPasswordPatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContextPasswordRESTServiceApi->updateContextPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContextPasswordRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContextPasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 27000029; # String | ExtID of the user
my $extId = 27000030; # String | ExtID of the credential
my $contextPasswordPatchDTO = WWW::OPenAPIClient::Object::ContextPasswordPatchDTO->new(); # ContextPasswordPatchDTO | 

eval {
    my $result = $api_instance->updateContextPassword(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId, contextPasswordPatchDTO => $contextPasswordPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContextPasswordRESTServiceApi->updateContextPassword: $@\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.ContextPasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 27000029 # String | ExtID of the user (default to null)
extId = 27000030 # String | ExtID of the credential (default to null)
contextPasswordPatchDTO = {"stateName":"active","modificationComment":"no comment","version":2} # ContextPasswordPatchDTO | 

try:
    # Update context password
    api_response = api_instance.update_context_password(clientExtId, userExtId, extId, contextPasswordPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContextPasswordRESTServiceApi->updateContextPassword: %s\n" % e)
extern crate ContextPasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 27000029; // String
    let extId = 27000030; // String
    let contextPasswordPatchDTO = {"stateName":"active","modificationComment":"no comment","version":2}; // ContextPasswordPatchDTO

    let mut context = ContextPasswordRESTServiceApi::Context::default();
    let result = client.updateContextPassword(clientExtId, userExtId, extId, contextPasswordPatchDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required
Body parameters
Name Description
contextPasswordPatchDTO *

Responses


DevicePasswordLoginRESTService

passwordLogin1

passwordLogin1
post/auth/v1/{clientExtId}/users/{userExtId}/device-password/login

**Since:** 2.88.0 Log in with the defined device password credential of the user.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/auth/v1/{clientExtId}/users/{userExtId}/device-password/login" \
 -d '{
  "password" : "1StrongPassword!",
  "credentialExtId" : "user1-devicePassword1"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicePasswordLoginRESTServiceApi;

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

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

        // Create an instance of the API class
        DevicePasswordLoginRESTServiceApi apiInstance = new DevicePasswordLoginRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        DevicePasswordLoginDTO devicePasswordLoginDTO = {"password":"1StrongPassword!","credentialExtId":"user1-devicePassword1"}; // DevicePasswordLoginDTO | 

        try {
            LoginStatus result = apiInstance.passwordLogin1(clientExtId, userExtId, devicePasswordLoginDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordLoginRESTServiceApi#passwordLogin1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final DevicePasswordLoginDTO devicePasswordLoginDTO = new DevicePasswordLoginDTO(); // DevicePasswordLoginDTO | 

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

import org.openapitools.client.api.DevicePasswordLoginRESTServiceApi;

public class DevicePasswordLoginRESTServiceApiExample {
    public static void main(String[] args) {
        DevicePasswordLoginRESTServiceApi apiInstance = new DevicePasswordLoginRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        DevicePasswordLoginDTO devicePasswordLoginDTO = {"password":"1StrongPassword!","credentialExtId":"user1-devicePassword1"}; // DevicePasswordLoginDTO | 

        try {
            LoginStatus result = apiInstance.passwordLogin1(clientExtId, userExtId, devicePasswordLoginDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordLoginRESTServiceApi#passwordLogin1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DevicePasswordLoginRESTServiceApi *apiInstance = [[DevicePasswordLoginRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
DevicePasswordLoginDTO *devicePasswordLoginDTO = {"password":"1StrongPassword!","credentialExtId":"user1-devicePassword1"}; // 

// Login with device password credential
[apiInstance passwordLogin1With:clientExtId
    userExtId:userExtId
    devicePasswordLoginDTO:devicePasswordLoginDTO
              completionHandler: ^(LoginStatus output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.DevicePasswordLoginRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var devicePasswordLoginDTO = {"password":"1StrongPassword!","credentialExtId":"user1-devicePassword1"}; // {DevicePasswordLoginDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new DevicePasswordLoginRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var devicePasswordLoginDTO = new DevicePasswordLoginDTO(); // DevicePasswordLoginDTO | 

            try {
                // Login with device password credential
                LoginStatus result = apiInstance.passwordLogin1(clientExtId, userExtId, devicePasswordLoginDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicePasswordLoginRESTServiceApi.passwordLogin1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicePasswordLoginRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$devicePasswordLoginDTO = {"password":"1StrongPassword!","credentialExtId":"user1-devicePassword1"}; // DevicePasswordLoginDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicePasswordLoginRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $devicePasswordLoginDTO = WWW::OPenAPIClient::Object::DevicePasswordLoginDTO->new(); # DevicePasswordLoginDTO | 

eval {
    my $result = $api_instance->passwordLogin1(clientExtId => $clientExtId, userExtId => $userExtId, devicePasswordLoginDTO => $devicePasswordLoginDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicePasswordLoginRESTServiceApi->passwordLogin1: $@\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.DevicePasswordLoginRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
devicePasswordLoginDTO = {"password":"1StrongPassword!","credentialExtId":"user1-devicePassword1"} # DevicePasswordLoginDTO | 

try:
    # Login with device password credential
    api_response = api_instance.password_login1(clientExtId, userExtId, devicePasswordLoginDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicePasswordLoginRESTServiceApi->passwordLogin1: %s\n" % e)
extern crate DevicePasswordLoginRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let devicePasswordLoginDTO = {"password":"1StrongPassword!","credentialExtId":"user1-devicePassword1"}; // DevicePasswordLoginDTO

    let mut context = DevicePasswordLoginRESTServiceApi::Context::default();
    let result = client.passwordLogin1(clientExtId, userExtId, devicePasswordLoginDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
devicePasswordLoginDTO *

Responses


DevicePasswordRESTService

changeDevicePassword

changeDevicePassword
post/core/v1/{clientExtId}/users/{userExtId}/device-password/{extId}/change

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialModify` or `SelfAdmin` Role Changes the Device password of the user with the given external ID. The oldPassword parameter in the request body is mandatory if a caller wants to change his own password. If the caller wants to change the password of another user, the oldPassword parameter in the request body has to be omitted.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/device-password/{extId}/change" \
 -d '{
  "oldPassword" : "oldPassword",
  "newPassword" : "newPassword"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicePasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 5678; // String | ExtID of the credential
        PasswordChangeDTO passwordChangeDTO = {oldPassword=oldPassword, newPassword=newSecretPassword}; // PasswordChangeDTO | 

        try {
            apiInstance.changeDevicePassword(clientExtId, userExtId, extId, passwordChangeDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#changeDevicePassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential
final PasswordChangeDTO passwordChangeDTO = new PasswordChangeDTO(); // PasswordChangeDTO | 

try {
    final result = await api_instance.changeDevicePassword(clientExtId, userExtId, extId, passwordChangeDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->changeDevicePassword: $e\n');
}

import org.openapitools.client.api.DevicePasswordRESTServiceApi;

public class DevicePasswordRESTServiceApiExample {
    public static void main(String[] args) {
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 5678; // String | ExtID of the credential
        PasswordChangeDTO passwordChangeDTO = {oldPassword=oldPassword, newPassword=newSecretPassword}; // PasswordChangeDTO | 

        try {
            apiInstance.changeDevicePassword(clientExtId, userExtId, extId, passwordChangeDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#changeDevicePassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DevicePasswordRESTServiceApi *apiInstance = [[DevicePasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 5678; // ExtID of the credential (default to null)
PasswordChangeDTO *passwordChangeDTO = {oldPassword=oldPassword, newPassword=newSecretPassword}; // 

// Change Device password
[apiInstance changeDevicePasswordWith:clientExtId
    userExtId:userExtId
    extId:extId
    passwordChangeDTO:passwordChangeDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.DevicePasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 5678; // {String} ExtID of the credential
var passwordChangeDTO = {oldPassword=oldPassword, newPassword=newSecretPassword}; // {PasswordChangeDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new DevicePasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 5678;  // String | ExtID of the credential (default to null)
            var passwordChangeDTO = new PasswordChangeDTO(); // PasswordChangeDTO | 

            try {
                // Change Device password
                apiInstance.changeDevicePassword(clientExtId, userExtId, extId, passwordChangeDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicePasswordRESTServiceApi.changeDevicePassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicePasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 5678; // String | ExtID of the credential
$passwordChangeDTO = {oldPassword=oldPassword, newPassword=newSecretPassword}; // PasswordChangeDTO | 

try {
    $api_instance->changeDevicePassword($clientExtId, $userExtId, $extId, $passwordChangeDTO);
} catch (Exception $e) {
    echo 'Exception when calling DevicePasswordRESTServiceApi->changeDevicePassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DevicePasswordRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicePasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 5678; # String | ExtID of the credential
my $passwordChangeDTO = WWW::OPenAPIClient::Object::PasswordChangeDTO->new(); # PasswordChangeDTO | 

eval {
    $api_instance->changeDevicePassword(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId, passwordChangeDTO => $passwordChangeDTO);
};
if ($@) {
    warn "Exception when calling DevicePasswordRESTServiceApi->changeDevicePassword: $@\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.DevicePasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 5678 # String | ExtID of the credential (default to null)
passwordChangeDTO = {oldPassword=oldPassword, newPassword=newSecretPassword} # PasswordChangeDTO | 

try:
    # Change Device password
    api_instance.change_device_password(clientExtId, userExtId, extId, passwordChangeDTO)
except ApiException as e:
    print("Exception when calling DevicePasswordRESTServiceApi->changeDevicePassword: %s\n" % e)
extern crate DevicePasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 5678; // String
    let passwordChangeDTO = {oldPassword=oldPassword, newPassword=newSecretPassword}; // PasswordChangeDTO

    let mut context = DevicePasswordRESTServiceApi::Context::default();
    let result = client.changeDevicePassword(clientExtId, userExtId, extId, passwordChangeDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required
Body parameters
Name Description
passwordChangeDTO *

Responses


changeDevicePassword1

changeDevicePassword1
post/core/v1/{clientExtId}/users/{userExtId}/device-passwords/{extId}/change

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialModify` or `SelfAdmin` Role Changes the Device password of the user with the given external ID. The oldPassword parameter in the request body is mandatory if a caller wants to change his own password. If the caller wants to change the password of another user, the oldPassword parameter in the request body has to be omitted.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/device-passwords/{extId}/change" \
 -d '{
  "oldPassword" : "oldPassword",
  "newPassword" : "newPassword"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicePasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 5678; // String | ExtID of the credential
        PasswordChangeDTO passwordChangeDTO = {oldPassword=oldPassword, newPassword=newSecretPassword}; // PasswordChangeDTO | 

        try {
            apiInstance.changeDevicePassword1(clientExtId, userExtId, extId, passwordChangeDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#changeDevicePassword1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential
final PasswordChangeDTO passwordChangeDTO = new PasswordChangeDTO(); // PasswordChangeDTO | 

try {
    final result = await api_instance.changeDevicePassword1(clientExtId, userExtId, extId, passwordChangeDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->changeDevicePassword1: $e\n');
}

import org.openapitools.client.api.DevicePasswordRESTServiceApi;

public class DevicePasswordRESTServiceApiExample {
    public static void main(String[] args) {
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 5678; // String | ExtID of the credential
        PasswordChangeDTO passwordChangeDTO = {oldPassword=oldPassword, newPassword=newSecretPassword}; // PasswordChangeDTO | 

        try {
            apiInstance.changeDevicePassword1(clientExtId, userExtId, extId, passwordChangeDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#changeDevicePassword1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DevicePasswordRESTServiceApi *apiInstance = [[DevicePasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 5678; // ExtID of the credential (default to null)
PasswordChangeDTO *passwordChangeDTO = {oldPassword=oldPassword, newPassword=newSecretPassword}; // 

// Change Device password
[apiInstance changeDevicePassword1With:clientExtId
    userExtId:userExtId
    extId:extId
    passwordChangeDTO:passwordChangeDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.DevicePasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 5678; // {String} ExtID of the credential
var passwordChangeDTO = {oldPassword=oldPassword, newPassword=newSecretPassword}; // {PasswordChangeDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new DevicePasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 5678;  // String | ExtID of the credential (default to null)
            var passwordChangeDTO = new PasswordChangeDTO(); // PasswordChangeDTO | 

            try {
                // Change Device password
                apiInstance.changeDevicePassword1(clientExtId, userExtId, extId, passwordChangeDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicePasswordRESTServiceApi.changeDevicePassword1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicePasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 5678; // String | ExtID of the credential
$passwordChangeDTO = {oldPassword=oldPassword, newPassword=newSecretPassword}; // PasswordChangeDTO | 

try {
    $api_instance->changeDevicePassword1($clientExtId, $userExtId, $extId, $passwordChangeDTO);
} catch (Exception $e) {
    echo 'Exception when calling DevicePasswordRESTServiceApi->changeDevicePassword1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DevicePasswordRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicePasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 5678; # String | ExtID of the credential
my $passwordChangeDTO = WWW::OPenAPIClient::Object::PasswordChangeDTO->new(); # PasswordChangeDTO | 

eval {
    $api_instance->changeDevicePassword1(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId, passwordChangeDTO => $passwordChangeDTO);
};
if ($@) {
    warn "Exception when calling DevicePasswordRESTServiceApi->changeDevicePassword1: $@\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.DevicePasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 5678 # String | ExtID of the credential (default to null)
passwordChangeDTO = {oldPassword=oldPassword, newPassword=newSecretPassword} # PasswordChangeDTO | 

try:
    # Change Device password
    api_instance.change_device_password1(clientExtId, userExtId, extId, passwordChangeDTO)
except ApiException as e:
    print("Exception when calling DevicePasswordRESTServiceApi->changeDevicePassword1: %s\n" % e)
extern crate DevicePasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 5678; // String
    let passwordChangeDTO = {oldPassword=oldPassword, newPassword=newSecretPassword}; // PasswordChangeDTO

    let mut context = DevicePasswordRESTServiceApi::Context::default();
    let result = client.changeDevicePassword1(clientExtId, userExtId, extId, passwordChangeDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required
Body parameters
Name Description
passwordChangeDTO *

Responses


createDevicePassword

createDevicePassword
post/core/v1/{clientExtId}/users/{userExtId}/device-password

**Required permission(s):** `AccessControl.CredentialCreate` Creates a new Device password for the user with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/device-password" \
 -d '{
  "policyExtId" : "policy-456",
  "password" : "password",
  "stateName" : "active",
  "extId" : "credential-123"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicePasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        DevicePasswordCreateDTO devicePasswordCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active"}; // DevicePasswordCreateDTO | 

        try {
            DevicePasswordCreatePasswordFragmentDTO result = apiInstance.createDevicePassword(clientExtId, userExtId, devicePasswordCreateDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#createDevicePassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final DevicePasswordCreateDTO devicePasswordCreateDTO = new DevicePasswordCreateDTO(); // DevicePasswordCreateDTO | 

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

import org.openapitools.client.api.DevicePasswordRESTServiceApi;

public class DevicePasswordRESTServiceApiExample {
    public static void main(String[] args) {
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        DevicePasswordCreateDTO devicePasswordCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active"}; // DevicePasswordCreateDTO | 

        try {
            DevicePasswordCreatePasswordFragmentDTO result = apiInstance.createDevicePassword(clientExtId, userExtId, devicePasswordCreateDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#createDevicePassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DevicePasswordRESTServiceApi *apiInstance = [[DevicePasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
DevicePasswordCreateDTO *devicePasswordCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active"}; // 

// Create a Device password
[apiInstance createDevicePasswordWith:clientExtId
    userExtId:userExtId
    devicePasswordCreateDTO:devicePasswordCreateDTO
              completionHandler: ^(DevicePasswordCreatePasswordFragmentDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.DevicePasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var devicePasswordCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active"}; // {DevicePasswordCreateDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new DevicePasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var devicePasswordCreateDTO = new DevicePasswordCreateDTO(); // DevicePasswordCreateDTO | 

            try {
                // Create a Device password
                DevicePasswordCreatePasswordFragmentDTO result = apiInstance.createDevicePassword(clientExtId, userExtId, devicePasswordCreateDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicePasswordRESTServiceApi.createDevicePassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicePasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$devicePasswordCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active"}; // DevicePasswordCreateDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicePasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $devicePasswordCreateDTO = WWW::OPenAPIClient::Object::DevicePasswordCreateDTO->new(); # DevicePasswordCreateDTO | 

eval {
    my $result = $api_instance->createDevicePassword(clientExtId => $clientExtId, userExtId => $userExtId, devicePasswordCreateDTO => $devicePasswordCreateDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicePasswordRESTServiceApi->createDevicePassword: $@\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.DevicePasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
devicePasswordCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active"} # DevicePasswordCreateDTO | 

try:
    # Create a Device password
    api_response = api_instance.create_device_password(clientExtId, userExtId, devicePasswordCreateDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicePasswordRESTServiceApi->createDevicePassword: %s\n" % e)
extern crate DevicePasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let devicePasswordCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active"}; // DevicePasswordCreateDTO

    let mut context = DevicePasswordRESTServiceApi::Context::default();
    let result = client.createDevicePassword(clientExtId, userExtId, devicePasswordCreateDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
devicePasswordCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

createDevicePassword1

createDevicePassword1
post/core/v1/{clientExtId}/users/{userExtId}/device-passwords

**Required permission(s):** `AccessControl.CredentialCreate` Creates a new Device password for the user with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/device-passwords" \
 -d '{
  "policyExtId" : "policy-456",
  "password" : "password",
  "stateName" : "active",
  "extId" : "credential-123"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicePasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        DevicePasswordCreateDTO devicePasswordCreateDTO = {extId=4500, policyExtId=6789, identification=someIdentification, stateName=active}; // DevicePasswordCreateDTO | 

        try {
            DevicePasswordCreatePasswordFragmentDTO result = apiInstance.createDevicePassword1(clientExtId, userExtId, devicePasswordCreateDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#createDevicePassword1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final DevicePasswordCreateDTO devicePasswordCreateDTO = new DevicePasswordCreateDTO(); // DevicePasswordCreateDTO | 

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

import org.openapitools.client.api.DevicePasswordRESTServiceApi;

public class DevicePasswordRESTServiceApiExample {
    public static void main(String[] args) {
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        DevicePasswordCreateDTO devicePasswordCreateDTO = {extId=4500, policyExtId=6789, identification=someIdentification, stateName=active}; // DevicePasswordCreateDTO | 

        try {
            DevicePasswordCreatePasswordFragmentDTO result = apiInstance.createDevicePassword1(clientExtId, userExtId, devicePasswordCreateDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#createDevicePassword1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DevicePasswordRESTServiceApi *apiInstance = [[DevicePasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
DevicePasswordCreateDTO *devicePasswordCreateDTO = {extId=4500, policyExtId=6789, identification=someIdentification, stateName=active}; // 

// Create a Device password
[apiInstance createDevicePassword1With:clientExtId
    userExtId:userExtId
    devicePasswordCreateDTO:devicePasswordCreateDTO
              completionHandler: ^(DevicePasswordCreatePasswordFragmentDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.DevicePasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var devicePasswordCreateDTO = {extId=4500, policyExtId=6789, identification=someIdentification, stateName=active}; // {DevicePasswordCreateDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new DevicePasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var devicePasswordCreateDTO = new DevicePasswordCreateDTO(); // DevicePasswordCreateDTO | 

            try {
                // Create a Device password
                DevicePasswordCreatePasswordFragmentDTO result = apiInstance.createDevicePassword1(clientExtId, userExtId, devicePasswordCreateDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicePasswordRESTServiceApi.createDevicePassword1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicePasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$devicePasswordCreateDTO = {extId=4500, policyExtId=6789, identification=someIdentification, stateName=active}; // DevicePasswordCreateDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicePasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $devicePasswordCreateDTO = WWW::OPenAPIClient::Object::DevicePasswordCreateDTO->new(); # DevicePasswordCreateDTO | 

eval {
    my $result = $api_instance->createDevicePassword1(clientExtId => $clientExtId, userExtId => $userExtId, devicePasswordCreateDTO => $devicePasswordCreateDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicePasswordRESTServiceApi->createDevicePassword1: $@\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.DevicePasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
devicePasswordCreateDTO = {extId=4500, policyExtId=6789, identification=someIdentification, stateName=active} # DevicePasswordCreateDTO | 

try:
    # Create a Device password
    api_response = api_instance.create_device_password1(clientExtId, userExtId, devicePasswordCreateDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicePasswordRESTServiceApi->createDevicePassword1: %s\n" % e)
extern crate DevicePasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let devicePasswordCreateDTO = {extId=4500, policyExtId=6789, identification=someIdentification, stateName=active}; // DevicePasswordCreateDTO

    let mut context = DevicePasswordRESTServiceApi::Context::default();
    let result = client.createDevicePassword1(clientExtId, userExtId, devicePasswordCreateDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
devicePasswordCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

deleteDevicePasswordById

deleteDevicePasswordById
delete/core/v1/{clientExtId}/users/{userExtId}/device-passwords/{extId}

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialDelete` or `SelfAdmin` Role Deletes the Device password credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/device-passwords/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicePasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            apiInstance.deleteDevicePasswordById(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#deleteDevicePasswordById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential

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

import org.openapitools.client.api.DevicePasswordRESTServiceApi;

public class DevicePasswordRESTServiceApiExample {
    public static void main(String[] args) {
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            apiInstance.deleteDevicePasswordById(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#deleteDevicePasswordById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DevicePasswordRESTServiceApi *apiInstance = [[DevicePasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000002; // ExtID of the credential (default to null)

// Delete Device password
[apiInstance deleteDevicePasswordByIdWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.DevicePasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000002; // {String} ExtID of the credential

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

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

            // Create an instance of the API class
            var apiInstance = new DevicePasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000002;  // String | ExtID of the credential (default to null)

            try {
                // Delete Device password
                apiInstance.deleteDevicePasswordById(clientExtId, userExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicePasswordRESTServiceApi.deleteDevicePasswordById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicePasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000002; // String | ExtID of the credential

try {
    $api_instance->deleteDevicePasswordById($clientExtId, $userExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling DevicePasswordRESTServiceApi->deleteDevicePasswordById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DevicePasswordRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicePasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000002; # String | ExtID of the credential

eval {
    $api_instance->deleteDevicePasswordById(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling DevicePasswordRESTServiceApi->deleteDevicePasswordById: $@\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.DevicePasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000002 # String | ExtID of the credential (default to null)

try:
    # Delete Device password
    api_instance.delete_device_password_by_id(clientExtId, userExtId, extId)
except ApiException as e:
    print("Exception when calling DevicePasswordRESTServiceApi->deleteDevicePasswordById: %s\n" % e)
extern crate DevicePasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000002; // String

    let mut context = DevicePasswordRESTServiceApi::Context::default();
    let result = client.deleteDevicePasswordById(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required

Responses


deleteDevicePasswordById1

deleteDevicePasswordById1
delete/core/v1/{clientExtId}/users/{userExtId}/device-password/{extId}

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialDelete` or `SelfAdmin` Role Deletes the Device password credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/device-password/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicePasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            apiInstance.deleteDevicePasswordById1(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#deleteDevicePasswordById1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential

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

import org.openapitools.client.api.DevicePasswordRESTServiceApi;

public class DevicePasswordRESTServiceApiExample {
    public static void main(String[] args) {
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            apiInstance.deleteDevicePasswordById1(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#deleteDevicePasswordById1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DevicePasswordRESTServiceApi *apiInstance = [[DevicePasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000002; // ExtID of the credential (default to null)

// Delete Device password
[apiInstance deleteDevicePasswordById1With:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.DevicePasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000002; // {String} ExtID of the credential

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

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

            // Create an instance of the API class
            var apiInstance = new DevicePasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000002;  // String | ExtID of the credential (default to null)

            try {
                // Delete Device password
                apiInstance.deleteDevicePasswordById1(clientExtId, userExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicePasswordRESTServiceApi.deleteDevicePasswordById1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicePasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000002; // String | ExtID of the credential

try {
    $api_instance->deleteDevicePasswordById1($clientExtId, $userExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling DevicePasswordRESTServiceApi->deleteDevicePasswordById1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DevicePasswordRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicePasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000002; # String | ExtID of the credential

eval {
    $api_instance->deleteDevicePasswordById1(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling DevicePasswordRESTServiceApi->deleteDevicePasswordById1: $@\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.DevicePasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000002 # String | ExtID of the credential (default to null)

try:
    # Delete Device password
    api_instance.delete_device_password_by_id1(clientExtId, userExtId, extId)
except ApiException as e:
    print("Exception when calling DevicePasswordRESTServiceApi->deleteDevicePasswordById1: %s\n" % e)
extern crate DevicePasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000002; // String

    let mut context = DevicePasswordRESTServiceApi::Context::default();
    let result = client.deleteDevicePasswordById1(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required

Responses


getAllDevicePasswords

getAllDevicePasswords
get/core/v1/{clientExtId}/users/{userExtId}/device-password

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns all the Device password credentials of the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/device-password?continuationToken=continuationToken_example&limit=1000"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicePasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForDevicePasswordGetDTO result = apiInstance.getAllDevicePasswords(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#getAllDevicePasswords");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

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

import org.openapitools.client.api.DevicePasswordRESTServiceApi;

public class DevicePasswordRESTServiceApiExample {
    public static void main(String[] args) {
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForDevicePasswordGetDTO result = apiInstance.getAllDevicePasswords(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#getAllDevicePasswords");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DevicePasswordRESTServiceApi *apiInstance = [[DevicePasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 1000; // Pagination limit (optional) (default to 0)

// Get user Device password credentials
[apiInstance getAllDevicePasswordsWith:clientExtId
    userExtId:userExtId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForDevicePasswordGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.DevicePasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 1000 // {Integer} Pagination limit
};

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

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

            // Create an instance of the API class
            var apiInstance = new DevicePasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 1000;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get user Device password credentials
                ItemsWrapperForDevicePasswordGetDTO result = apiInstance.getAllDevicePasswords(clientExtId, userExtId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicePasswordRESTServiceApi.getAllDevicePasswords: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicePasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 1000; // Integer | Pagination limit

try {
    $result = $api_instance->getAllDevicePasswords($clientExtId, $userExtId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DevicePasswordRESTServiceApi->getAllDevicePasswords: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DevicePasswordRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicePasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 1000; # Integer | Pagination limit

eval {
    my $result = $api_instance->getAllDevicePasswords(clientExtId => $clientExtId, userExtId => $userExtId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicePasswordRESTServiceApi->getAllDevicePasswords: $@\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.DevicePasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 1000 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get user Device password credentials
    api_response = api_instance.get_all_device_passwords(clientExtId, userExtId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicePasswordRESTServiceApi->getAllDevicePasswords: %s\n" % e)
extern crate DevicePasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let continuationToken = continuationToken_example; // String
    let limit = 1000; // Integer

    let mut context = DevicePasswordRESTServiceApi::Context::default();
    let result = client.getAllDevicePasswords(clientExtId, userExtId, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


getAllDevicePasswords1

getAllDevicePasswords1
get/core/v1/{clientExtId}/users/{userExtId}/device-passwords

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns all the Device password credentials of the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/device-passwords?continuationToken=continuationToken_example&limit=1000"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicePasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForDevicePasswordGetDTO result = apiInstance.getAllDevicePasswords1(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#getAllDevicePasswords1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

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

import org.openapitools.client.api.DevicePasswordRESTServiceApi;

public class DevicePasswordRESTServiceApiExample {
    public static void main(String[] args) {
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForDevicePasswordGetDTO result = apiInstance.getAllDevicePasswords1(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#getAllDevicePasswords1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DevicePasswordRESTServiceApi *apiInstance = [[DevicePasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 1000; // Pagination limit (optional) (default to 0)

// Get user Device password credentials
[apiInstance getAllDevicePasswords1With:clientExtId
    userExtId:userExtId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForDevicePasswordGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.DevicePasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 1000 // {Integer} Pagination limit
};

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

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

            // Create an instance of the API class
            var apiInstance = new DevicePasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 1000;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get user Device password credentials
                ItemsWrapperForDevicePasswordGetDTO result = apiInstance.getAllDevicePasswords1(clientExtId, userExtId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicePasswordRESTServiceApi.getAllDevicePasswords1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicePasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 1000; // Integer | Pagination limit

try {
    $result = $api_instance->getAllDevicePasswords1($clientExtId, $userExtId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DevicePasswordRESTServiceApi->getAllDevicePasswords1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DevicePasswordRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicePasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 1000; # Integer | Pagination limit

eval {
    my $result = $api_instance->getAllDevicePasswords1(clientExtId => $clientExtId, userExtId => $userExtId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicePasswordRESTServiceApi->getAllDevicePasswords1: $@\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.DevicePasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 1000 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get user Device password credentials
    api_response = api_instance.get_all_device_passwords1(clientExtId, userExtId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicePasswordRESTServiceApi->getAllDevicePasswords1: %s\n" % e)
extern crate DevicePasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let continuationToken = continuationToken_example; // String
    let limit = 1000; // Integer

    let mut context = DevicePasswordRESTServiceApi::Context::default();
    let result = client.getAllDevicePasswords1(clientExtId, userExtId, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


getDevicePassword

getDevicePassword
get/core/v1/{clientExtId}/users/{userExtId}/device-passwords/{extId}

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns the Device password credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/device-passwords/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicePasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            DevicePasswordGetDTO result = apiInstance.getDevicePassword(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#getDevicePassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential

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

import org.openapitools.client.api.DevicePasswordRESTServiceApi;

public class DevicePasswordRESTServiceApiExample {
    public static void main(String[] args) {
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            DevicePasswordGetDTO result = apiInstance.getDevicePassword(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#getDevicePassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DevicePasswordRESTServiceApi *apiInstance = [[DevicePasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000002; // ExtID of the credential (default to null)

// Get Device password
[apiInstance getDevicePasswordWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(DevicePasswordGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.DevicePasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000002; // {String} ExtID of the credential

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

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

            // Create an instance of the API class
            var apiInstance = new DevicePasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000002;  // String | ExtID of the credential (default to null)

            try {
                // Get Device password
                DevicePasswordGetDTO result = apiInstance.getDevicePassword(clientExtId, userExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicePasswordRESTServiceApi.getDevicePassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicePasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000002; // String | ExtID of the credential

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicePasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000002; # String | ExtID of the credential

eval {
    my $result = $api_instance->getDevicePassword(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicePasswordRESTServiceApi->getDevicePassword: $@\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.DevicePasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000002 # String | ExtID of the credential (default to null)

try:
    # Get Device password
    api_response = api_instance.get_device_password(clientExtId, userExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicePasswordRESTServiceApi->getDevicePassword: %s\n" % e)
extern crate DevicePasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000002; // String

    let mut context = DevicePasswordRESTServiceApi::Context::default();
    let result = client.getDevicePassword(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required

Responses


getDevicePassword1

getDevicePassword1
get/core/v1/{clientExtId}/users/{userExtId}/device-password/{extId}

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns the Device password credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/device-password/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicePasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            DevicePasswordGetDTO result = apiInstance.getDevicePassword1(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#getDevicePassword1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential

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

import org.openapitools.client.api.DevicePasswordRESTServiceApi;

public class DevicePasswordRESTServiceApiExample {
    public static void main(String[] args) {
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            DevicePasswordGetDTO result = apiInstance.getDevicePassword1(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#getDevicePassword1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DevicePasswordRESTServiceApi *apiInstance = [[DevicePasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000002; // ExtID of the credential (default to null)

// Get Device password
[apiInstance getDevicePassword1With:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(DevicePasswordGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.DevicePasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000002; // {String} ExtID of the credential

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

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

            // Create an instance of the API class
            var apiInstance = new DevicePasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000002;  // String | ExtID of the credential (default to null)

            try {
                // Get Device password
                DevicePasswordGetDTO result = apiInstance.getDevicePassword1(clientExtId, userExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicePasswordRESTServiceApi.getDevicePassword1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicePasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000002; // String | ExtID of the credential

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicePasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000002; # String | ExtID of the credential

eval {
    my $result = $api_instance->getDevicePassword1(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicePasswordRESTServiceApi->getDevicePassword1: $@\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.DevicePasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000002 # String | ExtID of the credential (default to null)

try:
    # Get Device password
    api_response = api_instance.get_device_password1(clientExtId, userExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicePasswordRESTServiceApi->getDevicePassword1: %s\n" % e)
extern crate DevicePasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000002; // String

    let mut context = DevicePasswordRESTServiceApi::Context::default();
    let result = client.getDevicePassword1(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required

Responses


resetDevicePassword

resetDevicePassword
post/core/v1/{clientExtId}/users/{userExtId}/device-passwords/{extId}/reset

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialView,AccessControl.CredentialModify` or `SelfAdmin` Role Resets the Device password of the user with the given external ID. Depending on the password policy, the response either contains a part of the generated password in the parameter passwordFragment or no content is returned.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/device-passwords/{extId}/reset"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicePasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 27000030; // String | ExtID of the credential

        try {
            PasswordFragmentDTO result = apiInstance.resetDevicePassword(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#resetDevicePassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential

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

import org.openapitools.client.api.DevicePasswordRESTServiceApi;

public class DevicePasswordRESTServiceApiExample {
    public static void main(String[] args) {
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 27000030; // String | ExtID of the credential

        try {
            PasswordFragmentDTO result = apiInstance.resetDevicePassword(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#resetDevicePassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DevicePasswordRESTServiceApi *apiInstance = [[DevicePasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 27000030; // ExtID of the credential (default to null)

// Reset Device password
[apiInstance resetDevicePasswordWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(PasswordFragmentDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.DevicePasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 27000030; // {String} ExtID of the credential

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

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

            // Create an instance of the API class
            var apiInstance = new DevicePasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 27000030;  // String | ExtID of the credential (default to null)

            try {
                // Reset Device password
                PasswordFragmentDTO result = apiInstance.resetDevicePassword(clientExtId, userExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicePasswordRESTServiceApi.resetDevicePassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicePasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 27000030; // String | ExtID of the credential

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicePasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 27000030; # String | ExtID of the credential

eval {
    my $result = $api_instance->resetDevicePassword(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicePasswordRESTServiceApi->resetDevicePassword: $@\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.DevicePasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 27000030 # String | ExtID of the credential (default to null)

try:
    # Reset Device password
    api_response = api_instance.reset_device_password(clientExtId, userExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicePasswordRESTServiceApi->resetDevicePassword: %s\n" % e)
extern crate DevicePasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 27000030; // String

    let mut context = DevicePasswordRESTServiceApi::Context::default();
    let result = client.resetDevicePassword(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required

Responses


resetDevicePassword1

resetDevicePassword1
post/core/v1/{clientExtId}/users/{userExtId}/device-password/{extId}/reset

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialView,AccessControl.CredentialModify` or `SelfAdmin` Role Resets the Device password of the user with the given external ID. Depending on the password policy, the response either contains a part of the generated password in the parameter passwordFragment or no content is returned.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/device-password/{extId}/reset"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicePasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 27000030; // String | ExtID of the credential

        try {
            PasswordFragmentDTO result = apiInstance.resetDevicePassword1(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#resetDevicePassword1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential

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

import org.openapitools.client.api.DevicePasswordRESTServiceApi;

public class DevicePasswordRESTServiceApiExample {
    public static void main(String[] args) {
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 27000030; // String | ExtID of the credential

        try {
            PasswordFragmentDTO result = apiInstance.resetDevicePassword1(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#resetDevicePassword1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DevicePasswordRESTServiceApi *apiInstance = [[DevicePasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 27000030; // ExtID of the credential (default to null)

// Reset Device password
[apiInstance resetDevicePassword1With:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(PasswordFragmentDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.DevicePasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 27000030; // {String} ExtID of the credential

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

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

            // Create an instance of the API class
            var apiInstance = new DevicePasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 27000030;  // String | ExtID of the credential (default to null)

            try {
                // Reset Device password
                PasswordFragmentDTO result = apiInstance.resetDevicePassword1(clientExtId, userExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicePasswordRESTServiceApi.resetDevicePassword1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicePasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 27000030; // String | ExtID of the credential

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicePasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 27000030; # String | ExtID of the credential

eval {
    my $result = $api_instance->resetDevicePassword1(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicePasswordRESTServiceApi->resetDevicePassword1: $@\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.DevicePasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 27000030 # String | ExtID of the credential (default to null)

try:
    # Reset Device password
    api_response = api_instance.reset_device_password1(clientExtId, userExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicePasswordRESTServiceApi->resetDevicePassword1: %s\n" % e)
extern crate DevicePasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 27000030; // String

    let mut context = DevicePasswordRESTServiceApi::Context::default();
    let result = client.resetDevicePassword1(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required

Responses


updateDevicePassword

updateDevicePassword
patch/core/v1/{clientExtId}/users/{userExtId}/device-passwords/{extId}

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialModify,AccessControl.CredentialView` Updates the Device password credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/device-passwords/{extId}" \
 -d '{
  "policyExtId" : "policy-456",
  "password" : "password",
  "stateName" : "active",
  "modificationComment" : "Password reset by admin.",
  "extId" : "credential-123",
  "version" : 1
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicePasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential
        DevicePasswordPatchDTO devicePasswordPatchDTO = {"stateName":"disabled","modificationComment":"changed-by-admin","policyExtId":"102","version":2}; // DevicePasswordPatchDTO | 

        try {
            DevicePasswordGetDTO result = apiInstance.updateDevicePassword(clientExtId, userExtId, extId, devicePasswordPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#updateDevicePassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential
final DevicePasswordPatchDTO devicePasswordPatchDTO = new DevicePasswordPatchDTO(); // DevicePasswordPatchDTO | 

try {
    final result = await api_instance.updateDevicePassword(clientExtId, userExtId, extId, devicePasswordPatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateDevicePassword: $e\n');
}

import org.openapitools.client.api.DevicePasswordRESTServiceApi;

public class DevicePasswordRESTServiceApiExample {
    public static void main(String[] args) {
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential
        DevicePasswordPatchDTO devicePasswordPatchDTO = {"stateName":"disabled","modificationComment":"changed-by-admin","policyExtId":"102","version":2}; // DevicePasswordPatchDTO | 

        try {
            DevicePasswordGetDTO result = apiInstance.updateDevicePassword(clientExtId, userExtId, extId, devicePasswordPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#updateDevicePassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DevicePasswordRESTServiceApi *apiInstance = [[DevicePasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000002; // ExtID of the credential (default to null)
DevicePasswordPatchDTO *devicePasswordPatchDTO = {"stateName":"disabled","modificationComment":"changed-by-admin","policyExtId":"102","version":2}; // 

// Update Device password Credential
[apiInstance updateDevicePasswordWith:clientExtId
    userExtId:userExtId
    extId:extId
    devicePasswordPatchDTO:devicePasswordPatchDTO
              completionHandler: ^(DevicePasswordGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.DevicePasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000002; // {String} ExtID of the credential
var devicePasswordPatchDTO = {"stateName":"disabled","modificationComment":"changed-by-admin","policyExtId":"102","version":2}; // {DevicePasswordPatchDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new DevicePasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000002;  // String | ExtID of the credential (default to null)
            var devicePasswordPatchDTO = new DevicePasswordPatchDTO(); // DevicePasswordPatchDTO | 

            try {
                // Update Device password Credential
                DevicePasswordGetDTO result = apiInstance.updateDevicePassword(clientExtId, userExtId, extId, devicePasswordPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicePasswordRESTServiceApi.updateDevicePassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicePasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000002; // String | ExtID of the credential
$devicePasswordPatchDTO = {"stateName":"disabled","modificationComment":"changed-by-admin","policyExtId":"102","version":2}; // DevicePasswordPatchDTO | 

try {
    $result = $api_instance->updateDevicePassword($clientExtId, $userExtId, $extId, $devicePasswordPatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DevicePasswordRESTServiceApi->updateDevicePassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DevicePasswordRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicePasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000002; # String | ExtID of the credential
my $devicePasswordPatchDTO = WWW::OPenAPIClient::Object::DevicePasswordPatchDTO->new(); # DevicePasswordPatchDTO | 

eval {
    my $result = $api_instance->updateDevicePassword(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId, devicePasswordPatchDTO => $devicePasswordPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicePasswordRESTServiceApi->updateDevicePassword: $@\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.DevicePasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000002 # String | ExtID of the credential (default to null)
devicePasswordPatchDTO = {"stateName":"disabled","modificationComment":"changed-by-admin","policyExtId":"102","version":2} # DevicePasswordPatchDTO | 

try:
    # Update Device password Credential
    api_response = api_instance.update_device_password(clientExtId, userExtId, extId, devicePasswordPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicePasswordRESTServiceApi->updateDevicePassword: %s\n" % e)
extern crate DevicePasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000002; // String
    let devicePasswordPatchDTO = {"stateName":"disabled","modificationComment":"changed-by-admin","policyExtId":"102","version":2}; // DevicePasswordPatchDTO

    let mut context = DevicePasswordRESTServiceApi::Context::default();
    let result = client.updateDevicePassword(clientExtId, userExtId, extId, devicePasswordPatchDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required
Body parameters
Name Description
devicePasswordPatchDTO *

Responses


updateDevicePassword1

updateDevicePassword1
patch/core/v1/{clientExtId}/users/{userExtId}/device-password/{extId}

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialModify,AccessControl.CredentialView` Updates the Device password credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/device-password/{extId}" \
 -d '{
  "policyExtId" : "policy-456",
  "password" : "password",
  "stateName" : "active",
  "modificationComment" : "Password reset by admin.",
  "extId" : "credential-123",
  "version" : 1
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicePasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential
        DevicePasswordPatchDTO devicePasswordPatchDTO = {stateName=disabled, modificationComment=changed-by-admin, policyExtId=102, version=2}; // DevicePasswordPatchDTO | 

        try {
            DevicePasswordGetDTO result = apiInstance.updateDevicePassword1(clientExtId, userExtId, extId, devicePasswordPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#updateDevicePassword1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential
final DevicePasswordPatchDTO devicePasswordPatchDTO = new DevicePasswordPatchDTO(); // DevicePasswordPatchDTO | 

try {
    final result = await api_instance.updateDevicePassword1(clientExtId, userExtId, extId, devicePasswordPatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateDevicePassword1: $e\n');
}

import org.openapitools.client.api.DevicePasswordRESTServiceApi;

public class DevicePasswordRESTServiceApiExample {
    public static void main(String[] args) {
        DevicePasswordRESTServiceApi apiInstance = new DevicePasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential
        DevicePasswordPatchDTO devicePasswordPatchDTO = {stateName=disabled, modificationComment=changed-by-admin, policyExtId=102, version=2}; // DevicePasswordPatchDTO | 

        try {
            DevicePasswordGetDTO result = apiInstance.updateDevicePassword1(clientExtId, userExtId, extId, devicePasswordPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicePasswordRESTServiceApi#updateDevicePassword1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DevicePasswordRESTServiceApi *apiInstance = [[DevicePasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000002; // ExtID of the credential (default to null)
DevicePasswordPatchDTO *devicePasswordPatchDTO = {stateName=disabled, modificationComment=changed-by-admin, policyExtId=102, version=2}; // 

// Update Device password Credential
[apiInstance updateDevicePassword1With:clientExtId
    userExtId:userExtId
    extId:extId
    devicePasswordPatchDTO:devicePasswordPatchDTO
              completionHandler: ^(DevicePasswordGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.DevicePasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000002; // {String} ExtID of the credential
var devicePasswordPatchDTO = {stateName=disabled, modificationComment=changed-by-admin, policyExtId=102, version=2}; // {DevicePasswordPatchDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new DevicePasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000002;  // String | ExtID of the credential (default to null)
            var devicePasswordPatchDTO = new DevicePasswordPatchDTO(); // DevicePasswordPatchDTO | 

            try {
                // Update Device password Credential
                DevicePasswordGetDTO result = apiInstance.updateDevicePassword1(clientExtId, userExtId, extId, devicePasswordPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicePasswordRESTServiceApi.updateDevicePassword1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicePasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000002; // String | ExtID of the credential
$devicePasswordPatchDTO = {stateName=disabled, modificationComment=changed-by-admin, policyExtId=102, version=2}; // DevicePasswordPatchDTO | 

try {
    $result = $api_instance->updateDevicePassword1($clientExtId, $userExtId, $extId, $devicePasswordPatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DevicePasswordRESTServiceApi->updateDevicePassword1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DevicePasswordRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicePasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000002; # String | ExtID of the credential
my $devicePasswordPatchDTO = WWW::OPenAPIClient::Object::DevicePasswordPatchDTO->new(); # DevicePasswordPatchDTO | 

eval {
    my $result = $api_instance->updateDevicePassword1(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId, devicePasswordPatchDTO => $devicePasswordPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicePasswordRESTServiceApi->updateDevicePassword1: $@\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.DevicePasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000002 # String | ExtID of the credential (default to null)
devicePasswordPatchDTO = {stateName=disabled, modificationComment=changed-by-admin, policyExtId=102, version=2} # DevicePasswordPatchDTO | 

try:
    # Update Device password Credential
    api_response = api_instance.update_device_password1(clientExtId, userExtId, extId, devicePasswordPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicePasswordRESTServiceApi->updateDevicePassword1: %s\n" % e)
extern crate DevicePasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000002; // String
    let devicePasswordPatchDTO = {stateName=disabled, modificationComment=changed-by-admin, policyExtId=102, version=2}; // DevicePasswordPatchDTO

    let mut context = DevicePasswordRESTServiceApi::Context::default();
    let result = client.updateDevicePassword1(clientExtId, userExtId, extId, devicePasswordPatchDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required
Body parameters
Name Description
devicePasswordPatchDTO *

Responses


EnterpriseRoleRESTService

assignRoleToEnterpriseRole

assignRoleToEnterpriseRole
put/core/v1/{clientExtId}/eroles/{eroleExtId}/roles/{roleExtId}

**Since:** 2.75.2, 2.76.0 **Required permission(s):** `AccessControl.EnterpriseRoleMemberCreate` Assigns the role with the given external ID to the enterprise role with the given external ID.

Usage and SDK Samples

curl -X PUT \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/eroles/{eroleExtId}/roles/{roleExtId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EnterpriseRoleRESTServiceApi;

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

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

        // Create an instance of the API class
        EnterpriseRoleRESTServiceApi apiInstance = new EnterpriseRoleRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String eroleExtId = 2345; // String | ExtID of the enterprise role
        String roleExtId = 2301; // String | ExtID of the role

        try {
            apiInstance.assignRoleToEnterpriseRole(clientExtId, eroleExtId, roleExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnterpriseRoleRESTServiceApi#assignRoleToEnterpriseRole");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String eroleExtId = new String(); // String | ExtID of the enterprise role
final String roleExtId = new String(); // String | ExtID of the role

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

import org.openapitools.client.api.EnterpriseRoleRESTServiceApi;

public class EnterpriseRoleRESTServiceApiExample {
    public static void main(String[] args) {
        EnterpriseRoleRESTServiceApi apiInstance = new EnterpriseRoleRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String eroleExtId = 2345; // String | ExtID of the enterprise role
        String roleExtId = 2301; // String | ExtID of the role

        try {
            apiInstance.assignRoleToEnterpriseRole(clientExtId, eroleExtId, roleExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnterpriseRoleRESTServiceApi#assignRoleToEnterpriseRole");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EnterpriseRoleRESTServiceApi *apiInstance = [[EnterpriseRoleRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *eroleExtId = 2345; // ExtID of the enterprise role (default to null)
String *roleExtId = 2301; // ExtID of the role (default to null)

// Assign role
[apiInstance assignRoleToEnterpriseRoleWith:clientExtId
    eroleExtId:eroleExtId
    roleExtId:roleExtId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.EnterpriseRoleRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var eroleExtId = 2345; // {String} ExtID of the enterprise role
var roleExtId = 2301; // {String} ExtID of the role

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

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

            // Create an instance of the API class
            var apiInstance = new EnterpriseRoleRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var eroleExtId = 2345;  // String | ExtID of the enterprise role (default to null)
            var roleExtId = 2301;  // String | ExtID of the role (default to null)

            try {
                // Assign role
                apiInstance.assignRoleToEnterpriseRole(clientExtId, eroleExtId, roleExtId);
            } catch (Exception e) {
                Debug.Print("Exception when calling EnterpriseRoleRESTServiceApi.assignRoleToEnterpriseRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EnterpriseRoleRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$eroleExtId = 2345; // String | ExtID of the enterprise role
$roleExtId = 2301; // String | ExtID of the role

try {
    $api_instance->assignRoleToEnterpriseRole($clientExtId, $eroleExtId, $roleExtId);
} catch (Exception $e) {
    echo 'Exception when calling EnterpriseRoleRESTServiceApi->assignRoleToEnterpriseRole: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EnterpriseRoleRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EnterpriseRoleRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $eroleExtId = 2345; # String | ExtID of the enterprise role
my $roleExtId = 2301; # String | ExtID of the role

eval {
    $api_instance->assignRoleToEnterpriseRole(clientExtId => $clientExtId, eroleExtId => $eroleExtId, roleExtId => $roleExtId);
};
if ($@) {
    warn "Exception when calling EnterpriseRoleRESTServiceApi->assignRoleToEnterpriseRole: $@\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.EnterpriseRoleRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
eroleExtId = 2345 # String | ExtID of the enterprise role (default to null)
roleExtId = 2301 # String | ExtID of the role (default to null)

try:
    # Assign role
    api_instance.assign_role_to_enterprise_role(clientExtId, eroleExtId, roleExtId)
except ApiException as e:
    print("Exception when calling EnterpriseRoleRESTServiceApi->assignRoleToEnterpriseRole: %s\n" % e)
extern crate EnterpriseRoleRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let eroleExtId = 2345; // String
    let roleExtId = 2301; // String

    let mut context = EnterpriseRoleRESTServiceApi::Context::default();
    let result = client.assignRoleToEnterpriseRole(clientExtId, eroleExtId, roleExtId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
eroleExtId*
String
ExtID of the enterprise role
Required
roleExtId*
String
ExtID of the role
Required

Responses


createEnterpriseRole

createEnterpriseRole
post/core/v1/{clientExtId}/eroles

**Since:** 2.75.2, 2.76.0 **Required permission(s):** `AccessControl.EnterpriseRoleCreate` Creates a new enterprise role for the client with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/eroles" \
 -d '{
  "displayName" : {
    "key" : "displayName"
  },
  "name" : "name",
  "description" : "description",
  "extId" : "extId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EnterpriseRoleRESTServiceApi;

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

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

        // Create an instance of the API class
        EnterpriseRoleRESTServiceApi apiInstance = new EnterpriseRoleRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        EnterpriseRoleCreateDTO enterpriseRoleCreateDTO = {"extId":"2345","name":"erole1","description":"erole1","displayName":{"EN":"erole1","DE":"erole1","FR":"erole1","IT":"erole1"}}; // EnterpriseRoleCreateDTO | 

        try {
            apiInstance.createEnterpriseRole(clientExtId, enterpriseRoleCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnterpriseRoleRESTServiceApi#createEnterpriseRole");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final EnterpriseRoleCreateDTO enterpriseRoleCreateDTO = new EnterpriseRoleCreateDTO(); // EnterpriseRoleCreateDTO | 

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

import org.openapitools.client.api.EnterpriseRoleRESTServiceApi;

public class EnterpriseRoleRESTServiceApiExample {
    public static void main(String[] args) {
        EnterpriseRoleRESTServiceApi apiInstance = new EnterpriseRoleRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        EnterpriseRoleCreateDTO enterpriseRoleCreateDTO = {"extId":"2345","name":"erole1","description":"erole1","displayName":{"EN":"erole1","DE":"erole1","FR":"erole1","IT":"erole1"}}; // EnterpriseRoleCreateDTO | 

        try {
            apiInstance.createEnterpriseRole(clientExtId, enterpriseRoleCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnterpriseRoleRESTServiceApi#createEnterpriseRole");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EnterpriseRoleRESTServiceApi *apiInstance = [[EnterpriseRoleRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
EnterpriseRoleCreateDTO *enterpriseRoleCreateDTO = {"extId":"2345","name":"erole1","description":"erole1","displayName":{"EN":"erole1","DE":"erole1","FR":"erole1","IT":"erole1"}}; // 

// Create enterprise role
[apiInstance createEnterpriseRoleWith:clientExtId
    enterpriseRoleCreateDTO:enterpriseRoleCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.EnterpriseRoleRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var enterpriseRoleCreateDTO = {"extId":"2345","name":"erole1","description":"erole1","displayName":{"EN":"erole1","DE":"erole1","FR":"erole1","IT":"erole1"}}; // {EnterpriseRoleCreateDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new EnterpriseRoleRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var enterpriseRoleCreateDTO = new EnterpriseRoleCreateDTO(); // EnterpriseRoleCreateDTO | 

            try {
                // Create enterprise role
                apiInstance.createEnterpriseRole(clientExtId, enterpriseRoleCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling EnterpriseRoleRESTServiceApi.createEnterpriseRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EnterpriseRoleRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$enterpriseRoleCreateDTO = {"extId":"2345","name":"erole1","description":"erole1","displayName":{"EN":"erole1","DE":"erole1","FR":"erole1","IT":"erole1"}}; // EnterpriseRoleCreateDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EnterpriseRoleRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $enterpriseRoleCreateDTO = WWW::OPenAPIClient::Object::EnterpriseRoleCreateDTO->new(); # EnterpriseRoleCreateDTO | 

eval {
    $api_instance->createEnterpriseRole(clientExtId => $clientExtId, enterpriseRoleCreateDTO => $enterpriseRoleCreateDTO);
};
if ($@) {
    warn "Exception when calling EnterpriseRoleRESTServiceApi->createEnterpriseRole: $@\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.EnterpriseRoleRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
enterpriseRoleCreateDTO = {"extId":"2345","name":"erole1","description":"erole1","displayName":{"EN":"erole1","DE":"erole1","FR":"erole1","IT":"erole1"}} # EnterpriseRoleCreateDTO | 

try:
    # Create enterprise role
    api_instance.create_enterprise_role(clientExtId, enterpriseRoleCreateDTO)
except ApiException as e:
    print("Exception when calling EnterpriseRoleRESTServiceApi->createEnterpriseRole: %s\n" % e)
extern crate EnterpriseRoleRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let enterpriseRoleCreateDTO = {"extId":"2345","name":"erole1","description":"erole1","displayName":{"EN":"erole1","DE":"erole1","FR":"erole1","IT":"erole1"}}; // EnterpriseRoleCreateDTO

    let mut context = EnterpriseRoleRESTServiceApi::Context::default();
    let result = client.createEnterpriseRole(clientExtId, enterpriseRoleCreateDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
Body parameters
Name Description
enterpriseRoleCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

deleteEnterpriseRoleByExtId

deleteEnterpriseRoleByExtId
delete/core/v1/{clientExtId}/eroles/{extId}

**Since:** 2.75.2, 2.76.0 **Required permission(s):** `AccessControl.EnterpriseRoleDelete` Deletes the enterprise role with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/eroles/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EnterpriseRoleRESTServiceApi;

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

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

        // Create an instance of the API class
        EnterpriseRoleRESTServiceApi apiInstance = new EnterpriseRoleRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2345; // String | ExtID of the enterprise role

        try {
            apiInstance.deleteEnterpriseRoleByExtId(clientExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnterpriseRoleRESTServiceApi#deleteEnterpriseRoleByExtId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the enterprise role

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

import org.openapitools.client.api.EnterpriseRoleRESTServiceApi;

public class EnterpriseRoleRESTServiceApiExample {
    public static void main(String[] args) {
        EnterpriseRoleRESTServiceApi apiInstance = new EnterpriseRoleRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2345; // String | ExtID of the enterprise role

        try {
            apiInstance.deleteEnterpriseRoleByExtId(clientExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnterpriseRoleRESTServiceApi#deleteEnterpriseRoleByExtId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EnterpriseRoleRESTServiceApi *apiInstance = [[EnterpriseRoleRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 2345; // ExtID of the enterprise role (default to null)

// Delete enterprise role
[apiInstance deleteEnterpriseRoleByExtIdWith:clientExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.EnterpriseRoleRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 2345; // {String} ExtID of the enterprise role

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

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

            // Create an instance of the API class
            var apiInstance = new EnterpriseRoleRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 2345;  // String | ExtID of the enterprise role (default to null)

            try {
                // Delete enterprise role
                apiInstance.deleteEnterpriseRoleByExtId(clientExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling EnterpriseRoleRESTServiceApi.deleteEnterpriseRoleByExtId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EnterpriseRoleRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 2345; // String | ExtID of the enterprise role

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EnterpriseRoleRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 2345; # String | ExtID of the enterprise role

eval {
    $api_instance->deleteEnterpriseRoleByExtId(clientExtId => $clientExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling EnterpriseRoleRESTServiceApi->deleteEnterpriseRoleByExtId: $@\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.EnterpriseRoleRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 2345 # String | ExtID of the enterprise role (default to null)

try:
    # Delete enterprise role
    api_instance.delete_enterprise_role_by_ext_id(clientExtId, extId)
except ApiException as e:
    print("Exception when calling EnterpriseRoleRESTServiceApi->deleteEnterpriseRoleByExtId: %s\n" % e)
extern crate EnterpriseRoleRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 2345; // String

    let mut context = EnterpriseRoleRESTServiceApi::Context::default();
    let result = client.deleteEnterpriseRoleByExtId(clientExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the enterprise role
Required

Responses


deleteEnterpriseRoleMemberByExtId

deleteEnterpriseRoleMemberByExtId
delete/core/v1/{clientExtId}/eroles/{eroleExtId}/roles/{roleExtId}

**Since:** 2.75.2, 2.76.0 **Required permission(s):** `AccessControl.EnterpriseRoleMemberDelete` Removes the role with the given external ID from the enterprise role with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/eroles/{eroleExtId}/roles/{roleExtId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EnterpriseRoleRESTServiceApi;

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

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

        // Create an instance of the API class
        EnterpriseRoleRESTServiceApi apiInstance = new EnterpriseRoleRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String eroleExtId = 2345; // String | ExtID of the enterprise role
        String roleExtId = 2301; // String | ExtID of the role

        try {
            apiInstance.deleteEnterpriseRoleMemberByExtId(clientExtId, eroleExtId, roleExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnterpriseRoleRESTServiceApi#deleteEnterpriseRoleMemberByExtId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String eroleExtId = new String(); // String | ExtID of the enterprise role
final String roleExtId = new String(); // String | ExtID of the role

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

import org.openapitools.client.api.EnterpriseRoleRESTServiceApi;

public class EnterpriseRoleRESTServiceApiExample {
    public static void main(String[] args) {
        EnterpriseRoleRESTServiceApi apiInstance = new EnterpriseRoleRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String eroleExtId = 2345; // String | ExtID of the enterprise role
        String roleExtId = 2301; // String | ExtID of the role

        try {
            apiInstance.deleteEnterpriseRoleMemberByExtId(clientExtId, eroleExtId, roleExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnterpriseRoleRESTServiceApi#deleteEnterpriseRoleMemberByExtId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EnterpriseRoleRESTServiceApi *apiInstance = [[EnterpriseRoleRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *eroleExtId = 2345; // ExtID of the enterprise role (default to null)
String *roleExtId = 2301; // ExtID of the role (default to null)

// Unassign role
[apiInstance deleteEnterpriseRoleMemberByExtIdWith:clientExtId
    eroleExtId:eroleExtId
    roleExtId:roleExtId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.EnterpriseRoleRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var eroleExtId = 2345; // {String} ExtID of the enterprise role
var roleExtId = 2301; // {String} ExtID of the role

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

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

            // Create an instance of the API class
            var apiInstance = new EnterpriseRoleRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var eroleExtId = 2345;  // String | ExtID of the enterprise role (default to null)
            var roleExtId = 2301;  // String | ExtID of the role (default to null)

            try {
                // Unassign role
                apiInstance.deleteEnterpriseRoleMemberByExtId(clientExtId, eroleExtId, roleExtId);
            } catch (Exception e) {
                Debug.Print("Exception when calling EnterpriseRoleRESTServiceApi.deleteEnterpriseRoleMemberByExtId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EnterpriseRoleRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$eroleExtId = 2345; // String | ExtID of the enterprise role
$roleExtId = 2301; // String | ExtID of the role

try {
    $api_instance->deleteEnterpriseRoleMemberByExtId($clientExtId, $eroleExtId, $roleExtId);
} catch (Exception $e) {
    echo 'Exception when calling EnterpriseRoleRESTServiceApi->deleteEnterpriseRoleMemberByExtId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EnterpriseRoleRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EnterpriseRoleRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $eroleExtId = 2345; # String | ExtID of the enterprise role
my $roleExtId = 2301; # String | ExtID of the role

eval {
    $api_instance->deleteEnterpriseRoleMemberByExtId(clientExtId => $clientExtId, eroleExtId => $eroleExtId, roleExtId => $roleExtId);
};
if ($@) {
    warn "Exception when calling EnterpriseRoleRESTServiceApi->deleteEnterpriseRoleMemberByExtId: $@\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.EnterpriseRoleRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
eroleExtId = 2345 # String | ExtID of the enterprise role (default to null)
roleExtId = 2301 # String | ExtID of the role (default to null)

try:
    # Unassign role
    api_instance.delete_enterprise_role_member_by_ext_id(clientExtId, eroleExtId, roleExtId)
except ApiException as e:
    print("Exception when calling EnterpriseRoleRESTServiceApi->deleteEnterpriseRoleMemberByExtId: %s\n" % e)
extern crate EnterpriseRoleRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let eroleExtId = 2345; // String
    let roleExtId = 2301; // String

    let mut context = EnterpriseRoleRESTServiceApi::Context::default();
    let result = client.deleteEnterpriseRoleMemberByExtId(clientExtId, eroleExtId, roleExtId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
eroleExtId*
String
ExtID of the enterprise role
Required
roleExtId*
String
ExtID of the role
Required

Responses


getEnterpriseRoleByExtId

getEnterpriseRoleByExtId
get/core/v1/{clientExtId}/eroles/{extId}

**Since:** 2.75.2, 2.76.0 **Required permission(s):** `AccessControl.EnterpriseRoleView` Returns the enterprise role with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/eroles/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EnterpriseRoleRESTServiceApi;

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

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

        // Create an instance of the API class
        EnterpriseRoleRESTServiceApi apiInstance = new EnterpriseRoleRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2345; // String | ExtID of the enterprise role

        try {
            EnterpriseRoleGetDTO result = apiInstance.getEnterpriseRoleByExtId(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnterpriseRoleRESTServiceApi#getEnterpriseRoleByExtId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the enterprise role

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

import org.openapitools.client.api.EnterpriseRoleRESTServiceApi;

public class EnterpriseRoleRESTServiceApiExample {
    public static void main(String[] args) {
        EnterpriseRoleRESTServiceApi apiInstance = new EnterpriseRoleRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2345; // String | ExtID of the enterprise role

        try {
            EnterpriseRoleGetDTO result = apiInstance.getEnterpriseRoleByExtId(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnterpriseRoleRESTServiceApi#getEnterpriseRoleByExtId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EnterpriseRoleRESTServiceApi *apiInstance = [[EnterpriseRoleRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 2345; // ExtID of the enterprise role (default to null)

// Get enterprise role
[apiInstance getEnterpriseRoleByExtIdWith:clientExtId
    extId:extId
              completionHandler: ^(EnterpriseRoleGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.EnterpriseRoleRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 2345; // {String} ExtID of the enterprise role

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

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

            // Create an instance of the API class
            var apiInstance = new EnterpriseRoleRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 2345;  // String | ExtID of the enterprise role (default to null)

            try {
                // Get enterprise role
                EnterpriseRoleGetDTO result = apiInstance.getEnterpriseRoleByExtId(clientExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EnterpriseRoleRESTServiceApi.getEnterpriseRoleByExtId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EnterpriseRoleRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 2345; // String | ExtID of the enterprise role

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EnterpriseRoleRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 2345; # String | ExtID of the enterprise role

eval {
    my $result = $api_instance->getEnterpriseRoleByExtId(clientExtId => $clientExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EnterpriseRoleRESTServiceApi->getEnterpriseRoleByExtId: $@\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.EnterpriseRoleRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 2345 # String | ExtID of the enterprise role (default to null)

try:
    # Get enterprise role
    api_response = api_instance.get_enterprise_role_by_ext_id(clientExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnterpriseRoleRESTServiceApi->getEnterpriseRoleByExtId: %s\n" % e)
extern crate EnterpriseRoleRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 2345; // String

    let mut context = EnterpriseRoleRESTServiceApi::Context::default();
    let result = client.getEnterpriseRoleByExtId(clientExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the enterprise role
Required

Responses


getProperties4

getProperties4
get/core/v1/{clientExtId}/eroles/{extId}/properties

**Since:** 2.75.2, 2.76.0 **Required permission(s):** `AccessControl.EnterpriseRoleView,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView` Returns all properties of the enterprise role with the given external ID, as an object of key-value pairs.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/eroles/{extId}/properties"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EnterpriseRoleRESTServiceApi;

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

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

        // Create an instance of the API class
        EnterpriseRoleRESTServiceApi apiInstance = new EnterpriseRoleRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2345; // String | ExtID of the enterprise role

        try {
            map['String', 'String'] result = apiInstance.getProperties4(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnterpriseRoleRESTServiceApi#getProperties4");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the enterprise role

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

import org.openapitools.client.api.EnterpriseRoleRESTServiceApi;

public class EnterpriseRoleRESTServiceApiExample {
    public static void main(String[] args) {
        EnterpriseRoleRESTServiceApi apiInstance = new EnterpriseRoleRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2345; // String | ExtID of the enterprise role

        try {
            map['String', 'String'] result = apiInstance.getProperties4(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnterpriseRoleRESTServiceApi#getProperties4");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EnterpriseRoleRESTServiceApi *apiInstance = [[EnterpriseRoleRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 2345; // ExtID of the enterprise role (default to null)

// Get properties
[apiInstance getProperties4With:clientExtId
    extId:extId
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.EnterpriseRoleRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 2345; // {String} ExtID of the enterprise role

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

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

            // Create an instance of the API class
            var apiInstance = new EnterpriseRoleRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 2345;  // String | ExtID of the enterprise role (default to null)

            try {
                // Get properties
                map['String', 'String'] result = apiInstance.getProperties4(clientExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EnterpriseRoleRESTServiceApi.getProperties4: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EnterpriseRoleRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 2345; // String | ExtID of the enterprise role

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EnterpriseRoleRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 2345; # String | ExtID of the enterprise role

eval {
    my $result = $api_instance->getProperties4(clientExtId => $clientExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EnterpriseRoleRESTServiceApi->getProperties4: $@\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.EnterpriseRoleRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 2345 # String | ExtID of the enterprise role (default to null)

try:
    # Get properties
    api_response = api_instance.get_properties4(clientExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnterpriseRoleRESTServiceApi->getProperties4: %s\n" % e)
extern crate EnterpriseRoleRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 2345; // String

    let mut context = EnterpriseRoleRESTServiceApi::Context::default();
    let result = client.getProperties4(clientExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the enterprise role
Required

Responses


getRolesOfEnterpriseRole

getRolesOfEnterpriseRole
get/core/v1/{clientExtId}/eroles/{extId}/roles

**Since:** 2.75.2, 2.76.0 **Required permission(s):** `AccessControl.RoleView,AccessControl.EnterpriseRoleView` Returns all roles of the enterprise role with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/eroles/{extId}/roles?continuationToken=1524579619000_2300&limit=100"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EnterpriseRoleRESTServiceApi;

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

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

        // Create an instance of the API class
        EnterpriseRoleRESTServiceApi apiInstance = new EnterpriseRoleRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2345; // String | ExtID of the enterprise role
        String continuationToken = 1524579619000_2300; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperForRoleGetDTO result = apiInstance.getRolesOfEnterpriseRole(clientExtId, extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnterpriseRoleRESTServiceApi#getRolesOfEnterpriseRole");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the enterprise role
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

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

import org.openapitools.client.api.EnterpriseRoleRESTServiceApi;

public class EnterpriseRoleRESTServiceApiExample {
    public static void main(String[] args) {
        EnterpriseRoleRESTServiceApi apiInstance = new EnterpriseRoleRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2345; // String | ExtID of the enterprise role
        String continuationToken = 1524579619000_2300; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperForRoleGetDTO result = apiInstance.getRolesOfEnterpriseRole(clientExtId, extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnterpriseRoleRESTServiceApi#getRolesOfEnterpriseRole");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EnterpriseRoleRESTServiceApi *apiInstance = [[EnterpriseRoleRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 2345; // ExtID of the enterprise role (default to null)
String *continuationToken = 1524579619000_2300; // Pagination continuation token (optional) (default to )
Integer *limit = 100; // Pagination limit (optional) (default to 0)

// Get enterprise role members
[apiInstance getRolesOfEnterpriseRoleWith:clientExtId
    extId:extId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForRoleGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.EnterpriseRoleRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 2345; // {String} ExtID of the enterprise role
var opts = {
  'continuationToken': 1524579619000_2300, // {String} Pagination continuation token
  'limit': 100 // {Integer} Pagination limit
};

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

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

            // Create an instance of the API class
            var apiInstance = new EnterpriseRoleRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 2345;  // String | ExtID of the enterprise role (default to null)
            var continuationToken = 1524579619000_2300;  // String | Pagination continuation token (optional)  (default to )
            var limit = 100;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get enterprise role members
                ItemsWrapperForRoleGetDTO result = apiInstance.getRolesOfEnterpriseRole(clientExtId, extId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EnterpriseRoleRESTServiceApi.getRolesOfEnterpriseRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EnterpriseRoleRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 2345; // String | ExtID of the enterprise role
$continuationToken = 1524579619000_2300; // String | Pagination continuation token
$limit = 100; // Integer | Pagination limit

try {
    $result = $api_instance->getRolesOfEnterpriseRole($clientExtId, $extId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EnterpriseRoleRESTServiceApi->getRolesOfEnterpriseRole: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EnterpriseRoleRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EnterpriseRoleRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 2345; # String | ExtID of the enterprise role
my $continuationToken = 1524579619000_2300; # String | Pagination continuation token
my $limit = 100; # Integer | Pagination limit

eval {
    my $result = $api_instance->getRolesOfEnterpriseRole(clientExtId => $clientExtId, extId => $extId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EnterpriseRoleRESTServiceApi->getRolesOfEnterpriseRole: $@\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.EnterpriseRoleRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 2345 # String | ExtID of the enterprise role (default to null)
continuationToken = 1524579619000_2300 # String | Pagination continuation token (optional) (default to )
limit = 100 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get enterprise role members
    api_response = api_instance.get_roles_of_enterprise_role(clientExtId, extId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnterpriseRoleRESTServiceApi->getRolesOfEnterpriseRole: %s\n" % e)
extern crate EnterpriseRoleRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 2345; // String
    let continuationToken = 1524579619000_2300; // String
    let limit = 100; // Integer

    let mut context = EnterpriseRoleRESTServiceApi::Context::default();
    let result = client.getRolesOfEnterpriseRole(clientExtId, extId, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the enterprise role
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


patchEnterpriseRole

patchEnterpriseRole
patch/core/v1/{clientExtId}/eroles/{extId}

**Since:** 2.75.2, 2.76.0 **Required permission(s):** `AccessControl.EnterpriseRoleView,AccessControl.EnterpriseRoleModify` Updates the enterprise role with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/eroles/{extId}" \
 -d '{
  "displayName" : {
    "key" : "displayName"
  },
  "name" : "name",
  "description" : "description",
  "version" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EnterpriseRoleRESTServiceApi;

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

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

        // Create an instance of the API class
        EnterpriseRoleRESTServiceApi apiInstance = new EnterpriseRoleRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2345; // String | ExtID of the enterprise role
        EnterpriseRolePatchDTO enterpriseRolePatchDTO = {"version":2,"name":"erole1","description":"erole1","displayName":{"EN":"erole1","DE":"erolle1","FR":"erole1","IT":"erole1"}}; // EnterpriseRolePatchDTO | 

        try {
            EnterpriseRoleGetDTO result = apiInstance.patchEnterpriseRole(clientExtId, extId, enterpriseRolePatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnterpriseRoleRESTServiceApi#patchEnterpriseRole");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the enterprise role
final EnterpriseRolePatchDTO enterpriseRolePatchDTO = new EnterpriseRolePatchDTO(); // EnterpriseRolePatchDTO | 

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

import org.openapitools.client.api.EnterpriseRoleRESTServiceApi;

public class EnterpriseRoleRESTServiceApiExample {
    public static void main(String[] args) {
        EnterpriseRoleRESTServiceApi apiInstance = new EnterpriseRoleRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2345; // String | ExtID of the enterprise role
        EnterpriseRolePatchDTO enterpriseRolePatchDTO = {"version":2,"name":"erole1","description":"erole1","displayName":{"EN":"erole1","DE":"erolle1","FR":"erole1","IT":"erole1"}}; // EnterpriseRolePatchDTO | 

        try {
            EnterpriseRoleGetDTO result = apiInstance.patchEnterpriseRole(clientExtId, extId, enterpriseRolePatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnterpriseRoleRESTServiceApi#patchEnterpriseRole");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EnterpriseRoleRESTServiceApi *apiInstance = [[EnterpriseRoleRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 2345; // ExtID of the enterprise role (default to null)
EnterpriseRolePatchDTO *enterpriseRolePatchDTO = {"version":2,"name":"erole1","description":"erole1","displayName":{"EN":"erole1","DE":"erolle1","FR":"erole1","IT":"erole1"}}; // 

// Update enterprise role
[apiInstance patchEnterpriseRoleWith:clientExtId
    extId:extId
    enterpriseRolePatchDTO:enterpriseRolePatchDTO
              completionHandler: ^(EnterpriseRoleGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.EnterpriseRoleRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 2345; // {String} ExtID of the enterprise role
var enterpriseRolePatchDTO = {"version":2,"name":"erole1","description":"erole1","displayName":{"EN":"erole1","DE":"erolle1","FR":"erole1","IT":"erole1"}}; // {EnterpriseRolePatchDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new EnterpriseRoleRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 2345;  // String | ExtID of the enterprise role (default to null)
            var enterpriseRolePatchDTO = new EnterpriseRolePatchDTO(); // EnterpriseRolePatchDTO | 

            try {
                // Update enterprise role
                EnterpriseRoleGetDTO result = apiInstance.patchEnterpriseRole(clientExtId, extId, enterpriseRolePatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EnterpriseRoleRESTServiceApi.patchEnterpriseRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EnterpriseRoleRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 2345; // String | ExtID of the enterprise role
$enterpriseRolePatchDTO = {"version":2,"name":"erole1","description":"erole1","displayName":{"EN":"erole1","DE":"erolle1","FR":"erole1","IT":"erole1"}}; // EnterpriseRolePatchDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EnterpriseRoleRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 2345; # String | ExtID of the enterprise role
my $enterpriseRolePatchDTO = WWW::OPenAPIClient::Object::EnterpriseRolePatchDTO->new(); # EnterpriseRolePatchDTO | 

eval {
    my $result = $api_instance->patchEnterpriseRole(clientExtId => $clientExtId, extId => $extId, enterpriseRolePatchDTO => $enterpriseRolePatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EnterpriseRoleRESTServiceApi->patchEnterpriseRole: $@\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.EnterpriseRoleRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 2345 # String | ExtID of the enterprise role (default to null)
enterpriseRolePatchDTO = {"version":2,"name":"erole1","description":"erole1","displayName":{"EN":"erole1","DE":"erolle1","FR":"erole1","IT":"erole1"}} # EnterpriseRolePatchDTO | 

try:
    # Update enterprise role
    api_response = api_instance.patch_enterprise_role(clientExtId, extId, enterpriseRolePatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnterpriseRoleRESTServiceApi->patchEnterpriseRole: %s\n" % e)
extern crate EnterpriseRoleRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 2345; // String
    let enterpriseRolePatchDTO = {"version":2,"name":"erole1","description":"erole1","displayName":{"EN":"erole1","DE":"erolle1","FR":"erole1","IT":"erole1"}}; // EnterpriseRolePatchDTO

    let mut context = EnterpriseRoleRESTServiceApi::Context::default();
    let result = client.patchEnterpriseRole(clientExtId, extId, enterpriseRolePatchDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the enterprise role
Required
Body parameters
Name Description
enterpriseRolePatchDTO *

Responses


updateProperties4

updateProperties4
patch/core/v1/{clientExtId}/eroles/{eroleExtId}/properties

**Since:** 2.75.2, 2.76.0 **Required permission(s):** `AccessControl.EnterpriseRoleView,AccessControl.EnterpriseRoleModify,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView,AccessControl.PropertyValueCreate,AccessControl.PropertyValueDelete,AccessControl.PropertyValueModify` Updates the properties of an enterprise role with given external ID of the enterprise role. The body has to contain an object of key-value property pairs.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/eroles/{eroleExtId}/properties" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EnterpriseRoleRESTServiceApi;

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

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

        // Create an instance of the API class
        EnterpriseRoleRESTServiceApi apiInstance = new EnterpriseRoleRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String eroleExtId = 2345; // String | ExtID of the enterprise role
        map[String, String] requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String] | 

        try {
            map['String', 'String'] result = apiInstance.updateProperties4(clientExtId, eroleExtId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnterpriseRoleRESTServiceApi#updateProperties4");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String eroleExtId = new String(); // String | ExtID of the enterprise role
final map[String, String] requestBody = new map[String, String](); // map[String, String] | 

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

import org.openapitools.client.api.EnterpriseRoleRESTServiceApi;

public class EnterpriseRoleRESTServiceApiExample {
    public static void main(String[] args) {
        EnterpriseRoleRESTServiceApi apiInstance = new EnterpriseRoleRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String eroleExtId = 2345; // String | ExtID of the enterprise role
        map[String, String] requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String] | 

        try {
            map['String', 'String'] result = apiInstance.updateProperties4(clientExtId, eroleExtId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnterpriseRoleRESTServiceApi#updateProperties4");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EnterpriseRoleRESTServiceApi *apiInstance = [[EnterpriseRoleRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *eroleExtId = 2345; // ExtID of the enterprise role (default to null)
map[String, String] *requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // 

// Update properties
[apiInstance updateProperties4With:clientExtId
    eroleExtId:eroleExtId
    requestBody:requestBody
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.EnterpriseRoleRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var eroleExtId = 2345; // {String} ExtID of the enterprise role
var requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // {map[String, String]} 

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

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

            // Create an instance of the API class
            var apiInstance = new EnterpriseRoleRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var eroleExtId = 2345;  // String | ExtID of the enterprise role (default to null)
            var requestBody = new map[String, String](); // map[String, String] | 

            try {
                // Update properties
                map['String', 'String'] result = apiInstance.updateProperties4(clientExtId, eroleExtId, requestBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EnterpriseRoleRESTServiceApi.updateProperties4: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EnterpriseRoleRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$eroleExtId = 2345; // String | ExtID of the enterprise role
$requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EnterpriseRoleRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $eroleExtId = 2345; # String | ExtID of the enterprise role
my $requestBody = WWW::OPenAPIClient::Object::map[String, String]->new(); # map[String, String] | 

eval {
    my $result = $api_instance->updateProperties4(clientExtId => $clientExtId, eroleExtId => $eroleExtId, requestBody => $requestBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EnterpriseRoleRESTServiceApi->updateProperties4: $@\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.EnterpriseRoleRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
eroleExtId = 2345 # String | ExtID of the enterprise role (default to null)
requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3} # map[String, String] | 

try:
    # Update properties
    api_response = api_instance.update_properties4(clientExtId, eroleExtId, requestBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnterpriseRoleRESTServiceApi->updateProperties4: %s\n" % e)
extern crate EnterpriseRoleRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let eroleExtId = 2345; // String
    let requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String]

    let mut context = EnterpriseRoleRESTServiceApi::Context::default();
    let result = client.updateProperties4(clientExtId, eroleExtId, requestBody, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
eroleExtId*
String
ExtID of the enterprise role
Required
Body parameters
Name Description
requestBody *

Responses


FIDO2RESTService

createFido2Credential

createFido2Credential
post/core/v1/{clientExtId}/users/{userExtId}/fido2

**Since:** 2.86.0 **Required permission(s):** `AccessControl.CredentialCreate,AccessControl.CredentialChangeState,AccessControl.CredentialView` Creates a FIDO2 credential for the user with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/fido2" \
 -d '{
  "authenticatorAttachment" : "authenticatorAttachment",
  "aaguid" : "aaguid",
  "stateName" : "ACTIVE",
  "attestationConveyancePreference" : "attestationConveyancePreference",
  "userFriendlyName" : "userFriendlyName",
  "userAgent" : "userAgent",
  "extId" : "extId",
  "rpId" : "rpId",
  "userVerificationRequirement" : "userVerificationRequirement",
  "authenticator" : "authenticator",
  "hashedCredentialId" : "hashedCredentialId",
  "residentKeyRequirement" : "residentKeyRequirement"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FIDO2RESTServiceApi;

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

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

        // Create an instance of the API class
        FIDO2RESTServiceApi apiInstance = new FIDO2RESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        Fido2CreateDTO fido2CreateDTO = {"extId":"fidoTestExtId","aaguid":"cb69481e-8ff7-4039-93ec-0a2729a154a8","authenticator":"a56d7270446973706c61794e616d656441636d656b646973706c61794e616d656d4a6f686e20502e20536d697468646e616d65766a6f686e70736d697468406578616d706c652e636f6d626964703130393832333732333534303938373268696d61676555524c782868747470733a2f2f706963732e61636d652e636f6d2f30302f702f61426a6a6a707150622e706e67","authenticatorAttachment":"platform","attestationConveyancePreference":"direct","hashedCredentialId":"YmqcB3lo1skz629IIiYauEzEdGnxjq+XHgMYryTmgV3w6eM9+5JUcGwn2hJB0whyh9wI+ib7mg8HbshNKmE0A==","rpId":"siven.ch","residentKeyRequirement":"required","userAgent":"Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion","userFriendlyName":"NEVIS Android phone","userVerificationRequirement":"required","stateName":"active"}; // Fido2CreateDTO | 

        try {
            apiInstance.createFido2Credential(clientExtId, userExtId, fido2CreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDO2RESTServiceApi#createFido2Credential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final Fido2CreateDTO fido2CreateDTO = new Fido2CreateDTO(); // Fido2CreateDTO | 

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

import org.openapitools.client.api.FIDO2RESTServiceApi;

public class FIDO2RESTServiceApiExample {
    public static void main(String[] args) {
        FIDO2RESTServiceApi apiInstance = new FIDO2RESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        Fido2CreateDTO fido2CreateDTO = {"extId":"fidoTestExtId","aaguid":"cb69481e-8ff7-4039-93ec-0a2729a154a8","authenticator":"a56d7270446973706c61794e616d656441636d656b646973706c61794e616d656d4a6f686e20502e20536d697468646e616d65766a6f686e70736d697468406578616d706c652e636f6d626964703130393832333732333534303938373268696d61676555524c782868747470733a2f2f706963732e61636d652e636f6d2f30302f702f61426a6a6a707150622e706e67","authenticatorAttachment":"platform","attestationConveyancePreference":"direct","hashedCredentialId":"YmqcB3lo1skz629IIiYauEzEdGnxjq+XHgMYryTmgV3w6eM9+5JUcGwn2hJB0whyh9wI+ib7mg8HbshNKmE0A==","rpId":"siven.ch","residentKeyRequirement":"required","userAgent":"Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion","userFriendlyName":"NEVIS Android phone","userVerificationRequirement":"required","stateName":"active"}; // Fido2CreateDTO | 

        try {
            apiInstance.createFido2Credential(clientExtId, userExtId, fido2CreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDO2RESTServiceApi#createFido2Credential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FIDO2RESTServiceApi *apiInstance = [[FIDO2RESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
Fido2CreateDTO *fido2CreateDTO = {"extId":"fidoTestExtId","aaguid":"cb69481e-8ff7-4039-93ec-0a2729a154a8","authenticator":"a56d7270446973706c61794e616d656441636d656b646973706c61794e616d656d4a6f686e20502e20536d697468646e616d65766a6f686e70736d697468406578616d706c652e636f6d626964703130393832333732333534303938373268696d61676555524c782868747470733a2f2f706963732e61636d652e636f6d2f30302f702f61426a6a6a707150622e706e67","authenticatorAttachment":"platform","attestationConveyancePreference":"direct","hashedCredentialId":"YmqcB3lo1skz629IIiYauEzEdGnxjq+XHgMYryTmgV3w6eM9+5JUcGwn2hJB0whyh9wI+ib7mg8HbshNKmE0A==","rpId":"siven.ch","residentKeyRequirement":"required","userAgent":"Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion","userFriendlyName":"NEVIS Android phone","userVerificationRequirement":"required","stateName":"active"}; // 

// Create FIDO2 Credential
[apiInstance createFido2CredentialWith:clientExtId
    userExtId:userExtId
    fido2CreateDTO:fido2CreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.FIDO2RESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var fido2CreateDTO = {"extId":"fidoTestExtId","aaguid":"cb69481e-8ff7-4039-93ec-0a2729a154a8","authenticator":"a56d7270446973706c61794e616d656441636d656b646973706c61794e616d656d4a6f686e20502e20536d697468646e616d65766a6f686e70736d697468406578616d706c652e636f6d626964703130393832333732333534303938373268696d61676555524c782868747470733a2f2f706963732e61636d652e636f6d2f30302f702f61426a6a6a707150622e706e67","authenticatorAttachment":"platform","attestationConveyancePreference":"direct","hashedCredentialId":"YmqcB3lo1skz629IIiYauEzEdGnxjq+XHgMYryTmgV3w6eM9+5JUcGwn2hJB0whyh9wI+ib7mg8HbshNKmE0A==","rpId":"siven.ch","residentKeyRequirement":"required","userAgent":"Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion","userFriendlyName":"NEVIS Android phone","userVerificationRequirement":"required","stateName":"active"}; // {Fido2CreateDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new FIDO2RESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var fido2CreateDTO = new Fido2CreateDTO(); // Fido2CreateDTO | 

            try {
                // Create FIDO2 Credential
                apiInstance.createFido2Credential(clientExtId, userExtId, fido2CreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling FIDO2RESTServiceApi.createFido2Credential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FIDO2RESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$fido2CreateDTO = {"extId":"fidoTestExtId","aaguid":"cb69481e-8ff7-4039-93ec-0a2729a154a8","authenticator":"a56d7270446973706c61794e616d656441636d656b646973706c61794e616d656d4a6f686e20502e20536d697468646e616d65766a6f686e70736d697468406578616d706c652e636f6d626964703130393832333732333534303938373268696d61676555524c782868747470733a2f2f706963732e61636d652e636f6d2f30302f702f61426a6a6a707150622e706e67","authenticatorAttachment":"platform","attestationConveyancePreference":"direct","hashedCredentialId":"YmqcB3lo1skz629IIiYauEzEdGnxjq+XHgMYryTmgV3w6eM9+5JUcGwn2hJB0whyh9wI+ib7mg8HbshNKmE0A==","rpId":"siven.ch","residentKeyRequirement":"required","userAgent":"Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion","userFriendlyName":"NEVIS Android phone","userVerificationRequirement":"required","stateName":"active"}; // Fido2CreateDTO | 

try {
    $api_instance->createFido2Credential($clientExtId, $userExtId, $fido2CreateDTO);
} catch (Exception $e) {
    echo 'Exception when calling FIDO2RESTServiceApi->createFido2Credential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FIDO2RESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FIDO2RESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $fido2CreateDTO = WWW::OPenAPIClient::Object::Fido2CreateDTO->new(); # Fido2CreateDTO | 

eval {
    $api_instance->createFido2Credential(clientExtId => $clientExtId, userExtId => $userExtId, fido2CreateDTO => $fido2CreateDTO);
};
if ($@) {
    warn "Exception when calling FIDO2RESTServiceApi->createFido2Credential: $@\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.FIDO2RESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
fido2CreateDTO = {"extId":"fidoTestExtId","aaguid":"cb69481e-8ff7-4039-93ec-0a2729a154a8","authenticator":"a56d7270446973706c61794e616d656441636d656b646973706c61794e616d656d4a6f686e20502e20536d697468646e616d65766a6f686e70736d697468406578616d706c652e636f6d626964703130393832333732333534303938373268696d61676555524c782868747470733a2f2f706963732e61636d652e636f6d2f30302f702f61426a6a6a707150622e706e67","authenticatorAttachment":"platform","attestationConveyancePreference":"direct","hashedCredentialId":"YmqcB3lo1skz629IIiYauEzEdGnxjq+XHgMYryTmgV3w6eM9+5JUcGwn2hJB0whyh9wI+ib7mg8HbshNKmE0A==","rpId":"siven.ch","residentKeyRequirement":"required","userAgent":"Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion","userFriendlyName":"NEVIS Android phone","userVerificationRequirement":"required","stateName":"active"} # Fido2CreateDTO | 

try:
    # Create FIDO2 Credential
    api_instance.create_fido2_credential(clientExtId, userExtId, fido2CreateDTO)
except ApiException as e:
    print("Exception when calling FIDO2RESTServiceApi->createFido2Credential: %s\n" % e)
extern crate FIDO2RESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let fido2CreateDTO = {"extId":"fidoTestExtId","aaguid":"cb69481e-8ff7-4039-93ec-0a2729a154a8","authenticator":"a56d7270446973706c61794e616d656441636d656b646973706c61794e616d656d4a6f686e20502e20536d697468646e616d65766a6f686e70736d697468406578616d706c652e636f6d626964703130393832333732333534303938373268696d61676555524c782868747470733a2f2f706963732e61636d652e636f6d2f30302f702f61426a6a6a707150622e706e67","authenticatorAttachment":"platform","attestationConveyancePreference":"direct","hashedCredentialId":"YmqcB3lo1skz629IIiYauEzEdGnxjq+XHgMYryTmgV3w6eM9+5JUcGwn2hJB0whyh9wI+ib7mg8HbshNKmE0A==","rpId":"siven.ch","residentKeyRequirement":"required","userAgent":"Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion","userFriendlyName":"NEVIS Android phone","userVerificationRequirement":"required","stateName":"active"}; // Fido2CreateDTO

    let mut context = FIDO2RESTServiceApi::Context::default();
    let result = client.createFido2Credential(clientExtId, userExtId, fido2CreateDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
fido2CreateDTO *

Responses

Name Type Format Description
Location String Location of created role

deleteFidoCredential

deleteFidoCredential
delete/core/v1/{clientExtId}/users/{userExtId}/fido2/{extId}

**Since:** 2.86.0 **Required permission(s):** `AccessControl.CredentialDelete` or `SelfAdmin` Role Deletes the FIDO2 credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/fido2/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FIDO2RESTServiceApi;

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

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

        // Create an instance of the API class
        FIDO2RESTServiceApi apiInstance = new FIDO2RESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            apiInstance.deleteFidoCredential(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDO2RESTServiceApi#deleteFidoCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential

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

import org.openapitools.client.api.FIDO2RESTServiceApi;

public class FIDO2RESTServiceApiExample {
    public static void main(String[] args) {
        FIDO2RESTServiceApi apiInstance = new FIDO2RESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            apiInstance.deleteFidoCredential(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDO2RESTServiceApi#deleteFidoCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FIDO2RESTServiceApi *apiInstance = [[FIDO2RESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000002; // ExtID of the credential (default to null)

// Delete FIDO2
[apiInstance deleteFidoCredentialWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.FIDO2RESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000002; // {String} ExtID of the credential

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

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

            // Create an instance of the API class
            var apiInstance = new FIDO2RESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000002;  // String | ExtID of the credential (default to null)

            try {
                // Delete FIDO2
                apiInstance.deleteFidoCredential(clientExtId, userExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling FIDO2RESTServiceApi.deleteFidoCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FIDO2RESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000002; // String | ExtID of the credential

try {
    $api_instance->deleteFidoCredential($clientExtId, $userExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling FIDO2RESTServiceApi->deleteFidoCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FIDO2RESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FIDO2RESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000002; # String | ExtID of the credential

eval {
    $api_instance->deleteFidoCredential(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling FIDO2RESTServiceApi->deleteFidoCredential: $@\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.FIDO2RESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000002 # String | ExtID of the credential (default to null)

try:
    # Delete FIDO2
    api_instance.delete_fido_credential(clientExtId, userExtId, extId)
except ApiException as e:
    print("Exception when calling FIDO2RESTServiceApi->deleteFidoCredential: %s\n" % e)
extern crate FIDO2RESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000002; // String

    let mut context = FIDO2RESTServiceApi::Context::default();
    let result = client.deleteFidoCredential(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required

Responses


getFido2Credential

getFido2Credential
get/core/v1/{clientExtId}/users/{userExtId}/fido2/{extId}

**Since:** 2.86.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns the FIDO2 credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/fido2/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FIDO2RESTServiceApi;

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

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

        // Create an instance of the API class
        FIDO2RESTServiceApi apiInstance = new FIDO2RESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            Fido2GetDTO result = apiInstance.getFido2Credential(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDO2RESTServiceApi#getFido2Credential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential

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

import org.openapitools.client.api.FIDO2RESTServiceApi;

public class FIDO2RESTServiceApiExample {
    public static void main(String[] args) {
        FIDO2RESTServiceApi apiInstance = new FIDO2RESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            Fido2GetDTO result = apiInstance.getFido2Credential(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDO2RESTServiceApi#getFido2Credential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FIDO2RESTServiceApi *apiInstance = [[FIDO2RESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000002; // ExtID of the credential (default to null)

// Get FIDO2
[apiInstance getFido2CredentialWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(Fido2GetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.FIDO2RESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000002; // {String} ExtID of the credential

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

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

            // Create an instance of the API class
            var apiInstance = new FIDO2RESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000002;  // String | ExtID of the credential (default to null)

            try {
                // Get FIDO2
                Fido2GetDTO result = apiInstance.getFido2Credential(clientExtId, userExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FIDO2RESTServiceApi.getFido2Credential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FIDO2RESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000002; // String | ExtID of the credential

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FIDO2RESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000002; # String | ExtID of the credential

eval {
    my $result = $api_instance->getFido2Credential(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FIDO2RESTServiceApi->getFido2Credential: $@\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.FIDO2RESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000002 # String | ExtID of the credential (default to null)

try:
    # Get FIDO2
    api_response = api_instance.get_fido2_credential(clientExtId, userExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FIDO2RESTServiceApi->getFido2Credential: %s\n" % e)
extern crate FIDO2RESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000002; // String

    let mut context = FIDO2RESTServiceApi::Context::default();
    let result = client.getFido2Credential(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required

Responses


getFido2Credentials

getFido2Credentials
get/core/v1/{clientExtId}/users/{userExtId}/fido2

**Since:** 2.86.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns all the FIDO2 credentials of the user with the given external ID. Results can be filtered by userFriendlyName and stateName.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/fido2?continuationToken=continuationToken_example&limit=1000&userFriendlyName=&stateName=&allParams=Object"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FIDO2RESTServiceApi;

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

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

        // Create an instance of the API class
        FIDO2RESTServiceApi apiInstance = new FIDO2RESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        map[String, String] allParams = Object; // map[String, String] | 
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit
         UNKNOWN_PARAMETER_NAME = ; //  | Filter by userFriendlyName
         UNKNOWN_PARAMETER_NAME2 = ; //  | Filter by stateName

        try {
            ItemsWrapperForFido2GetDTO result = apiInstance.getFido2Credentials(clientExtId, userExtId, allParams, continuationToken, limit, UNKNOWN_PARAMETER_NAME, UNKNOWN_PARAMETER_NAME2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDO2RESTServiceApi#getFido2Credentials");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final map[String, String] allParams = new map[String, String](); // map[String, String] | 
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit
final  UNKNOWN_PARAMETER_NAME = new (); //  | Filter by userFriendlyName
final  UNKNOWN_PARAMETER_NAME2 = new (); //  | Filter by stateName

try {
    final result = await api_instance.getFido2Credentials(clientExtId, userExtId, allParams, continuationToken, limit, UNKNOWN_PARAMETER_NAME, UNKNOWN_PARAMETER_NAME2);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFido2Credentials: $e\n');
}

import org.openapitools.client.api.FIDO2RESTServiceApi;

public class FIDO2RESTServiceApiExample {
    public static void main(String[] args) {
        FIDO2RESTServiceApi apiInstance = new FIDO2RESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        map[String, String] allParams = Object; // map[String, String] | 
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit
         UNKNOWN_PARAMETER_NAME = ; //  | Filter by userFriendlyName
         UNKNOWN_PARAMETER_NAME2 = ; //  | Filter by stateName

        try {
            ItemsWrapperForFido2GetDTO result = apiInstance.getFido2Credentials(clientExtId, userExtId, allParams, continuationToken, limit, UNKNOWN_PARAMETER_NAME, UNKNOWN_PARAMETER_NAME2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDO2RESTServiceApi#getFido2Credentials");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FIDO2RESTServiceApi *apiInstance = [[FIDO2RESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
map[String, String] *allParams = Object; //  (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 1000; // Pagination limit (optional) (default to 0)
 *UNKNOWN_PARAMETER_NAME = ; // Filter by userFriendlyName (optional)
 *UNKNOWN_PARAMETER_NAME2 = ; // Filter by stateName (optional)

// Get user FIDO2 credentials
[apiInstance getFido2CredentialsWith:clientExtId
    userExtId:userExtId
    allParams:allParams
    continuationToken:continuationToken
    limit:limit
    UNKNOWN_PARAMETER_NAME:UNKNOWN_PARAMETER_NAME
    UNKNOWN_PARAMETER_NAME2:UNKNOWN_PARAMETER_NAME2
              completionHandler: ^(ItemsWrapperForFido2GetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.FIDO2RESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var allParams = Object; // {map[String, String]} 
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 1000, // {Integer} Pagination limit
  'UNKNOWN_PARAMETER_NAME': , // {} Filter by userFriendlyName
  'UNKNOWN_PARAMETER_NAME2':  // {} Filter by stateName
};

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

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

            // Create an instance of the API class
            var apiInstance = new FIDO2RESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var allParams = new map[String, String](); // map[String, String] |  (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 1000;  // Integer | Pagination limit (optional)  (default to 0)
            var UNKNOWN_PARAMETER_NAME = new (); //  | Filter by userFriendlyName (optional) 
            var UNKNOWN_PARAMETER_NAME2 = new (); //  | Filter by stateName (optional) 

            try {
                // Get user FIDO2 credentials
                ItemsWrapperForFido2GetDTO result = apiInstance.getFido2Credentials(clientExtId, userExtId, allParams, continuationToken, limit, UNKNOWN_PARAMETER_NAME, UNKNOWN_PARAMETER_NAME2);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FIDO2RESTServiceApi.getFido2Credentials: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FIDO2RESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$allParams = Object; // map[String, String] | 
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 1000; // Integer | Pagination limit
$UNKNOWN_PARAMETER_NAME = ; //  | Filter by userFriendlyName
$UNKNOWN_PARAMETER_NAME2 = ; //  | Filter by stateName

try {
    $result = $api_instance->getFido2Credentials($clientExtId, $userExtId, $allParams, $continuationToken, $limit, $UNKNOWN_PARAMETER_NAME, $UNKNOWN_PARAMETER_NAME2);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FIDO2RESTServiceApi->getFido2Credentials: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FIDO2RESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FIDO2RESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $allParams = Object; # map[String, String] | 
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 1000; # Integer | Pagination limit
my $UNKNOWN_PARAMETER_NAME = ; #  | Filter by userFriendlyName
my $UNKNOWN_PARAMETER_NAME2 = ; #  | Filter by stateName

eval {
    my $result = $api_instance->getFido2Credentials(clientExtId => $clientExtId, userExtId => $userExtId, allParams => $allParams, continuationToken => $continuationToken, limit => $limit, UNKNOWN_PARAMETER_NAME => $UNKNOWN_PARAMETER_NAME, UNKNOWN_PARAMETER_NAME2 => $UNKNOWN_PARAMETER_NAME2);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FIDO2RESTServiceApi->getFido2Credentials: $@\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.FIDO2RESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
allParams = Object # map[String, String] |  (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 1000 # Integer | Pagination limit (optional) (default to 0)
UNKNOWN_PARAMETER_NAME =  #  | Filter by userFriendlyName (optional)
UNKNOWN_PARAMETER_NAME2 =  #  | Filter by stateName (optional)

try:
    # Get user FIDO2 credentials
    api_response = api_instance.get_fido2_credentials(clientExtId, userExtId, allParams, continuationToken=continuationToken, limit=limit, UNKNOWN_PARAMETER_NAME=UNKNOWN_PARAMETER_NAME, UNKNOWN_PARAMETER_NAME2=UNKNOWN_PARAMETER_NAME2)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FIDO2RESTServiceApi->getFido2Credentials: %s\n" % e)
extern crate FIDO2RESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let allParams = Object; // map[String, String]
    let continuationToken = continuationToken_example; // String
    let limit = 1000; // Integer
    let UNKNOWN_PARAMETER_NAME = ; // 
    let UNKNOWN_PARAMETER_NAME2 = ; // 

    let mut context = FIDO2RESTServiceApi::Context::default();
    let result = client.getFido2Credentials(clientExtId, userExtId, allParams, continuationToken, limit, UNKNOWN_PARAMETER_NAME, UNKNOWN_PARAMETER_NAME2, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit
userFriendlyName
Filter by userFriendlyName
stateName
Filter by stateName
allParams*
map[String, String]
Required

Responses


patchFidoCredential

patchFidoCredential
patch/core/v1/{clientExtId}/users/{userExtId}/fido2/{extId}

**Since:** 2.86.0 **Required permission(s):** `AccessControl.CredentialView,AccessControl.CredentialModify` or `SelfAdmin` Role Updates the FIDO2 credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/fido2/{extId}" \
 -d '{
  "stateName" : "INITIAL",
  "modificationComment" : "modificationComment",
  "userFriendlyName" : "userFriendlyName",
  "authenticator" : "authenticator",
  "version" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FIDO2RESTServiceApi;

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

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

        // Create an instance of the API class
        FIDO2RESTServiceApi apiInstance = new FIDO2RESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential
        Fido2PatchDTO fido2PatchDTO = {"authenticator":"a56d7270446973706c61794e616d656441636d656b646973706c61794e616d656d4a6f686e20502e20536d697468646e616d65766a6f686e70736d697468406578616d706c652e636f6d626964703130393832333732333534303938373268696d61676555524c782868747470733a2f2f706963732e61636d652e636f6d2f30302f702f61426a6a6a327150622e706d67","userFriendlyName":"newName","stateName":"disabled","modificationComment":"Modification Comment","version":0}; // Fido2PatchDTO | 

        try {
            Fido2GetDTO result = apiInstance.patchFidoCredential(clientExtId, userExtId, extId, fido2PatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDO2RESTServiceApi#patchFidoCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential
final Fido2PatchDTO fido2PatchDTO = new Fido2PatchDTO(); // Fido2PatchDTO | 

try {
    final result = await api_instance.patchFidoCredential(clientExtId, userExtId, extId, fido2PatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchFidoCredential: $e\n');
}

import org.openapitools.client.api.FIDO2RESTServiceApi;

public class FIDO2RESTServiceApiExample {
    public static void main(String[] args) {
        FIDO2RESTServiceApi apiInstance = new FIDO2RESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential
        Fido2PatchDTO fido2PatchDTO = {"authenticator":"a56d7270446973706c61794e616d656441636d656b646973706c61794e616d656d4a6f686e20502e20536d697468646e616d65766a6f686e70736d697468406578616d706c652e636f6d626964703130393832333732333534303938373268696d61676555524c782868747470733a2f2f706963732e61636d652e636f6d2f30302f702f61426a6a6a327150622e706d67","userFriendlyName":"newName","stateName":"disabled","modificationComment":"Modification Comment","version":0}; // Fido2PatchDTO | 

        try {
            Fido2GetDTO result = apiInstance.patchFidoCredential(clientExtId, userExtId, extId, fido2PatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDO2RESTServiceApi#patchFidoCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FIDO2RESTServiceApi *apiInstance = [[FIDO2RESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000002; // ExtID of the credential (default to null)
Fido2PatchDTO *fido2PatchDTO = {"authenticator":"a56d7270446973706c61794e616d656441636d656b646973706c61794e616d656d4a6f686e20502e20536d697468646e616d65766a6f686e70736d697468406578616d706c652e636f6d626964703130393832333732333534303938373268696d61676555524c782868747470733a2f2f706963732e61636d652e636f6d2f30302f702f61426a6a6a327150622e706d67","userFriendlyName":"newName","stateName":"disabled","modificationComment":"Modification Comment","version":0}; // 

// Update FIDO2
[apiInstance patchFidoCredentialWith:clientExtId
    userExtId:userExtId
    extId:extId
    fido2PatchDTO:fido2PatchDTO
              completionHandler: ^(Fido2GetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.FIDO2RESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000002; // {String} ExtID of the credential
var fido2PatchDTO = {"authenticator":"a56d7270446973706c61794e616d656441636d656b646973706c61794e616d656d4a6f686e20502e20536d697468646e616d65766a6f686e70736d697468406578616d706c652e636f6d626964703130393832333732333534303938373268696d61676555524c782868747470733a2f2f706963732e61636d652e636f6d2f30302f702f61426a6a6a327150622e706d67","userFriendlyName":"newName","stateName":"disabled","modificationComment":"Modification Comment","version":0}; // {Fido2PatchDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new FIDO2RESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000002;  // String | ExtID of the credential (default to null)
            var fido2PatchDTO = new Fido2PatchDTO(); // Fido2PatchDTO | 

            try {
                // Update FIDO2
                Fido2GetDTO result = apiInstance.patchFidoCredential(clientExtId, userExtId, extId, fido2PatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FIDO2RESTServiceApi.patchFidoCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FIDO2RESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000002; // String | ExtID of the credential
$fido2PatchDTO = {"authenticator":"a56d7270446973706c61794e616d656441636d656b646973706c61794e616d656d4a6f686e20502e20536d697468646e616d65766a6f686e70736d697468406578616d706c652e636f6d626964703130393832333732333534303938373268696d61676555524c782868747470733a2f2f706963732e61636d652e636f6d2f30302f702f61426a6a6a327150622e706d67","userFriendlyName":"newName","stateName":"disabled","modificationComment":"Modification Comment","version":0}; // Fido2PatchDTO | 

try {
    $result = $api_instance->patchFidoCredential($clientExtId, $userExtId, $extId, $fido2PatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FIDO2RESTServiceApi->patchFidoCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FIDO2RESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FIDO2RESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000002; # String | ExtID of the credential
my $fido2PatchDTO = WWW::OPenAPIClient::Object::Fido2PatchDTO->new(); # Fido2PatchDTO | 

eval {
    my $result = $api_instance->patchFidoCredential(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId, fido2PatchDTO => $fido2PatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FIDO2RESTServiceApi->patchFidoCredential: $@\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.FIDO2RESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000002 # String | ExtID of the credential (default to null)
fido2PatchDTO = {"authenticator":"a56d7270446973706c61794e616d656441636d656b646973706c61794e616d656d4a6f686e20502e20536d697468646e616d65766a6f686e70736d697468406578616d706c652e636f6d626964703130393832333732333534303938373268696d61676555524c782868747470733a2f2f706963732e61636d652e636f6d2f30302f702f61426a6a6a327150622e706d67","userFriendlyName":"newName","stateName":"disabled","modificationComment":"Modification Comment","version":0} # Fido2PatchDTO | 

try:
    # Update FIDO2
    api_response = api_instance.patch_fido_credential(clientExtId, userExtId, extId, fido2PatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FIDO2RESTServiceApi->patchFidoCredential: %s\n" % e)
extern crate FIDO2RESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000002; // String
    let fido2PatchDTO = {"authenticator":"a56d7270446973706c61794e616d656441636d656b646973706c61794e616d656d4a6f686e20502e20536d697468646e616d65766a6f686e70736d697468406578616d706c652e636f6d626964703130393832333732333534303938373268696d61676555524c782868747470733a2f2f706963732e61636d652e636f6d2f30302f702f61426a6a6a327150622e706d67","userFriendlyName":"newName","stateName":"disabled","modificationComment":"Modification Comment","version":0}; // Fido2PatchDTO

    let mut context = FIDO2RESTServiceApi::Context::default();
    let result = client.patchFidoCredential(clientExtId, userExtId, extId, fido2PatchDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required
Body parameters
Name Description
fido2PatchDTO *

Responses


FIDOUAFRESTService

createFidoCredential

createFidoCredential
post/core/v1/{clientExtId}/users/{userExtId}/fido-authenticators

**Since:** 2.71.0 **Required permission(s):** `AccessControl.CredentialCreate,AccessControl.CredentialChangeState,AccessControl.CredentialView` Creates a FIDO UAF credential for the user with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/fido-authenticators" \
 -d '{
  "policyExtId" : "policyExtId",
  "authenticatorVersion" : 0,
  "publicKeyAlgorithm" : "publicKeyAlgorithm",
  "keyId" : "keyId",
  "attestationType" : "fullBasic",
  "publicKey" : "publicKey",
  "dispatchTargetExtId" : "dispatchTargetExtId",
  "deviceId" : "deviceId",
  "stateName" : "ACTIVE",
  "aaid" : "aaid",
  "appId" : "appId",
  "extId" : "extId",
  "validity" : {
    "from" : "2023-01-01T00:00:00Z",
    "to" : "2033-12-31T23:59:59Z"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FIDOUAFRESTServiceApi;

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

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

        // Create an instance of the API class
        FIDOUAFRESTServiceApi apiInstance = new FIDOUAFRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        FidoUafCreateDTO fidoUafCreateDTO = {"extId":"fidoTestExtId","aaid":"46cb#de12","keyId":"Abhe2b3AHb_Ahb3hdabjHA-b5","authenticatorVersion":2,"publicKey":"key","publicKeyAlgorithm":"algorithm","appId":"abc","deviceId":"deviceId","stateName":"active","validity":{"from":"2018-07-21T19:03:49Z","to":"2028-07-18T19:03:49Z"},"policyExtId":"fidoUafPolicyExtId"}; // FidoUafCreateDTO | 

        try {
            FidoUafGetDTO result = apiInstance.createFidoCredential(clientExtId, userExtId, fidoUafCreateDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDOUAFRESTServiceApi#createFidoCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final FidoUafCreateDTO fidoUafCreateDTO = new FidoUafCreateDTO(); // FidoUafCreateDTO | 

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

import org.openapitools.client.api.FIDOUAFRESTServiceApi;

public class FIDOUAFRESTServiceApiExample {
    public static void main(String[] args) {
        FIDOUAFRESTServiceApi apiInstance = new FIDOUAFRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        FidoUafCreateDTO fidoUafCreateDTO = {"extId":"fidoTestExtId","aaid":"46cb#de12","keyId":"Abhe2b3AHb_Ahb3hdabjHA-b5","authenticatorVersion":2,"publicKey":"key","publicKeyAlgorithm":"algorithm","appId":"abc","deviceId":"deviceId","stateName":"active","validity":{"from":"2018-07-21T19:03:49Z","to":"2028-07-18T19:03:49Z"},"policyExtId":"fidoUafPolicyExtId"}; // FidoUafCreateDTO | 

        try {
            FidoUafGetDTO result = apiInstance.createFidoCredential(clientExtId, userExtId, fidoUafCreateDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDOUAFRESTServiceApi#createFidoCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FIDOUAFRESTServiceApi *apiInstance = [[FIDOUAFRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
FidoUafCreateDTO *fidoUafCreateDTO = {"extId":"fidoTestExtId","aaid":"46cb#de12","keyId":"Abhe2b3AHb_Ahb3hdabjHA-b5","authenticatorVersion":2,"publicKey":"key","publicKeyAlgorithm":"algorithm","appId":"abc","deviceId":"deviceId","stateName":"active","validity":{"from":"2018-07-21T19:03:49Z","to":"2028-07-18T19:03:49Z"},"policyExtId":"fidoUafPolicyExtId"}; // 

// Create FIDO UAF
[apiInstance createFidoCredentialWith:clientExtId
    userExtId:userExtId
    fidoUafCreateDTO:fidoUafCreateDTO
              completionHandler: ^(FidoUafGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.FIDOUAFRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var fidoUafCreateDTO = {"extId":"fidoTestExtId","aaid":"46cb#de12","keyId":"Abhe2b3AHb_Ahb3hdabjHA-b5","authenticatorVersion":2,"publicKey":"key","publicKeyAlgorithm":"algorithm","appId":"abc","deviceId":"deviceId","stateName":"active","validity":{"from":"2018-07-21T19:03:49Z","to":"2028-07-18T19:03:49Z"},"policyExtId":"fidoUafPolicyExtId"}; // {FidoUafCreateDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new FIDOUAFRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var fidoUafCreateDTO = new FidoUafCreateDTO(); // FidoUafCreateDTO | 

            try {
                // Create FIDO UAF
                FidoUafGetDTO result = apiInstance.createFidoCredential(clientExtId, userExtId, fidoUafCreateDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FIDOUAFRESTServiceApi.createFidoCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FIDOUAFRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$fidoUafCreateDTO = {"extId":"fidoTestExtId","aaid":"46cb#de12","keyId":"Abhe2b3AHb_Ahb3hdabjHA-b5","authenticatorVersion":2,"publicKey":"key","publicKeyAlgorithm":"algorithm","appId":"abc","deviceId":"deviceId","stateName":"active","validity":{"from":"2018-07-21T19:03:49Z","to":"2028-07-18T19:03:49Z"},"policyExtId":"fidoUafPolicyExtId"}; // FidoUafCreateDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FIDOUAFRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $fidoUafCreateDTO = WWW::OPenAPIClient::Object::FidoUafCreateDTO->new(); # FidoUafCreateDTO | 

eval {
    my $result = $api_instance->createFidoCredential(clientExtId => $clientExtId, userExtId => $userExtId, fidoUafCreateDTO => $fidoUafCreateDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FIDOUAFRESTServiceApi->createFidoCredential: $@\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.FIDOUAFRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
fidoUafCreateDTO = {"extId":"fidoTestExtId","aaid":"46cb#de12","keyId":"Abhe2b3AHb_Ahb3hdabjHA-b5","authenticatorVersion":2,"publicKey":"key","publicKeyAlgorithm":"algorithm","appId":"abc","deviceId":"deviceId","stateName":"active","validity":{"from":"2018-07-21T19:03:49Z","to":"2028-07-18T19:03:49Z"},"policyExtId":"fidoUafPolicyExtId"} # FidoUafCreateDTO | 

try:
    # Create FIDO UAF
    api_response = api_instance.create_fido_credential(clientExtId, userExtId, fidoUafCreateDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FIDOUAFRESTServiceApi->createFidoCredential: %s\n" % e)
extern crate FIDOUAFRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let fidoUafCreateDTO = {"extId":"fidoTestExtId","aaid":"46cb#de12","keyId":"Abhe2b3AHb_Ahb3hdabjHA-b5","authenticatorVersion":2,"publicKey":"key","publicKeyAlgorithm":"algorithm","appId":"abc","deviceId":"deviceId","stateName":"active","validity":{"from":"2018-07-21T19:03:49Z","to":"2028-07-18T19:03:49Z"},"policyExtId":"fidoUafPolicyExtId"}; // FidoUafCreateDTO

    let mut context = FIDOUAFRESTServiceApi::Context::default();
    let result = client.createFidoCredential(clientExtId, userExtId, fidoUafCreateDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
fidoUafCreateDTO *

Responses


deleteFidoCredential1

deleteFidoCredential1
delete/core/v1/{clientExtId}/users/{userExtId}/fido-authenticators/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.CredentialDelete` or `SelfAdmin` Role Deletes the FIDO UAF credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/fido-authenticators/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FIDOUAFRESTServiceApi;

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

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

        // Create an instance of the API class
        FIDOUAFRESTServiceApi apiInstance = new FIDOUAFRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            apiInstance.deleteFidoCredential1(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDOUAFRESTServiceApi#deleteFidoCredential1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential

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

import org.openapitools.client.api.FIDOUAFRESTServiceApi;

public class FIDOUAFRESTServiceApiExample {
    public static void main(String[] args) {
        FIDOUAFRESTServiceApi apiInstance = new FIDOUAFRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            apiInstance.deleteFidoCredential1(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDOUAFRESTServiceApi#deleteFidoCredential1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FIDOUAFRESTServiceApi *apiInstance = [[FIDOUAFRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000002; // ExtID of the credential (default to null)

// Delete FIDO UAF
[apiInstance deleteFidoCredential1With:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.FIDOUAFRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000002; // {String} ExtID of the credential

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

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

            // Create an instance of the API class
            var apiInstance = new FIDOUAFRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000002;  // String | ExtID of the credential (default to null)

            try {
                // Delete FIDO UAF
                apiInstance.deleteFidoCredential1(clientExtId, userExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling FIDOUAFRESTServiceApi.deleteFidoCredential1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FIDOUAFRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000002; // String | ExtID of the credential

try {
    $api_instance->deleteFidoCredential1($clientExtId, $userExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling FIDOUAFRESTServiceApi->deleteFidoCredential1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FIDOUAFRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FIDOUAFRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000002; # String | ExtID of the credential

eval {
    $api_instance->deleteFidoCredential1(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling FIDOUAFRESTServiceApi->deleteFidoCredential1: $@\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.FIDOUAFRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000002 # String | ExtID of the credential (default to null)

try:
    # Delete FIDO UAF
    api_instance.delete_fido_credential1(clientExtId, userExtId, extId)
except ApiException as e:
    print("Exception when calling FIDOUAFRESTServiceApi->deleteFidoCredential1: %s\n" % e)
extern crate FIDOUAFRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000002; // String

    let mut context = FIDOUAFRESTServiceApi::Context::default();
    let result = client.deleteFidoCredential1(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required

Responses


getFidoCredential

getFidoCredential
get/core/v1/{clientExtId}/users/{userExtId}/fido-authenticators/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns the FIDO UAF credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/fido-authenticators/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FIDOUAFRESTServiceApi;

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

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

        // Create an instance of the API class
        FIDOUAFRESTServiceApi apiInstance = new FIDOUAFRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            FidoUafGetDTO result = apiInstance.getFidoCredential(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDOUAFRESTServiceApi#getFidoCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential

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

import org.openapitools.client.api.FIDOUAFRESTServiceApi;

public class FIDOUAFRESTServiceApiExample {
    public static void main(String[] args) {
        FIDOUAFRESTServiceApi apiInstance = new FIDOUAFRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            FidoUafGetDTO result = apiInstance.getFidoCredential(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDOUAFRESTServiceApi#getFidoCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FIDOUAFRESTServiceApi *apiInstance = [[FIDOUAFRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000002; // ExtID of the credential (default to null)

// Get FIDO UAF
[apiInstance getFidoCredentialWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(FidoUafGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.FIDOUAFRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000002; // {String} ExtID of the credential

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

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

            // Create an instance of the API class
            var apiInstance = new FIDOUAFRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000002;  // String | ExtID of the credential (default to null)

            try {
                // Get FIDO UAF
                FidoUafGetDTO result = apiInstance.getFidoCredential(clientExtId, userExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FIDOUAFRESTServiceApi.getFidoCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FIDOUAFRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000002; // String | ExtID of the credential

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FIDOUAFRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000002; # String | ExtID of the credential

eval {
    my $result = $api_instance->getFidoCredential(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FIDOUAFRESTServiceApi->getFidoCredential: $@\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.FIDOUAFRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000002 # String | ExtID of the credential (default to null)

try:
    # Get FIDO UAF
    api_response = api_instance.get_fido_credential(clientExtId, userExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FIDOUAFRESTServiceApi->getFidoCredential: %s\n" % e)
extern crate FIDOUAFRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000002; // String

    let mut context = FIDOUAFRESTServiceApi::Context::default();
    let result = client.getFidoCredential(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required

Responses


getFidoCredentials

getFidoCredentials
get/core/v1/{clientExtId}/users/{userExtId}/fido-authenticators

**Since:** 2.71.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns all the FIDO UAF credentials of the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/fido-authenticators?continuationToken=continuationToken_example&limit=1000"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FIDOUAFRESTServiceApi;

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

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

        // Create an instance of the API class
        FIDOUAFRESTServiceApi apiInstance = new FIDOUAFRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForFidoUafGetDTO result = apiInstance.getFidoCredentials(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDOUAFRESTServiceApi#getFidoCredentials");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

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

import org.openapitools.client.api.FIDOUAFRESTServiceApi;

public class FIDOUAFRESTServiceApiExample {
    public static void main(String[] args) {
        FIDOUAFRESTServiceApi apiInstance = new FIDOUAFRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForFidoUafGetDTO result = apiInstance.getFidoCredentials(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDOUAFRESTServiceApi#getFidoCredentials");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FIDOUAFRESTServiceApi *apiInstance = [[FIDOUAFRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 1000; // Pagination limit (optional) (default to 0)

// Get user FIDO UAF credentials
[apiInstance getFidoCredentialsWith:clientExtId
    userExtId:userExtId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForFidoUafGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.FIDOUAFRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 1000 // {Integer} Pagination limit
};

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

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

            // Create an instance of the API class
            var apiInstance = new FIDOUAFRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 1000;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get user FIDO UAF credentials
                ItemsWrapperForFidoUafGetDTO result = apiInstance.getFidoCredentials(clientExtId, userExtId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FIDOUAFRESTServiceApi.getFidoCredentials: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FIDOUAFRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 1000; // Integer | Pagination limit

try {
    $result = $api_instance->getFidoCredentials($clientExtId, $userExtId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FIDOUAFRESTServiceApi->getFidoCredentials: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FIDOUAFRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FIDOUAFRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 1000; # Integer | Pagination limit

eval {
    my $result = $api_instance->getFidoCredentials(clientExtId => $clientExtId, userExtId => $userExtId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FIDOUAFRESTServiceApi->getFidoCredentials: $@\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.FIDOUAFRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 1000 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get user FIDO UAF credentials
    api_response = api_instance.get_fido_credentials(clientExtId, userExtId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FIDOUAFRESTServiceApi->getFidoCredentials: %s\n" % e)
extern crate FIDOUAFRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let continuationToken = continuationToken_example; // String
    let limit = 1000; // Integer

    let mut context = FIDOUAFRESTServiceApi::Context::default();
    let result = client.getFidoCredentials(clientExtId, userExtId, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


patchFidoCredential1

patchFidoCredential1
patch/core/v1/{clientExtId}/users/{userExtId}/fido-authenticators/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.CredentialView,AccessControl.CredentialModify` or `SelfAdmin` Role Updates the FIDO UAF credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/fido-authenticators/{extId}" \
 -d '{
  "policyExtId" : "policyExtId",
  "stateName" : "ACTIVE",
  "modificationComment" : "modificationComment",
  "appId" : "appId",
  "signCounter" : 0,
  "dispatchTargetExtId" : "dispatchTargetExtId",
  "validity" : {
    "from" : "2023-01-01T00:00:00Z",
    "to" : "2033-12-31T23:59:59Z"
  },
  "deviceId" : "deviceId",
  "version" : 6
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FIDOUAFRESTServiceApi;

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

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

        // Create an instance of the API class
        FIDOUAFRESTServiceApi apiInstance = new FIDOUAFRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential
        FidoUafPatchDTO fidoUafPatchDTO = {"signCounter":0,"appId":"abc","deviceId":"deviceId","stateName":"active","modificationComment":"changed-by-admin","version":2,"validity":{"from":"2018-07-21T19:03:49Z","to":"2028-07-18T19:03:49Z"},"policyExtId":"fidoUafPolicyExtId"}; // FidoUafPatchDTO | 

        try {
            FidoUafGetDTO result = apiInstance.patchFidoCredential1(clientExtId, userExtId, extId, fidoUafPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDOUAFRESTServiceApi#patchFidoCredential1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential
final FidoUafPatchDTO fidoUafPatchDTO = new FidoUafPatchDTO(); // FidoUafPatchDTO | 

try {
    final result = await api_instance.patchFidoCredential1(clientExtId, userExtId, extId, fidoUafPatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchFidoCredential1: $e\n');
}

import org.openapitools.client.api.FIDOUAFRESTServiceApi;

public class FIDOUAFRESTServiceApiExample {
    public static void main(String[] args) {
        FIDOUAFRESTServiceApi apiInstance = new FIDOUAFRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential
        FidoUafPatchDTO fidoUafPatchDTO = {"signCounter":0,"appId":"abc","deviceId":"deviceId","stateName":"active","modificationComment":"changed-by-admin","version":2,"validity":{"from":"2018-07-21T19:03:49Z","to":"2028-07-18T19:03:49Z"},"policyExtId":"fidoUafPolicyExtId"}; // FidoUafPatchDTO | 

        try {
            FidoUafGetDTO result = apiInstance.patchFidoCredential1(clientExtId, userExtId, extId, fidoUafPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FIDOUAFRESTServiceApi#patchFidoCredential1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FIDOUAFRESTServiceApi *apiInstance = [[FIDOUAFRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000002; // ExtID of the credential (default to null)
FidoUafPatchDTO *fidoUafPatchDTO = {"signCounter":0,"appId":"abc","deviceId":"deviceId","stateName":"active","modificationComment":"changed-by-admin","version":2,"validity":{"from":"2018-07-21T19:03:49Z","to":"2028-07-18T19:03:49Z"},"policyExtId":"fidoUafPolicyExtId"}; // 

// Update FIDO UAF
[apiInstance patchFidoCredential1With:clientExtId
    userExtId:userExtId
    extId:extId
    fidoUafPatchDTO:fidoUafPatchDTO
              completionHandler: ^(FidoUafGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.FIDOUAFRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000002; // {String} ExtID of the credential
var fidoUafPatchDTO = {"signCounter":0,"appId":"abc","deviceId":"deviceId","stateName":"active","modificationComment":"changed-by-admin","version":2,"validity":{"from":"2018-07-21T19:03:49Z","to":"2028-07-18T19:03:49Z"},"policyExtId":"fidoUafPolicyExtId"}; // {FidoUafPatchDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new FIDOUAFRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000002;  // String | ExtID of the credential (default to null)
            var fidoUafPatchDTO = new FidoUafPatchDTO(); // FidoUafPatchDTO | 

            try {
                // Update FIDO UAF
                FidoUafGetDTO result = apiInstance.patchFidoCredential1(clientExtId, userExtId, extId, fidoUafPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FIDOUAFRESTServiceApi.patchFidoCredential1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FIDOUAFRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000002; // String | ExtID of the credential
$fidoUafPatchDTO = {"signCounter":0,"appId":"abc","deviceId":"deviceId","stateName":"active","modificationComment":"changed-by-admin","version":2,"validity":{"from":"2018-07-21T19:03:49Z","to":"2028-07-18T19:03:49Z"},"policyExtId":"fidoUafPolicyExtId"}; // FidoUafPatchDTO | 

try {
    $result = $api_instance->patchFidoCredential1($clientExtId, $userExtId, $extId, $fidoUafPatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FIDOUAFRESTServiceApi->patchFidoCredential1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FIDOUAFRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FIDOUAFRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000002; # String | ExtID of the credential
my $fidoUafPatchDTO = WWW::OPenAPIClient::Object::FidoUafPatchDTO->new(); # FidoUafPatchDTO | 

eval {
    my $result = $api_instance->patchFidoCredential1(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId, fidoUafPatchDTO => $fidoUafPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FIDOUAFRESTServiceApi->patchFidoCredential1: $@\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.FIDOUAFRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000002 # String | ExtID of the credential (default to null)
fidoUafPatchDTO = {"signCounter":0,"appId":"abc","deviceId":"deviceId","stateName":"active","modificationComment":"changed-by-admin","version":2,"validity":{"from":"2018-07-21T19:03:49Z","to":"2028-07-18T19:03:49Z"},"policyExtId":"fidoUafPolicyExtId"} # FidoUafPatchDTO | 

try:
    # Update FIDO UAF
    api_response = api_instance.patch_fido_credential1(clientExtId, userExtId, extId, fidoUafPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FIDOUAFRESTServiceApi->patchFidoCredential1: %s\n" % e)
extern crate FIDOUAFRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000002; // String
    let fidoUafPatchDTO = {"signCounter":0,"appId":"abc","deviceId":"deviceId","stateName":"active","modificationComment":"changed-by-admin","version":2,"validity":{"from":"2018-07-21T19:03:49Z","to":"2028-07-18T19:03:49Z"},"policyExtId":"fidoUafPolicyExtId"}; // FidoUafPatchDTO

    let mut context = FIDOUAFRESTServiceApi::Context::default();
    let result = client.patchFidoCredential1(clientExtId, userExtId, extId, fidoUafPatchDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required
Body parameters
Name Description
fidoUafPatchDTO *

Responses


GenericCredentialRESTService

createGenericCredential

createGenericCredential
post/core/v1/{clientExtId}/users/{userExtId}/generic-credentials

**Since:** 2.73.0 **Required permission(s):** `AccessControl.CredentialCreate,AccessControl.CredentialView,AccessControl.CredentialModify,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView,AccessControl.PropertyValueCreate,AccessControl.PropertyValueDelete,AccessControl.PropertyValueModify` or `SelfAdmin` Role Creates a new generic credential for the user with the given external ID. While it is also possible to set the custom properties for the credential in the very same call, note that this call does not create new custom properties, only custom property values.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/generic-credentials" \
 -d '{
  "policyExtId" : "policyExtId",
  "identification" : "identification",
  "stateName" : "INITIAL",
  "extId" : "extId",
  "validity" : {
    "from" : "2023-01-01T00:00:00Z",
    "to" : "2033-12-31T23:59:59Z"
  },
  "properties" : {
    "key" : "properties"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GenericCredentialRESTServiceApi;

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

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

        // Create an instance of the API class
        GenericCredentialRESTServiceApi apiInstance = new GenericCredentialRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        GenericCredentialCreateDTO genericCredentialCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active","properties":{"custom_property1":"value1","custom_property2":"value2"},"validity":{"from":"2000-01-01T00:00:00Z","to":"2050-01-01T00:00:00Z"}}; // GenericCredentialCreateDTO | 

        try {
            apiInstance.createGenericCredential(clientExtId, userExtId, genericCredentialCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling GenericCredentialRESTServiceApi#createGenericCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final GenericCredentialCreateDTO genericCredentialCreateDTO = new GenericCredentialCreateDTO(); // GenericCredentialCreateDTO | 

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

import org.openapitools.client.api.GenericCredentialRESTServiceApi;

public class GenericCredentialRESTServiceApiExample {
    public static void main(String[] args) {
        GenericCredentialRESTServiceApi apiInstance = new GenericCredentialRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        GenericCredentialCreateDTO genericCredentialCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active","properties":{"custom_property1":"value1","custom_property2":"value2"},"validity":{"from":"2000-01-01T00:00:00Z","to":"2050-01-01T00:00:00Z"}}; // GenericCredentialCreateDTO | 

        try {
            apiInstance.createGenericCredential(clientExtId, userExtId, genericCredentialCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling GenericCredentialRESTServiceApi#createGenericCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GenericCredentialRESTServiceApi *apiInstance = [[GenericCredentialRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
GenericCredentialCreateDTO *genericCredentialCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active","properties":{"custom_property1":"value1","custom_property2":"value2"},"validity":{"from":"2000-01-01T00:00:00Z","to":"2050-01-01T00:00:00Z"}}; // 

// Create a generic credential
[apiInstance createGenericCredentialWith:clientExtId
    userExtId:userExtId
    genericCredentialCreateDTO:genericCredentialCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.GenericCredentialRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var genericCredentialCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active","properties":{"custom_property1":"value1","custom_property2":"value2"},"validity":{"from":"2000-01-01T00:00:00Z","to":"2050-01-01T00:00:00Z"}}; // {GenericCredentialCreateDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new GenericCredentialRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var genericCredentialCreateDTO = new GenericCredentialCreateDTO(); // GenericCredentialCreateDTO | 

            try {
                // Create a generic credential
                apiInstance.createGenericCredential(clientExtId, userExtId, genericCredentialCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling GenericCredentialRESTServiceApi.createGenericCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GenericCredentialRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$genericCredentialCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active","properties":{"custom_property1":"value1","custom_property2":"value2"},"validity":{"from":"2000-01-01T00:00:00Z","to":"2050-01-01T00:00:00Z"}}; // GenericCredentialCreateDTO | 

try {
    $api_instance->createGenericCredential($clientExtId, $userExtId, $genericCredentialCreateDTO);
} catch (Exception $e) {
    echo 'Exception when calling GenericCredentialRESTServiceApi->createGenericCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GenericCredentialRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GenericCredentialRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $genericCredentialCreateDTO = WWW::OPenAPIClient::Object::GenericCredentialCreateDTO->new(); # GenericCredentialCreateDTO | 

eval {
    $api_instance->createGenericCredential(clientExtId => $clientExtId, userExtId => $userExtId, genericCredentialCreateDTO => $genericCredentialCreateDTO);
};
if ($@) {
    warn "Exception when calling GenericCredentialRESTServiceApi->createGenericCredential: $@\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.GenericCredentialRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
genericCredentialCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active","properties":{"custom_property1":"value1","custom_property2":"value2"},"validity":{"from":"2000-01-01T00:00:00Z","to":"2050-01-01T00:00:00Z"}} # GenericCredentialCreateDTO | 

try:
    # Create a generic credential
    api_instance.create_generic_credential(clientExtId, userExtId, genericCredentialCreateDTO)
except ApiException as e:
    print("Exception when calling GenericCredentialRESTServiceApi->createGenericCredential: %s\n" % e)
extern crate GenericCredentialRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let genericCredentialCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active","properties":{"custom_property1":"value1","custom_property2":"value2"},"validity":{"from":"2000-01-01T00:00:00Z","to":"2050-01-01T00:00:00Z"}}; // GenericCredentialCreateDTO

    let mut context = GenericCredentialRESTServiceApi::Context::default();
    let result = client.createGenericCredential(clientExtId, userExtId, genericCredentialCreateDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
genericCredentialCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

deleteGenericCredential

deleteGenericCredential
delete/core/v1/{clientExtId}/users/{userExtId}/generic-credentials/{extId}

**Since:** 2.73.0 **Required permission(s):** `AccessControl.CredentialDelete` or `SelfAdmin` Role Deletes the generic credential of the user with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/generic-credentials/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GenericCredentialRESTServiceApi;

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

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

        // Create an instance of the API class
        GenericCredentialRESTServiceApi apiInstance = new GenericCredentialRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 4321; // String | ExtID of the generic credential

        try {
            apiInstance.deleteGenericCredential(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling GenericCredentialRESTServiceApi#deleteGenericCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the generic credential

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

import org.openapitools.client.api.GenericCredentialRESTServiceApi;

public class GenericCredentialRESTServiceApiExample {
    public static void main(String[] args) {
        GenericCredentialRESTServiceApi apiInstance = new GenericCredentialRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 4321; // String | ExtID of the generic credential

        try {
            apiInstance.deleteGenericCredential(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling GenericCredentialRESTServiceApi#deleteGenericCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GenericCredentialRESTServiceApi *apiInstance = [[GenericCredentialRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 4321; // ExtID of the generic credential (default to null)

// Delete Generic Credential
[apiInstance deleteGenericCredentialWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.GenericCredentialRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 4321; // {String} ExtID of the generic credential

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

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

            // Create an instance of the API class
            var apiInstance = new GenericCredentialRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 4321;  // String | ExtID of the generic credential (default to null)

            try {
                // Delete Generic Credential
                apiInstance.deleteGenericCredential(clientExtId, userExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling GenericCredentialRESTServiceApi.deleteGenericCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GenericCredentialRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 4321; // String | ExtID of the generic credential

try {
    $api_instance->deleteGenericCredential($clientExtId, $userExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling GenericCredentialRESTServiceApi->deleteGenericCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GenericCredentialRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GenericCredentialRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 4321; # String | ExtID of the generic credential

eval {
    $api_instance->deleteGenericCredential(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling GenericCredentialRESTServiceApi->deleteGenericCredential: $@\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.GenericCredentialRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 4321 # String | ExtID of the generic credential (default to null)

try:
    # Delete Generic Credential
    api_instance.delete_generic_credential(clientExtId, userExtId, extId)
except ApiException as e:
    print("Exception when calling GenericCredentialRESTServiceApi->deleteGenericCredential: %s\n" % e)
extern crate GenericCredentialRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 4321; // String

    let mut context = GenericCredentialRESTServiceApi::Context::default();
    let result = client.deleteGenericCredential(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the generic credential
Required

Responses


getGenericCredential

getGenericCredential
get/core/v1/{clientExtId}/users/{userExtId}/generic-credentials/{extId}

**Since:** 2.73.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns the generic credential with the given external ID, belonging to the user with the given external ID. Custom properties may be returned with the credential, but if the caller does not have the right to access them, then they are simply omitted from the DTO.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/generic-credentials/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GenericCredentialRESTServiceApi;

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

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

        // Create an instance of the API class
        GenericCredentialRESTServiceApi apiInstance = new GenericCredentialRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 4321; // String | ExtID of the generic credential

        try {
            GenericCredentialGetDTO result = apiInstance.getGenericCredential(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GenericCredentialRESTServiceApi#getGenericCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the generic credential

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

import org.openapitools.client.api.GenericCredentialRESTServiceApi;

public class GenericCredentialRESTServiceApiExample {
    public static void main(String[] args) {
        GenericCredentialRESTServiceApi apiInstance = new GenericCredentialRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 4321; // String | ExtID of the generic credential

        try {
            GenericCredentialGetDTO result = apiInstance.getGenericCredential(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GenericCredentialRESTServiceApi#getGenericCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GenericCredentialRESTServiceApi *apiInstance = [[GenericCredentialRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 4321; // ExtID of the generic credential (default to null)

// Get Generic Credential
[apiInstance getGenericCredentialWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(GenericCredentialGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.GenericCredentialRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 4321; // {String} ExtID of the generic credential

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

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

            // Create an instance of the API class
            var apiInstance = new GenericCredentialRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 4321;  // String | ExtID of the generic credential (default to null)

            try {
                // Get Generic Credential
                GenericCredentialGetDTO result = apiInstance.getGenericCredential(clientExtId, userExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GenericCredentialRESTServiceApi.getGenericCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GenericCredentialRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 4321; // String | ExtID of the generic credential

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GenericCredentialRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 4321; # String | ExtID of the generic credential

eval {
    my $result = $api_instance->getGenericCredential(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GenericCredentialRESTServiceApi->getGenericCredential: $@\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.GenericCredentialRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 4321 # String | ExtID of the generic credential (default to null)

try:
    # Get Generic Credential
    api_response = api_instance.get_generic_credential(clientExtId, userExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GenericCredentialRESTServiceApi->getGenericCredential: %s\n" % e)
extern crate GenericCredentialRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 4321; // String

    let mut context = GenericCredentialRESTServiceApi::Context::default();
    let result = client.getGenericCredential(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the generic credential
Required

Responses


getGenericCredentialProperties

getGenericCredentialProperties
get/core/v1/{clientExtId}/users/{userExtId}/generic-credentials/{extId}/properties

**Since:** 2.73.0 **Required permission(s):** `AccessControl.CredentialView,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView` or `SelfAdmin` Role Returns all properties of the generic credential with the given external ID, as an object of key-value pairs. Properties are additional, customer-specific attributes of an entity.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/generic-credentials/{extId}/properties"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GenericCredentialRESTServiceApi;

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

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

        // Create an instance of the API class
        GenericCredentialRESTServiceApi apiInstance = new GenericCredentialRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000033; // String | ExtID of the generic credential

        try {
            map['String', 'String'] result = apiInstance.getGenericCredentialProperties(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GenericCredentialRESTServiceApi#getGenericCredentialProperties");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the generic credential

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

import org.openapitools.client.api.GenericCredentialRESTServiceApi;

public class GenericCredentialRESTServiceApiExample {
    public static void main(String[] args) {
        GenericCredentialRESTServiceApi apiInstance = new GenericCredentialRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000033; // String | ExtID of the generic credential

        try {
            map['String', 'String'] result = apiInstance.getGenericCredentialProperties(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GenericCredentialRESTServiceApi#getGenericCredentialProperties");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GenericCredentialRESTServiceApi *apiInstance = [[GenericCredentialRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000033; // ExtID of the generic credential (default to null)

// Get properties
[apiInstance getGenericCredentialPropertiesWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.GenericCredentialRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000033; // {String} ExtID of the generic credential

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

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

            // Create an instance of the API class
            var apiInstance = new GenericCredentialRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000033;  // String | ExtID of the generic credential (default to null)

            try {
                // Get properties
                map['String', 'String'] result = apiInstance.getGenericCredentialProperties(clientExtId, userExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GenericCredentialRESTServiceApi.getGenericCredentialProperties: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GenericCredentialRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000033; // String | ExtID of the generic credential

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GenericCredentialRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000033; # String | ExtID of the generic credential

eval {
    my $result = $api_instance->getGenericCredentialProperties(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GenericCredentialRESTServiceApi->getGenericCredentialProperties: $@\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.GenericCredentialRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000033 # String | ExtID of the generic credential (default to null)

try:
    # Get properties
    api_response = api_instance.get_generic_credential_properties(clientExtId, userExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GenericCredentialRESTServiceApi->getGenericCredentialProperties: %s\n" % e)
extern crate GenericCredentialRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000033; // String

    let mut context = GenericCredentialRESTServiceApi::Context::default();
    let result = client.getGenericCredentialProperties(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the generic credential
Required

Responses


getGenericCredentials

getGenericCredentials
get/core/v1/{clientExtId}/users/{userExtId}/generic-credentials

**Since:** 2.73.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns all generic credentials of the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/generic-credentials?continuationToken=continuationToken_example&limit=1000"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GenericCredentialRESTServiceApi;

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

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

        // Create an instance of the API class
        GenericCredentialRESTServiceApi apiInstance = new GenericCredentialRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 250002047; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForGenericCredentialGetDTO result = apiInstance.getGenericCredentials(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GenericCredentialRESTServiceApi#getGenericCredentials");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

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

import org.openapitools.client.api.GenericCredentialRESTServiceApi;

public class GenericCredentialRESTServiceApiExample {
    public static void main(String[] args) {
        GenericCredentialRESTServiceApi apiInstance = new GenericCredentialRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 250002047; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForGenericCredentialGetDTO result = apiInstance.getGenericCredentials(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GenericCredentialRESTServiceApi#getGenericCredentials");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GenericCredentialRESTServiceApi *apiInstance = [[GenericCredentialRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 250002047; // ExtID of the user (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 1000; // Pagination limit (optional) (default to 0)

// Get all generic credentials
[apiInstance getGenericCredentialsWith:clientExtId
    userExtId:userExtId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForGenericCredentialGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.GenericCredentialRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 250002047; // {String} ExtID of the user
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 1000 // {Integer} Pagination limit
};

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

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

            // Create an instance of the API class
            var apiInstance = new GenericCredentialRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 250002047;  // String | ExtID of the user (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 1000;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get all generic credentials
                ItemsWrapperForGenericCredentialGetDTO result = apiInstance.getGenericCredentials(clientExtId, userExtId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GenericCredentialRESTServiceApi.getGenericCredentials: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GenericCredentialRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 250002047; // String | ExtID of the user
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 1000; // Integer | Pagination limit

try {
    $result = $api_instance->getGenericCredentials($clientExtId, $userExtId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GenericCredentialRESTServiceApi->getGenericCredentials: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GenericCredentialRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GenericCredentialRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 250002047; # String | ExtID of the user
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 1000; # Integer | Pagination limit

eval {
    my $result = $api_instance->getGenericCredentials(clientExtId => $clientExtId, userExtId => $userExtId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GenericCredentialRESTServiceApi->getGenericCredentials: $@\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.GenericCredentialRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 250002047 # String | ExtID of the user (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 1000 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get all generic credentials
    api_response = api_instance.get_generic_credentials(clientExtId, userExtId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GenericCredentialRESTServiceApi->getGenericCredentials: %s\n" % e)
extern crate GenericCredentialRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 250002047; // String
    let continuationToken = continuationToken_example; // String
    let limit = 1000; // Integer

    let mut context = GenericCredentialRESTServiceApi::Context::default();
    let result = client.getGenericCredentials(clientExtId, userExtId, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


patchGenericCredentialProperties

patchGenericCredentialProperties
patch/core/v1/{clientExtId}/users/{userExtId}/generic-credentials/{extId}/properties

**Since:** 2.73.0 **Required permission(s):** `AccessControl.CredentialView,AccessControl.CredentialModify,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView,AccessControl.PropertyValueCreate,AccessControl.PropertyValueDelete,AccessControl.PropertyValueModify` or `SelfAdmin` Role Updates the properties of the generic credential with the given external ID, belonging to the user and client with given external IDs. The body has to contain an object of key-value property pairs.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/generic-credentials/{extId}/properties" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GenericCredentialRESTServiceApi;

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

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

        // Create an instance of the API class
        GenericCredentialRESTServiceApi apiInstance = new GenericCredentialRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000033; // String | ExtID of the generic credential
        map[String, String] requestBody = {"propertyKey1":"propertyNewValue1","propertyKey3":"propertyNewValue3"}; // map[String, String] | 

        try {
            map['String', 'String'] result = apiInstance.patchGenericCredentialProperties(clientExtId, userExtId, extId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GenericCredentialRESTServiceApi#patchGenericCredentialProperties");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the generic credential
final map[String, String] requestBody = new map[String, String](); // map[String, String] | 

try {
    final result = await api_instance.patchGenericCredentialProperties(clientExtId, userExtId, extId, requestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchGenericCredentialProperties: $e\n');
}

import org.openapitools.client.api.GenericCredentialRESTServiceApi;

public class GenericCredentialRESTServiceApiExample {
    public static void main(String[] args) {
        GenericCredentialRESTServiceApi apiInstance = new GenericCredentialRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000033; // String | ExtID of the generic credential
        map[String, String] requestBody = {"propertyKey1":"propertyNewValue1","propertyKey3":"propertyNewValue3"}; // map[String, String] | 

        try {
            map['String', 'String'] result = apiInstance.patchGenericCredentialProperties(clientExtId, userExtId, extId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GenericCredentialRESTServiceApi#patchGenericCredentialProperties");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GenericCredentialRESTServiceApi *apiInstance = [[GenericCredentialRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000033; // ExtID of the generic credential (default to null)
map[String, String] *requestBody = {"propertyKey1":"propertyNewValue1","propertyKey3":"propertyNewValue3"}; // 

// Update generic credential properties
[apiInstance patchGenericCredentialPropertiesWith:clientExtId
    userExtId:userExtId
    extId:extId
    requestBody:requestBody
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.GenericCredentialRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000033; // {String} ExtID of the generic credential
var requestBody = {"propertyKey1":"propertyNewValue1","propertyKey3":"propertyNewValue3"}; // {map[String, String]} 

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

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

            // Create an instance of the API class
            var apiInstance = new GenericCredentialRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000033;  // String | ExtID of the generic credential (default to null)
            var requestBody = new map[String, String](); // map[String, String] | 

            try {
                // Update generic credential properties
                map['String', 'String'] result = apiInstance.patchGenericCredentialProperties(clientExtId, userExtId, extId, requestBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GenericCredentialRESTServiceApi.patchGenericCredentialProperties: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GenericCredentialRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000033; // String | ExtID of the generic credential
$requestBody = {"propertyKey1":"propertyNewValue1","propertyKey3":"propertyNewValue3"}; // map[String, String] | 

try {
    $result = $api_instance->patchGenericCredentialProperties($clientExtId, $userExtId, $extId, $requestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GenericCredentialRESTServiceApi->patchGenericCredentialProperties: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GenericCredentialRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GenericCredentialRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000033; # String | ExtID of the generic credential
my $requestBody = WWW::OPenAPIClient::Object::map[String, String]->new(); # map[String, String] | 

eval {
    my $result = $api_instance->patchGenericCredentialProperties(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId, requestBody => $requestBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GenericCredentialRESTServiceApi->patchGenericCredentialProperties: $@\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.GenericCredentialRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000033 # String | ExtID of the generic credential (default to null)
requestBody = {"propertyKey1":"propertyNewValue1","propertyKey3":"propertyNewValue3"} # map[String, String] | 

try:
    # Update generic credential properties
    api_response = api_instance.patch_generic_credential_properties(clientExtId, userExtId, extId, requestBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GenericCredentialRESTServiceApi->patchGenericCredentialProperties: %s\n" % e)
extern crate GenericCredentialRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000033; // String
    let requestBody = {"propertyKey1":"propertyNewValue1","propertyKey3":"propertyNewValue3"}; // map[String, String]

    let mut context = GenericCredentialRESTServiceApi::Context::default();
    let result = client.patchGenericCredentialProperties(clientExtId, userExtId, extId, requestBody, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the generic credential
Required
Body parameters
Name Description
requestBody *

Responses


updateGenericCredential

updateGenericCredential
patch/core/v1/{clientExtId}/users/{userExtId}/generic-credentials/{extId}

**Since:** 2.73.0 **Required permission(s):** `AccessControl.CredentialView,AccessControl.CredentialModify` or `SelfAdmin` Role Updates a generic credential with the given external ID for the user with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/generic-credentials/{extId}" \
 -d '{
  "policyExtId" : "policyExtId",
  "identification" : "identification",
  "stateName" : "INITIAL",
  "modificationComment" : "modificationComment",
  "version" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GenericCredentialRESTServiceApi;

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

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

        // Create an instance of the API class
        GenericCredentialRESTServiceApi apiInstance = new GenericCredentialRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 4321; // String | ExtID of the generic credential
        GenericCredentialPatchDTO genericCredentialPatchDTO = {"policyExtId":"6789","stateName":"initial","identification":"identification","modificationComment":"changed","version":4}; // GenericCredentialPatchDTO | 

        try {
            GenericCredentialGetDTO result = apiInstance.updateGenericCredential(clientExtId, userExtId, extId, genericCredentialPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GenericCredentialRESTServiceApi#updateGenericCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the generic credential
final GenericCredentialPatchDTO genericCredentialPatchDTO = new GenericCredentialPatchDTO(); // GenericCredentialPatchDTO | 

try {
    final result = await api_instance.updateGenericCredential(clientExtId, userExtId, extId, genericCredentialPatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateGenericCredential: $e\n');
}

import org.openapitools.client.api.GenericCredentialRESTServiceApi;

public class GenericCredentialRESTServiceApiExample {
    public static void main(String[] args) {
        GenericCredentialRESTServiceApi apiInstance = new GenericCredentialRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 4321; // String | ExtID of the generic credential
        GenericCredentialPatchDTO genericCredentialPatchDTO = {"policyExtId":"6789","stateName":"initial","identification":"identification","modificationComment":"changed","version":4}; // GenericCredentialPatchDTO | 

        try {
            GenericCredentialGetDTO result = apiInstance.updateGenericCredential(clientExtId, userExtId, extId, genericCredentialPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GenericCredentialRESTServiceApi#updateGenericCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GenericCredentialRESTServiceApi *apiInstance = [[GenericCredentialRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 4321; // ExtID of the generic credential (default to null)
GenericCredentialPatchDTO *genericCredentialPatchDTO = {"policyExtId":"6789","stateName":"initial","identification":"identification","modificationComment":"changed","version":4}; // 

// Update a generic credential
[apiInstance updateGenericCredentialWith:clientExtId
    userExtId:userExtId
    extId:extId
    genericCredentialPatchDTO:genericCredentialPatchDTO
              completionHandler: ^(GenericCredentialGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.GenericCredentialRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 4321; // {String} ExtID of the generic credential
var genericCredentialPatchDTO = {"policyExtId":"6789","stateName":"initial","identification":"identification","modificationComment":"changed","version":4}; // {GenericCredentialPatchDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new GenericCredentialRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 4321;  // String | ExtID of the generic credential (default to null)
            var genericCredentialPatchDTO = new GenericCredentialPatchDTO(); // GenericCredentialPatchDTO | 

            try {
                // Update a generic credential
                GenericCredentialGetDTO result = apiInstance.updateGenericCredential(clientExtId, userExtId, extId, genericCredentialPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GenericCredentialRESTServiceApi.updateGenericCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GenericCredentialRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 4321; // String | ExtID of the generic credential
$genericCredentialPatchDTO = {"policyExtId":"6789","stateName":"initial","identification":"identification","modificationComment":"changed","version":4}; // GenericCredentialPatchDTO | 

try {
    $result = $api_instance->updateGenericCredential($clientExtId, $userExtId, $extId, $genericCredentialPatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GenericCredentialRESTServiceApi->updateGenericCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GenericCredentialRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GenericCredentialRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 4321; # String | ExtID of the generic credential
my $genericCredentialPatchDTO = WWW::OPenAPIClient::Object::GenericCredentialPatchDTO->new(); # GenericCredentialPatchDTO | 

eval {
    my $result = $api_instance->updateGenericCredential(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId, genericCredentialPatchDTO => $genericCredentialPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GenericCredentialRESTServiceApi->updateGenericCredential: $@\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.GenericCredentialRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 4321 # String | ExtID of the generic credential (default to null)
genericCredentialPatchDTO = {"policyExtId":"6789","stateName":"initial","identification":"identification","modificationComment":"changed","version":4} # GenericCredentialPatchDTO | 

try:
    # Update a generic credential
    api_response = api_instance.update_generic_credential(clientExtId, userExtId, extId, genericCredentialPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GenericCredentialRESTServiceApi->updateGenericCredential: %s\n" % e)
extern crate GenericCredentialRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 4321; // String
    let genericCredentialPatchDTO = {"policyExtId":"6789","stateName":"initial","identification":"identification","modificationComment":"changed","version":4}; // GenericCredentialPatchDTO

    let mut context = GenericCredentialRESTServiceApi::Context::default();
    let result = client.updateGenericCredential(clientExtId, userExtId, extId, genericCredentialPatchDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the generic credential
Required
Body parameters
Name Description
genericCredentialPatchDTO *

Responses


IdentityRESTService

addProfileAndUser

addProfileAndUser
post/core/v1/{clientExtId}/identity

**Required permission(s):** `AccessControl.UserCreate,AccessControl.LoginIdOverride,AccessControl.UserCreateTechUser,AccessControl.ProfileCreate,AccessControl.UserView,AccessControl.UserModify,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView,AccessControl.PropertyValueCreate,AccessControl.PropertyValueDelete,AccessControl.PropertyValueModify` Creates a new user and profile for the client with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/identity" \
 -d '{
  "profile" : {
    "profileState" : "profileState",
    "unitExtId" : "unitExtId",
    "modificationComment" : "modificationComment",
    "name" : "name",
    "extId" : "extId",
    "validity" : {
      "from" : "2023-01-01T00:00:00Z",
      "to" : "2033-12-31T23:59:59Z"
    },
    "isDefaultProfile" : true,
    "remarks" : "remarks"
  },
  "user" : {
    "loginId" : "loginId",
    "address" : {
      "dwellingNumber" : "A12",
      "city" : "Zürich",
      "street" : "Bahnhofstrasse",
      "countryCode" : "CH",
      "postalCode" : 8001,
      "postOfficeBoxText" : "Postfach",
      "houseNumber" : 1,
      "locality" : "Kreis 1",
      "addressline2" : "Wohnung 2",
      "addressline1" : "Bahnhofstrasse 1",
      "postOfficeBoxNumber" : 123
    },
    "gender" : "female",
    "modificationComment" : "modificationComment",
    "sex" : "sex",
    "languageCode" : "languageCode",
    "birthDate" : "birthDate",
    "userState" : "active",
    "name" : {
      "firstName" : "John",
      "familyName" : "Doe",
      "title" : "Mr."
    },
    "isTechnicalUser" : true,
    "extId" : "extId",
    "validity" : {
      "from" : "2023-01-01T00:00:00Z",
      "to" : "2033-12-31T23:59:59Z"
    },
    "properties" : {
      "key" : "properties"
    },
    "contacts" : {
      "mobile" : "+41781254156",
      "telephone" : "+41781254153",
      "telefax" : "+41781254154",
      "email" : "[email protected]"
    },
    "remarks" : "remarks"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.IdentityRESTServiceApi;

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

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

        // Create an instance of the API class
        IdentityRESTServiceApi apiInstance = new IdentityRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        IdentityCreateDTO identityCreateDTO = {"user":{"extId":"4254","userState":"active","loginId":"testUser","languageCode":"en","isTechnicalUser":false,"name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Zurich","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781254153","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is the new test user john doe","modificationComment":"They live in ZH","properties":{"custom_property1":"value1","custom_property2":"value2"}},"profile":{"extId":"4254","unitExtId":"1000","profileState":"active","name":"something","isDefaultProfile":true,"remarks":"something","modificationComment":"none","validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"}}}; // IdentityCreateDTO | 

        try {
            apiInstance.addProfileAndUser(clientExtId, identityCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling IdentityRESTServiceApi#addProfileAndUser");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final IdentityCreateDTO identityCreateDTO = new IdentityCreateDTO(); // IdentityCreateDTO | 

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

import org.openapitools.client.api.IdentityRESTServiceApi;

public class IdentityRESTServiceApiExample {
    public static void main(String[] args) {
        IdentityRESTServiceApi apiInstance = new IdentityRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        IdentityCreateDTO identityCreateDTO = {"user":{"extId":"4254","userState":"active","loginId":"testUser","languageCode":"en","isTechnicalUser":false,"name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Zurich","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781254153","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is the new test user john doe","modificationComment":"They live in ZH","properties":{"custom_property1":"value1","custom_property2":"value2"}},"profile":{"extId":"4254","unitExtId":"1000","profileState":"active","name":"something","isDefaultProfile":true,"remarks":"something","modificationComment":"none","validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"}}}; // IdentityCreateDTO | 

        try {
            apiInstance.addProfileAndUser(clientExtId, identityCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling IdentityRESTServiceApi#addProfileAndUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
IdentityRESTServiceApi *apiInstance = [[IdentityRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
IdentityCreateDTO *identityCreateDTO = {"user":{"extId":"4254","userState":"active","loginId":"testUser","languageCode":"en","isTechnicalUser":false,"name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Zurich","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781254153","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is the new test user john doe","modificationComment":"They live in ZH","properties":{"custom_property1":"value1","custom_property2":"value2"}},"profile":{"extId":"4254","unitExtId":"1000","profileState":"active","name":"something","isDefaultProfile":true,"remarks":"something","modificationComment":"none","validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"}}}; // 

// Create identity
[apiInstance addProfileAndUserWith:clientExtId
    identityCreateDTO:identityCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.IdentityRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var identityCreateDTO = {"user":{"extId":"4254","userState":"active","loginId":"testUser","languageCode":"en","isTechnicalUser":false,"name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Zurich","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781254153","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is the new test user john doe","modificationComment":"They live in ZH","properties":{"custom_property1":"value1","custom_property2":"value2"}},"profile":{"extId":"4254","unitExtId":"1000","profileState":"active","name":"something","isDefaultProfile":true,"remarks":"something","modificationComment":"none","validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"}}}; // {IdentityCreateDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new IdentityRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var identityCreateDTO = new IdentityCreateDTO(); // IdentityCreateDTO | 

            try {
                // Create identity
                apiInstance.addProfileAndUser(clientExtId, identityCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling IdentityRESTServiceApi.addProfileAndUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\IdentityRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$identityCreateDTO = {"user":{"extId":"4254","userState":"active","loginId":"testUser","languageCode":"en","isTechnicalUser":false,"name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Zurich","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781254153","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is the new test user john doe","modificationComment":"They live in ZH","properties":{"custom_property1":"value1","custom_property2":"value2"}},"profile":{"extId":"4254","unitExtId":"1000","profileState":"active","name":"something","isDefaultProfile":true,"remarks":"something","modificationComment":"none","validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"}}}; // IdentityCreateDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::IdentityRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $identityCreateDTO = WWW::OPenAPIClient::Object::IdentityCreateDTO->new(); # IdentityCreateDTO | 

eval {
    $api_instance->addProfileAndUser(clientExtId => $clientExtId, identityCreateDTO => $identityCreateDTO);
};
if ($@) {
    warn "Exception when calling IdentityRESTServiceApi->addProfileAndUser: $@\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.IdentityRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
identityCreateDTO = {"user":{"extId":"4254","userState":"active","loginId":"testUser","languageCode":"en","isTechnicalUser":false,"name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Zurich","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781254153","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is the new test user john doe","modificationComment":"They live in ZH","properties":{"custom_property1":"value1","custom_property2":"value2"}},"profile":{"extId":"4254","unitExtId":"1000","profileState":"active","name":"something","isDefaultProfile":true,"remarks":"something","modificationComment":"none","validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"}}} # IdentityCreateDTO | 

try:
    # Create identity
    api_instance.add_profile_and_user(clientExtId, identityCreateDTO)
except ApiException as e:
    print("Exception when calling IdentityRESTServiceApi->addProfileAndUser: %s\n" % e)
extern crate IdentityRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let identityCreateDTO = {"user":{"extId":"4254","userState":"active","loginId":"testUser","languageCode":"en","isTechnicalUser":false,"name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Zurich","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781254153","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is the new test user john doe","modificationComment":"They live in ZH","properties":{"custom_property1":"value1","custom_property2":"value2"}},"profile":{"extId":"4254","unitExtId":"1000","profileState":"active","name":"something","isDefaultProfile":true,"remarks":"something","modificationComment":"none","validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"}}}; // IdentityCreateDTO

    let mut context = IdentityRESTServiceApi::Context::default();
    let result = client.addProfileAndUser(clientExtId, identityCreateDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
Body parameters
Name Description
identityCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

KerberosRESTService

createKerberosCredential

createKerberosCredential
post/core/v1/{clientExtId}/users/{userExtId}/kerberos

**Since:** 2.79.0 **Required permission(s):** `AccessControl.CredentialCreate` Creates a Kerberos credential for the user with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/kerberos" \
 -d '{
  "stateName" : "INITIAL",
  "kerberosId" : "kerberosId",
  "extId" : "extId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KerberosRESTServiceApi;

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

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

        // Create an instance of the API class
        KerberosRESTServiceApi apiInstance = new KerberosRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        KerberosCreateDTO kerberosCreateDTO = {"extId":"kerberosExtId","kerberosId":"someKerberosId","stateName":"active"}; // KerberosCreateDTO | 

        try {
            apiInstance.createKerberosCredential(clientExtId, userExtId, kerberosCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling KerberosRESTServiceApi#createKerberosCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final KerberosCreateDTO kerberosCreateDTO = new KerberosCreateDTO(); // KerberosCreateDTO | 

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

import org.openapitools.client.api.KerberosRESTServiceApi;

public class KerberosRESTServiceApiExample {
    public static void main(String[] args) {
        KerberosRESTServiceApi apiInstance = new KerberosRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        KerberosCreateDTO kerberosCreateDTO = {"extId":"kerberosExtId","kerberosId":"someKerberosId","stateName":"active"}; // KerberosCreateDTO | 

        try {
            apiInstance.createKerberosCredential(clientExtId, userExtId, kerberosCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling KerberosRESTServiceApi#createKerberosCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
KerberosRESTServiceApi *apiInstance = [[KerberosRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
KerberosCreateDTO *kerberosCreateDTO = {"extId":"kerberosExtId","kerberosId":"someKerberosId","stateName":"active"}; // 

// Create Kerberos
[apiInstance createKerberosCredentialWith:clientExtId
    userExtId:userExtId
    kerberosCreateDTO:kerberosCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.KerberosRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var kerberosCreateDTO = {"extId":"kerberosExtId","kerberosId":"someKerberosId","stateName":"active"}; // {KerberosCreateDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new KerberosRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var kerberosCreateDTO = new KerberosCreateDTO(); // KerberosCreateDTO | 

            try {
                // Create Kerberos
                apiInstance.createKerberosCredential(clientExtId, userExtId, kerberosCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling KerberosRESTServiceApi.createKerberosCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KerberosRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$kerberosCreateDTO = {"extId":"kerberosExtId","kerberosId":"someKerberosId","stateName":"active"}; // KerberosCreateDTO | 

try {
    $api_instance->createKerberosCredential($clientExtId, $userExtId, $kerberosCreateDTO);
} catch (Exception $e) {
    echo 'Exception when calling KerberosRESTServiceApi->createKerberosCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KerberosRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KerberosRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $kerberosCreateDTO = WWW::OPenAPIClient::Object::KerberosCreateDTO->new(); # KerberosCreateDTO | 

eval {
    $api_instance->createKerberosCredential(clientExtId => $clientExtId, userExtId => $userExtId, kerberosCreateDTO => $kerberosCreateDTO);
};
if ($@) {
    warn "Exception when calling KerberosRESTServiceApi->createKerberosCredential: $@\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.KerberosRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
kerberosCreateDTO = {"extId":"kerberosExtId","kerberosId":"someKerberosId","stateName":"active"} # KerberosCreateDTO | 

try:
    # Create Kerberos
    api_instance.create_kerberos_credential(clientExtId, userExtId, kerberosCreateDTO)
except ApiException as e:
    print("Exception when calling KerberosRESTServiceApi->createKerberosCredential: %s\n" % e)
extern crate KerberosRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let kerberosCreateDTO = {"extId":"kerberosExtId","kerberosId":"someKerberosId","stateName":"active"}; // KerberosCreateDTO

    let mut context = KerberosRESTServiceApi::Context::default();
    let result = client.createKerberosCredential(clientExtId, userExtId, kerberosCreateDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
kerberosCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

deleteKerberosCredential

deleteKerberosCredential
delete/core/v1/{clientExtId}/users/{userExtId}/kerberos/{extId}

**Since:** 2.79.0 **Required permission(s):** `AccessControl.CredentialDelete` or `SelfAdmin` Role Deletes the Kerberos credential of the user with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/kerberos/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KerberosRESTServiceApi;

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

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

        // Create an instance of the API class
        KerberosRESTServiceApi apiInstance = new KerberosRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 250002053; // String | ExtID of the Kerberos credential

        try {
            apiInstance.deleteKerberosCredential(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KerberosRESTServiceApi#deleteKerberosCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the Kerberos credential

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

import org.openapitools.client.api.KerberosRESTServiceApi;

public class KerberosRESTServiceApiExample {
    public static void main(String[] args) {
        KerberosRESTServiceApi apiInstance = new KerberosRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 250002053; // String | ExtID of the Kerberos credential

        try {
            apiInstance.deleteKerberosCredential(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KerberosRESTServiceApi#deleteKerberosCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
KerberosRESTServiceApi *apiInstance = [[KerberosRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 250002053; // ExtID of the Kerberos credential (default to null)

// Delete Kerberos credential
[apiInstance deleteKerberosCredentialWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.KerberosRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 250002053; // {String} ExtID of the Kerberos credential

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

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

            // Create an instance of the API class
            var apiInstance = new KerberosRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 250002053;  // String | ExtID of the Kerberos credential (default to null)

            try {
                // Delete Kerberos credential
                apiInstance.deleteKerberosCredential(clientExtId, userExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling KerberosRESTServiceApi.deleteKerberosCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KerberosRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 250002053; // String | ExtID of the Kerberos credential

try {
    $api_instance->deleteKerberosCredential($clientExtId, $userExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling KerberosRESTServiceApi->deleteKerberosCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KerberosRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KerberosRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 250002053; # String | ExtID of the Kerberos credential

eval {
    $api_instance->deleteKerberosCredential(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling KerberosRESTServiceApi->deleteKerberosCredential: $@\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.KerberosRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 250002053 # String | ExtID of the Kerberos credential (default to null)

try:
    # Delete Kerberos credential
    api_instance.delete_kerberos_credential(clientExtId, userExtId, extId)
except ApiException as e:
    print("Exception when calling KerberosRESTServiceApi->deleteKerberosCredential: %s\n" % e)
extern crate KerberosRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 250002053; // String

    let mut context = KerberosRESTServiceApi::Context::default();
    let result = client.deleteKerberosCredential(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the Kerberos credential
Required

Responses


getAllKerberosCredentials

getAllKerberosCredentials
get/core/v1/{clientExtId}/users/{userExtId}/kerberos

**Since:** 2.79.0 **Required permission(s):** `AccessControl.CredentialView` Returns all Kerberos credentials of the user with the given user external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/kerberos?continuationToken=continuationToken_example&limit=1000"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KerberosRESTServiceApi;

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

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

        // Create an instance of the API class
        KerberosRESTServiceApi apiInstance = new KerberosRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForKerberosGetDTO result = apiInstance.getAllKerberosCredentials(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KerberosRESTServiceApi#getAllKerberosCredentials");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

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

import org.openapitools.client.api.KerberosRESTServiceApi;

public class KerberosRESTServiceApiExample {
    public static void main(String[] args) {
        KerberosRESTServiceApi apiInstance = new KerberosRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForKerberosGetDTO result = apiInstance.getAllKerberosCredentials(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KerberosRESTServiceApi#getAllKerberosCredentials");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
KerberosRESTServiceApi *apiInstance = [[KerberosRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 1000; // Pagination limit (optional) (default to 0)

// Get all Kerberos Credentials
[apiInstance getAllKerberosCredentialsWith:clientExtId
    userExtId:userExtId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForKerberosGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.KerberosRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 1000 // {Integer} Pagination limit
};

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

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

            // Create an instance of the API class
            var apiInstance = new KerberosRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 1000;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get all Kerberos Credentials
                ItemsWrapperForKerberosGetDTO result = apiInstance.getAllKerberosCredentials(clientExtId, userExtId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KerberosRESTServiceApi.getAllKerberosCredentials: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KerberosRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 1000; // Integer | Pagination limit

try {
    $result = $api_instance->getAllKerberosCredentials($clientExtId, $userExtId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KerberosRESTServiceApi->getAllKerberosCredentials: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KerberosRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KerberosRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 1000; # Integer | Pagination limit

eval {
    my $result = $api_instance->getAllKerberosCredentials(clientExtId => $clientExtId, userExtId => $userExtId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KerberosRESTServiceApi->getAllKerberosCredentials: $@\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.KerberosRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 1000 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get all Kerberos Credentials
    api_response = api_instance.get_all_kerberos_credentials(clientExtId, userExtId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KerberosRESTServiceApi->getAllKerberosCredentials: %s\n" % e)
extern crate KerberosRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let continuationToken = continuationToken_example; // String
    let limit = 1000; // Integer

    let mut context = KerberosRESTServiceApi::Context::default();
    let result = client.getAllKerberosCredentials(clientExtId, userExtId, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


getKerberosCredential

getKerberosCredential
get/core/v1/{clientExtId}/users/{userExtId}/kerberos/{extId}

**Since:** 2.79.0 **Required permission(s):** `AccessControl.CredentialView` Returns the Kerberos credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/kerberos/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KerberosRESTServiceApi;

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

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

        // Create an instance of the API class
        KerberosRESTServiceApi apiInstance = new KerberosRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 250002053; // String | ExtID of the Kerberos credential

        try {
            KerberosGetDTO result = apiInstance.getKerberosCredential(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KerberosRESTServiceApi#getKerberosCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the Kerberos credential

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

import org.openapitools.client.api.KerberosRESTServiceApi;

public class KerberosRESTServiceApiExample {
    public static void main(String[] args) {
        KerberosRESTServiceApi apiInstance = new KerberosRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 250002053; // String | ExtID of the Kerberos credential

        try {
            KerberosGetDTO result = apiInstance.getKerberosCredential(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KerberosRESTServiceApi#getKerberosCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
KerberosRESTServiceApi *apiInstance = [[KerberosRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 250002053; // ExtID of the Kerberos credential (default to null)

// Get Kerberos Credential
[apiInstance getKerberosCredentialWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(KerberosGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.KerberosRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 250002053; // {String} ExtID of the Kerberos credential

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

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

            // Create an instance of the API class
            var apiInstance = new KerberosRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 250002053;  // String | ExtID of the Kerberos credential (default to null)

            try {
                // Get Kerberos Credential
                KerberosGetDTO result = apiInstance.getKerberosCredential(clientExtId, userExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KerberosRESTServiceApi.getKerberosCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KerberosRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 250002053; // String | ExtID of the Kerberos credential

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KerberosRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 250002053; # String | ExtID of the Kerberos credential

eval {
    my $result = $api_instance->getKerberosCredential(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KerberosRESTServiceApi->getKerberosCredential: $@\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.KerberosRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 250002053 # String | ExtID of the Kerberos credential (default to null)

try:
    # Get Kerberos Credential
    api_response = api_instance.get_kerberos_credential(clientExtId, userExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KerberosRESTServiceApi->getKerberosCredential: %s\n" % e)
extern crate KerberosRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 250002053; // String

    let mut context = KerberosRESTServiceApi::Context::default();
    let result = client.getKerberosCredential(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the Kerberos credential
Required

Responses


updateKerberosCredential

updateKerberosCredential
patch/core/v1/{clientExtId}/users/{userExtId}/kerberos/{extId}

**Since:** 2.79.0 **Required permission(s):** `AccessControl.CredentialModify,AccessControl.CredentialView` Updates the Kerberos credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/kerberos/{extId}" \
 -d '{
  "stateName" : "INITIAL",
  "modificationComment" : "modificationComment",
  "kerberosId" : "kerberosId",
  "version" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KerberosRESTServiceApi;

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

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

        // Create an instance of the API class
        KerberosRESTServiceApi apiInstance = new KerberosRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 250002053; // String | ExtID of the Kerberos credential
        KerberosPatchDTO kerberosPatchDTO = {"kerberosId":"user-login-ID-1@windows-domain","stateName":"active","modificationComment":"Update kerberos comment","version":4}; // KerberosPatchDTO | 

        try {
            KerberosGetDTO result = apiInstance.updateKerberosCredential(clientExtId, userExtId, extId, kerberosPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KerberosRESTServiceApi#updateKerberosCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the Kerberos credential
final KerberosPatchDTO kerberosPatchDTO = new KerberosPatchDTO(); // KerberosPatchDTO | 

try {
    final result = await api_instance.updateKerberosCredential(clientExtId, userExtId, extId, kerberosPatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateKerberosCredential: $e\n');
}

import org.openapitools.client.api.KerberosRESTServiceApi;

public class KerberosRESTServiceApiExample {
    public static void main(String[] args) {
        KerberosRESTServiceApi apiInstance = new KerberosRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 250002053; // String | ExtID of the Kerberos credential
        KerberosPatchDTO kerberosPatchDTO = {"kerberosId":"user-login-ID-1@windows-domain","stateName":"active","modificationComment":"Update kerberos comment","version":4}; // KerberosPatchDTO | 

        try {
            KerberosGetDTO result = apiInstance.updateKerberosCredential(clientExtId, userExtId, extId, kerberosPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KerberosRESTServiceApi#updateKerberosCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
KerberosRESTServiceApi *apiInstance = [[KerberosRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 250002053; // ExtID of the Kerberos credential (default to null)
KerberosPatchDTO *kerberosPatchDTO = {"kerberosId":"user-login-ID-1@windows-domain","stateName":"active","modificationComment":"Update kerberos comment","version":4}; // 

// Update Kerberos credential
[apiInstance updateKerberosCredentialWith:clientExtId
    userExtId:userExtId
    extId:extId
    kerberosPatchDTO:kerberosPatchDTO
              completionHandler: ^(KerberosGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.KerberosRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 250002053; // {String} ExtID of the Kerberos credential
var kerberosPatchDTO = {"kerberosId":"user-login-ID-1@windows-domain","stateName":"active","modificationComment":"Update kerberos comment","version":4}; // {KerberosPatchDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new KerberosRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 250002053;  // String | ExtID of the Kerberos credential (default to null)
            var kerberosPatchDTO = new KerberosPatchDTO(); // KerberosPatchDTO | 

            try {
                // Update Kerberos credential
                KerberosGetDTO result = apiInstance.updateKerberosCredential(clientExtId, userExtId, extId, kerberosPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KerberosRESTServiceApi.updateKerberosCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KerberosRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 250002053; // String | ExtID of the Kerberos credential
$kerberosPatchDTO = {"kerberosId":"user-login-ID-1@windows-domain","stateName":"active","modificationComment":"Update kerberos comment","version":4}; // KerberosPatchDTO | 

try {
    $result = $api_instance->updateKerberosCredential($clientExtId, $userExtId, $extId, $kerberosPatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KerberosRESTServiceApi->updateKerberosCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KerberosRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KerberosRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 250002053; # String | ExtID of the Kerberos credential
my $kerberosPatchDTO = WWW::OPenAPIClient::Object::KerberosPatchDTO->new(); # KerberosPatchDTO | 

eval {
    my $result = $api_instance->updateKerberosCredential(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId, kerberosPatchDTO => $kerberosPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KerberosRESTServiceApi->updateKerberosCredential: $@\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.KerberosRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 250002053 # String | ExtID of the Kerberos credential (default to null)
kerberosPatchDTO = {"kerberosId":"user-login-ID-1@windows-domain","stateName":"active","modificationComment":"Update kerberos comment","version":4} # KerberosPatchDTO | 

try:
    # Update Kerberos credential
    api_response = api_instance.update_kerberos_credential(clientExtId, userExtId, extId, kerberosPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KerberosRESTServiceApi->updateKerberosCredential: %s\n" % e)
extern crate KerberosRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 250002053; // String
    let kerberosPatchDTO = {"kerberosId":"user-login-ID-1@windows-domain","stateName":"active","modificationComment":"Update kerberos comment","version":4}; // KerberosPatchDTO

    let mut context = KerberosRESTServiceApi::Context::default();
    let result = client.updateKerberosCredential(clientExtId, userExtId, extId, kerberosPatchDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the Kerberos credential
Required
Body parameters
Name Description
kerberosPatchDTO *

Responses


MTANRESTService

createMTan

createMTan
post/core/v1/{clientExtId}/users/{userExtId}/mtans

**Since:** 2.74.0 **Required permission(s):** `AccessControl.CredentialCreate` Creates an mTAN credential for the user with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/mtans" \
 -d '{
  "policyExtId" : "policyExtId",
  "mobileNumber" : "mobileNumber",
  "extId" : "extId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MTANRESTServiceApi;

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

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

        // Create an instance of the API class
        MTANRESTServiceApi apiInstance = new MTANRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        MTanCreateDTO mTanCreateDTO = {"extId":"mTanExtId","mobileNumber":"+41442726111","policyExtId":"6789"}; // MTanCreateDTO | 

        try {
            apiInstance.createMTan(clientExtId, userExtId, mTanCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling MTANRESTServiceApi#createMTan");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final MTanCreateDTO mTanCreateDTO = new MTanCreateDTO(); // MTanCreateDTO | 

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

import org.openapitools.client.api.MTANRESTServiceApi;

public class MTANRESTServiceApiExample {
    public static void main(String[] args) {
        MTANRESTServiceApi apiInstance = new MTANRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        MTanCreateDTO mTanCreateDTO = {"extId":"mTanExtId","mobileNumber":"+41442726111","policyExtId":"6789"}; // MTanCreateDTO | 

        try {
            apiInstance.createMTan(clientExtId, userExtId, mTanCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling MTANRESTServiceApi#createMTan");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MTANRESTServiceApi *apiInstance = [[MTANRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
MTanCreateDTO *mTanCreateDTO = {"extId":"mTanExtId","mobileNumber":"+41442726111","policyExtId":"6789"}; // 

// Create mTAN
[apiInstance createMTanWith:clientExtId
    userExtId:userExtId
    mTanCreateDTO:mTanCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.MTANRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var mTanCreateDTO = {"extId":"mTanExtId","mobileNumber":"+41442726111","policyExtId":"6789"}; // {MTanCreateDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new MTANRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var mTanCreateDTO = new MTanCreateDTO(); // MTanCreateDTO | 

            try {
                // Create mTAN
                apiInstance.createMTan(clientExtId, userExtId, mTanCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling MTANRESTServiceApi.createMTan: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MTANRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$mTanCreateDTO = {"extId":"mTanExtId","mobileNumber":"+41442726111","policyExtId":"6789"}; // MTanCreateDTO | 

try {
    $api_instance->createMTan($clientExtId, $userExtId, $mTanCreateDTO);
} catch (Exception $e) {
    echo 'Exception when calling MTANRESTServiceApi->createMTan: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MTANRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MTANRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $mTanCreateDTO = WWW::OPenAPIClient::Object::MTanCreateDTO->new(); # MTanCreateDTO | 

eval {
    $api_instance->createMTan(clientExtId => $clientExtId, userExtId => $userExtId, mTanCreateDTO => $mTanCreateDTO);
};
if ($@) {
    warn "Exception when calling MTANRESTServiceApi->createMTan: $@\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.MTANRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
mTanCreateDTO = {"extId":"mTanExtId","mobileNumber":"+41442726111","policyExtId":"6789"} # MTanCreateDTO | 

try:
    # Create mTAN
    api_instance.create_m_tan(clientExtId, userExtId, mTanCreateDTO)
except ApiException as e:
    print("Exception when calling MTANRESTServiceApi->createMTan: %s\n" % e)
extern crate MTANRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let mTanCreateDTO = {"extId":"mTanExtId","mobileNumber":"+41442726111","policyExtId":"6789"}; // MTanCreateDTO

    let mut context = MTANRESTServiceApi::Context::default();
    let result = client.createMTan(clientExtId, userExtId, mTanCreateDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
mTanCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

deleteMTanCredential

deleteMTanCredential
delete/core/v1/{clientExtId}/users/{userExtId}/mtans/{extId}

**Since:** 2.74.0 **Required permission(s):** `AccessControl.CredentialDelete` or `SelfAdmin` Role Deletes the mTan credential with the given external ID, belonging to the user with the given user external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/mtans/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MTANRESTServiceApi;

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

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

        // Create an instance of the API class
        MTANRESTServiceApi apiInstance = new MTANRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 1234; // String | ExtID of the mTAN credential

        try {
            apiInstance.deleteMTanCredential(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling MTANRESTServiceApi#deleteMTanCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the mTAN credential

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

import org.openapitools.client.api.MTANRESTServiceApi;

public class MTANRESTServiceApiExample {
    public static void main(String[] args) {
        MTANRESTServiceApi apiInstance = new MTANRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 1234; // String | ExtID of the mTAN credential

        try {
            apiInstance.deleteMTanCredential(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling MTANRESTServiceApi#deleteMTanCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MTANRESTServiceApi *apiInstance = [[MTANRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 1234; // ExtID of the mTAN credential (default to null)

// Delete mTan Credential
[apiInstance deleteMTanCredentialWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.MTANRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 1234; // {String} ExtID of the mTAN credential

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

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

            // Create an instance of the API class
            var apiInstance = new MTANRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 1234;  // String | ExtID of the mTAN credential (default to null)

            try {
                // Delete mTan Credential
                apiInstance.deleteMTanCredential(clientExtId, userExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling MTANRESTServiceApi.deleteMTanCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MTANRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 1234; // String | ExtID of the mTAN credential

try {
    $api_instance->deleteMTanCredential($clientExtId, $userExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling MTANRESTServiceApi->deleteMTanCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MTANRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MTANRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 1234; # String | ExtID of the mTAN credential

eval {
    $api_instance->deleteMTanCredential(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling MTANRESTServiceApi->deleteMTanCredential: $@\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.MTANRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 1234 # String | ExtID of the mTAN credential (default to null)

try:
    # Delete mTan Credential
    api_instance.delete_m_tan_credential(clientExtId, userExtId, extId)
except ApiException as e:
    print("Exception when calling MTANRESTServiceApi->deleteMTanCredential: %s\n" % e)
extern crate MTANRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 1234; // String

    let mut context = MTANRESTServiceApi::Context::default();
    let result = client.deleteMTanCredential(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the mTAN credential
Required

Responses


getAllMTan

getAllMTan
get/core/v1/{clientExtId}/users/{userExtId}/mtans

**Since:** 2.74.0 **Required permission(s):** `AccessControl.CredentialView` Returns all mTAN credentials of the user with the given user external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/mtans?continuationToken=continuationToken_example&limit=1000"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MTANRESTServiceApi;

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

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

        // Create an instance of the API class
        MTANRESTServiceApi apiInstance = new MTANRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForMTanGetDTO result = apiInstance.getAllMTan(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MTANRESTServiceApi#getAllMTan");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

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

import org.openapitools.client.api.MTANRESTServiceApi;

public class MTANRESTServiceApiExample {
    public static void main(String[] args) {
        MTANRESTServiceApi apiInstance = new MTANRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForMTanGetDTO result = apiInstance.getAllMTan(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MTANRESTServiceApi#getAllMTan");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MTANRESTServiceApi *apiInstance = [[MTANRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 1000; // Pagination limit (optional) (default to 0)

// Get all mTAN Credentials
[apiInstance getAllMTanWith:clientExtId
    userExtId:userExtId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForMTanGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.MTANRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 1000 // {Integer} Pagination limit
};

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

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

            // Create an instance of the API class
            var apiInstance = new MTANRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 1000;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get all mTAN Credentials
                ItemsWrapperForMTanGetDTO result = apiInstance.getAllMTan(clientExtId, userExtId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MTANRESTServiceApi.getAllMTan: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MTANRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 1000; // Integer | Pagination limit

try {
    $result = $api_instance->getAllMTan($clientExtId, $userExtId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MTANRESTServiceApi->getAllMTan: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MTANRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MTANRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 1000; # Integer | Pagination limit

eval {
    my $result = $api_instance->getAllMTan(clientExtId => $clientExtId, userExtId => $userExtId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MTANRESTServiceApi->getAllMTan: $@\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.MTANRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 1000 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get all mTAN Credentials
    api_response = api_instance.get_all_m_tan(clientExtId, userExtId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MTANRESTServiceApi->getAllMTan: %s\n" % e)
extern crate MTANRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let continuationToken = continuationToken_example; // String
    let limit = 1000; // Integer

    let mut context = MTANRESTServiceApi::Context::default();
    let result = client.getAllMTan(clientExtId, userExtId, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


getMTan

getMTan
get/core/v1/{clientExtId}/users/{userExtId}/mtans/{extId}

**Since:** 2.74.0 **Required permission(s):** `AccessControl.CredentialView` Returns the mTAN credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/mtans/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MTANRESTServiceApi;

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

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

        // Create an instance of the API class
        MTANRESTServiceApi apiInstance = new MTANRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 1234; // String | ExtID of the mTAN credential

        try {
            MTanGetDTO result = apiInstance.getMTan(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MTANRESTServiceApi#getMTan");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the mTAN credential

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

import org.openapitools.client.api.MTANRESTServiceApi;

public class MTANRESTServiceApiExample {
    public static void main(String[] args) {
        MTANRESTServiceApi apiInstance = new MTANRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 1234; // String | ExtID of the mTAN credential

        try {
            MTanGetDTO result = apiInstance.getMTan(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MTANRESTServiceApi#getMTan");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MTANRESTServiceApi *apiInstance = [[MTANRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 1234; // ExtID of the mTAN credential (default to null)

// Get mTAN Credential
[apiInstance getMTanWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(MTanGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.MTANRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 1234; // {String} ExtID of the mTAN credential

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

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

            // Create an instance of the API class
            var apiInstance = new MTANRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 1234;  // String | ExtID of the mTAN credential (default to null)

            try {
                // Get mTAN Credential
                MTanGetDTO result = apiInstance.getMTan(clientExtId, userExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MTANRESTServiceApi.getMTan: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MTANRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 1234; // String | ExtID of the mTAN credential

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MTANRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 1234; # String | ExtID of the mTAN credential

eval {
    my $result = $api_instance->getMTan(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MTANRESTServiceApi->getMTan: $@\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.MTANRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 1234 # String | ExtID of the mTAN credential (default to null)

try:
    # Get mTAN Credential
    api_response = api_instance.get_m_tan(clientExtId, userExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MTANRESTServiceApi->getMTan: %s\n" % e)
extern crate MTANRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 1234; // String

    let mut context = MTANRESTServiceApi::Context::default();
    let result = client.getMTan(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the mTAN credential
Required

Responses


updateLoginInfo

updateLoginInfo
post/core/v1/{clientExtId}/users/{userExtId}/mtans/{extId}

**Since:** 2.86.0 **Required permission(s):** `AccessControl.CredentialModify,AccessControl.CredentialView` Updates the login information of the mTAN credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/mtans/{extId}" \
 -d '{
  "success" : true
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MTANRESTServiceApi;

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

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

        // Create an instance of the API class
        MTANRESTServiceApi apiInstance = new MTANRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 1234; // String | ExtID of the mTAN credential
        MTanUpdateLoginInfoDTO mTanUpdateLoginInfoDTO = {"success":true}; // MTanUpdateLoginInfoDTO | 

        try {
            MTanGetDTO result = apiInstance.updateLoginInfo(clientExtId, userExtId, extId, mTanUpdateLoginInfoDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MTANRESTServiceApi#updateLoginInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the mTAN credential
final MTanUpdateLoginInfoDTO mTanUpdateLoginInfoDTO = new MTanUpdateLoginInfoDTO(); // MTanUpdateLoginInfoDTO | 

try {
    final result = await api_instance.updateLoginInfo(clientExtId, userExtId, extId, mTanUpdateLoginInfoDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateLoginInfo: $e\n');
}

import org.openapitools.client.api.MTANRESTServiceApi;

public class MTANRESTServiceApiExample {
    public static void main(String[] args) {
        MTANRESTServiceApi apiInstance = new MTANRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 1234; // String | ExtID of the mTAN credential
        MTanUpdateLoginInfoDTO mTanUpdateLoginInfoDTO = {"success":true}; // MTanUpdateLoginInfoDTO | 

        try {
            MTanGetDTO result = apiInstance.updateLoginInfo(clientExtId, userExtId, extId, mTanUpdateLoginInfoDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MTANRESTServiceApi#updateLoginInfo");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MTANRESTServiceApi *apiInstance = [[MTANRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 1234; // ExtID of the mTAN credential (default to null)
MTanUpdateLoginInfoDTO *mTanUpdateLoginInfoDTO = {"success":true}; // 

// Update mTAN login information
[apiInstance updateLoginInfoWith:clientExtId
    userExtId:userExtId
    extId:extId
    mTanUpdateLoginInfoDTO:mTanUpdateLoginInfoDTO
              completionHandler: ^(MTanGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.MTANRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 1234; // {String} ExtID of the mTAN credential
var mTanUpdateLoginInfoDTO = {"success":true}; // {MTanUpdateLoginInfoDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new MTANRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 1234;  // String | ExtID of the mTAN credential (default to null)
            var mTanUpdateLoginInfoDTO = new MTanUpdateLoginInfoDTO(); // MTanUpdateLoginInfoDTO | 

            try {
                // Update mTAN login information
                MTanGetDTO result = apiInstance.updateLoginInfo(clientExtId, userExtId, extId, mTanUpdateLoginInfoDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MTANRESTServiceApi.updateLoginInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MTANRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 1234; // String | ExtID of the mTAN credential
$mTanUpdateLoginInfoDTO = {"success":true}; // MTanUpdateLoginInfoDTO | 

try {
    $result = $api_instance->updateLoginInfo($clientExtId, $userExtId, $extId, $mTanUpdateLoginInfoDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MTANRESTServiceApi->updateLoginInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MTANRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MTANRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 1234; # String | ExtID of the mTAN credential
my $mTanUpdateLoginInfoDTO = WWW::OPenAPIClient::Object::MTanUpdateLoginInfoDTO->new(); # MTanUpdateLoginInfoDTO | 

eval {
    my $result = $api_instance->updateLoginInfo(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId, mTanUpdateLoginInfoDTO => $mTanUpdateLoginInfoDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MTANRESTServiceApi->updateLoginInfo: $@\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.MTANRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 1234 # String | ExtID of the mTAN credential (default to null)
mTanUpdateLoginInfoDTO = {"success":true} # MTanUpdateLoginInfoDTO | 

try:
    # Update mTAN login information
    api_response = api_instance.update_login_info(clientExtId, userExtId, extId, mTanUpdateLoginInfoDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MTANRESTServiceApi->updateLoginInfo: %s\n" % e)
extern crate MTANRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 1234; // String
    let mTanUpdateLoginInfoDTO = {"success":true}; // MTanUpdateLoginInfoDTO

    let mut context = MTANRESTServiceApi::Context::default();
    let result = client.updateLoginInfo(clientExtId, userExtId, extId, mTanUpdateLoginInfoDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the mTAN credential
Required
Body parameters
Name Description
mTanUpdateLoginInfoDTO *

Responses


updateMTanCredential

updateMTanCredential
patch/core/v1/{clientExtId}/users/{userExtId}/mtans/{extId}

**Since:** 2.74.0 **Required permission(s):** `AccessControl.CredentialModify,AccessControl.CredentialView` Updates the mTAN credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/mtans/{extId}" \
 -d '{
  "stateName" : "INITIAL",
  "modificationComment" : "modificationComment",
  "mobileNumber" : "mobileNumber",
  "version" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MTANRESTServiceApi;

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

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

        // Create an instance of the API class
        MTANRESTServiceApi apiInstance = new MTANRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 1234; // String | ExtID of the mTAN credential
        MTanPatchDTO mTanPatchDTO = {"stateName":"active","modificationComment":"Update mTAN comment","version":4}; // MTanPatchDTO | 

        try {
            MTanGetDTO result = apiInstance.updateMTanCredential(clientExtId, userExtId, extId, mTanPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MTANRESTServiceApi#updateMTanCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the mTAN credential
final MTanPatchDTO mTanPatchDTO = new MTanPatchDTO(); // MTanPatchDTO | 

try {
    final result = await api_instance.updateMTanCredential(clientExtId, userExtId, extId, mTanPatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateMTanCredential: $e\n');
}

import org.openapitools.client.api.MTANRESTServiceApi;

public class MTANRESTServiceApiExample {
    public static void main(String[] args) {
        MTANRESTServiceApi apiInstance = new MTANRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 1234; // String | ExtID of the mTAN credential
        MTanPatchDTO mTanPatchDTO = {"stateName":"active","modificationComment":"Update mTAN comment","version":4}; // MTanPatchDTO | 

        try {
            MTanGetDTO result = apiInstance.updateMTanCredential(clientExtId, userExtId, extId, mTanPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MTANRESTServiceApi#updateMTanCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MTANRESTServiceApi *apiInstance = [[MTANRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 1234; // ExtID of the mTAN credential (default to null)
MTanPatchDTO *mTanPatchDTO = {"stateName":"active","modificationComment":"Update mTAN comment","version":4}; // 

// Update mTAN Credential
[apiInstance updateMTanCredentialWith:clientExtId
    userExtId:userExtId
    extId:extId
    mTanPatchDTO:mTanPatchDTO
              completionHandler: ^(MTanGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.MTANRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 1234; // {String} ExtID of the mTAN credential
var mTanPatchDTO = {"stateName":"active","modificationComment":"Update mTAN comment","version":4}; // {MTanPatchDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new MTANRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 1234;  // String | ExtID of the mTAN credential (default to null)
            var mTanPatchDTO = new MTanPatchDTO(); // MTanPatchDTO | 

            try {
                // Update mTAN Credential
                MTanGetDTO result = apiInstance.updateMTanCredential(clientExtId, userExtId, extId, mTanPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MTANRESTServiceApi.updateMTanCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MTANRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 1234; // String | ExtID of the mTAN credential
$mTanPatchDTO = {"stateName":"active","modificationComment":"Update mTAN comment","version":4}; // MTanPatchDTO | 

try {
    $result = $api_instance->updateMTanCredential($clientExtId, $userExtId, $extId, $mTanPatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MTANRESTServiceApi->updateMTanCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MTANRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MTANRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 1234; # String | ExtID of the mTAN credential
my $mTanPatchDTO = WWW::OPenAPIClient::Object::MTanPatchDTO->new(); # MTanPatchDTO | 

eval {
    my $result = $api_instance->updateMTanCredential(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId, mTanPatchDTO => $mTanPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MTANRESTServiceApi->updateMTanCredential: $@\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.MTANRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 1234 # String | ExtID of the mTAN credential (default to null)
mTanPatchDTO = {"stateName":"active","modificationComment":"Update mTAN comment","version":4} # MTanPatchDTO | 

try:
    # Update mTAN Credential
    api_response = api_instance.update_m_tan_credential(clientExtId, userExtId, extId, mTanPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MTANRESTServiceApi->updateMTanCredential: %s\n" % e)
extern crate MTANRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 1234; // String
    let mTanPatchDTO = {"stateName":"active","modificationComment":"Update mTAN comment","version":4}; // MTanPatchDTO

    let mut context = MTANRESTServiceApi::Context::default();
    let result = client.updateMTanCredential(clientExtId, userExtId, extId, mTanPatchDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the mTAN credential
Required
Body parameters
Name Description
mTanPatchDTO *

Responses


MobileAuthenticationRESTService

countMobileAuthCredentials

countMobileAuthCredentials
get/core/v1/{clientExtId}/users/{userExtId}/mauths/count

**Since:** 2.81.0 **Required permission(s):** `AccessControl.CredentialView` Returns the count of credentials of the user with the given external ID, which have the `fidouaf_signature_key` property set for the credential.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/mauths/count?allParams=Object"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MobileAuthenticationRESTServiceApi;

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

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

        // Create an instance of the API class
        MobileAuthenticationRESTServiceApi apiInstance = new MobileAuthenticationRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        map[String, String] allParams = Object; // map[String, String] | 

        try {
            CountDto result = apiInstance.countMobileAuthCredentials(clientExtId, userExtId, allParams);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileAuthenticationRESTServiceApi#countMobileAuthCredentials");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final map[String, String] allParams = new map[String, String](); // map[String, String] | 

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

import org.openapitools.client.api.MobileAuthenticationRESTServiceApi;

public class MobileAuthenticationRESTServiceApiExample {
    public static void main(String[] args) {
        MobileAuthenticationRESTServiceApi apiInstance = new MobileAuthenticationRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        map[String, String] allParams = Object; // map[String, String] | 

        try {
            CountDto result = apiInstance.countMobileAuthCredentials(clientExtId, userExtId, allParams);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileAuthenticationRESTServiceApi#countMobileAuthCredentials");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MobileAuthenticationRESTServiceApi *apiInstance = [[MobileAuthenticationRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
map[String, String] *allParams = Object; //  (default to null)

// Count mobile authentications
[apiInstance countMobileAuthCredentialsWith:clientExtId
    userExtId:userExtId
    allParams:allParams
              completionHandler: ^(CountDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.MobileAuthenticationRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var allParams = Object; // {map[String, String]} 

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

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

            // Create an instance of the API class
            var apiInstance = new MobileAuthenticationRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var allParams = new map[String, String](); // map[String, String] |  (default to null)

            try {
                // Count mobile authentications
                CountDto result = apiInstance.countMobileAuthCredentials(clientExtId, userExtId, allParams);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MobileAuthenticationRESTServiceApi.countMobileAuthCredentials: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MobileAuthenticationRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$allParams = Object; // map[String, String] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MobileAuthenticationRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $allParams = Object; # map[String, String] | 

eval {
    my $result = $api_instance->countMobileAuthCredentials(clientExtId => $clientExtId, userExtId => $userExtId, allParams => $allParams);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MobileAuthenticationRESTServiceApi->countMobileAuthCredentials: $@\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.MobileAuthenticationRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
allParams = Object # map[String, String] |  (default to null)

try:
    # Count mobile authentications
    api_response = api_instance.count_mobile_auth_credentials(clientExtId, userExtId, allParams)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MobileAuthenticationRESTServiceApi->countMobileAuthCredentials: %s\n" % e)
extern crate MobileAuthenticationRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let allParams = Object; // map[String, String]

    let mut context = MobileAuthenticationRESTServiceApi::Context::default();
    let result = client.countMobileAuthCredentials(clientExtId, userExtId, allParams, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Query parameters
Name Description
allParams*
map[String, String]
Required

Responses


deleteMobileAuthCredential

deleteMobileAuthCredential
delete/core/v1/{clientExtId}/users/{userExtId}/mauths/{extId}

**Since:** 2.77.0 **Required permission(s):** `AccessControl.CredentialDelete` or `SelfAdmin` Role Deletes a mobile authentication credential of the user.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/mauths/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MobileAuthenticationRESTServiceApi;

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

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

        // Create an instance of the API class
        MobileAuthenticationRESTServiceApi apiInstance = new MobileAuthenticationRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 015; // String | ExtID of the mobile auth credential

        try {
            apiInstance.deleteMobileAuthCredential(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileAuthenticationRESTServiceApi#deleteMobileAuthCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the mobile auth credential

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

import org.openapitools.client.api.MobileAuthenticationRESTServiceApi;

public class MobileAuthenticationRESTServiceApiExample {
    public static void main(String[] args) {
        MobileAuthenticationRESTServiceApi apiInstance = new MobileAuthenticationRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 015; // String | ExtID of the mobile auth credential

        try {
            apiInstance.deleteMobileAuthCredential(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileAuthenticationRESTServiceApi#deleteMobileAuthCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MobileAuthenticationRESTServiceApi *apiInstance = [[MobileAuthenticationRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 015; // ExtID of the mobile auth credential (default to null)

// Delete mobile authentication
[apiInstance deleteMobileAuthCredentialWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.MobileAuthenticationRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 015; // {String} ExtID of the mobile auth credential

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

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

            // Create an instance of the API class
            var apiInstance = new MobileAuthenticationRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 015;  // String | ExtID of the mobile auth credential (default to null)

            try {
                // Delete mobile authentication
                apiInstance.deleteMobileAuthCredential(clientExtId, userExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling MobileAuthenticationRESTServiceApi.deleteMobileAuthCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MobileAuthenticationRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 015; // String | ExtID of the mobile auth credential

try {
    $api_instance->deleteMobileAuthCredential($clientExtId, $userExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling MobileAuthenticationRESTServiceApi->deleteMobileAuthCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MobileAuthenticationRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MobileAuthenticationRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 015; # String | ExtID of the mobile auth credential

eval {
    $api_instance->deleteMobileAuthCredential(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling MobileAuthenticationRESTServiceApi->deleteMobileAuthCredential: $@\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.MobileAuthenticationRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 015 # String | ExtID of the mobile auth credential (default to null)

try:
    # Delete mobile authentication
    api_instance.delete_mobile_auth_credential(clientExtId, userExtId, extId)
except ApiException as e:
    print("Exception when calling MobileAuthenticationRESTServiceApi->deleteMobileAuthCredential: %s\n" % e)
extern crate MobileAuthenticationRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 015; // String

    let mut context = MobileAuthenticationRESTServiceApi::Context::default();
    let result = client.deleteMobileAuthCredential(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the mobile auth credential
Required

Responses


getMobileAuthCredentials

getMobileAuthCredentials
get/core/v1/{clientExtId}/users/{userExtId}/mauths

**Since:** 2.77.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns credentials of the user with the given external ID, which have the `fidouaf_signature_key` property set for the credential. Fido UAF credentials not included.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/mauths?allParams=Object"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MobileAuthenticationRESTServiceApi;

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

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

        // Create an instance of the API class
        MobileAuthenticationRESTServiceApi apiInstance = new MobileAuthenticationRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        map[String, String] allParams = Object; // map[String, String] | 

        try {
            ItemsWrapperForMobileAuthCredentialGetDTO result = apiInstance.getMobileAuthCredentials(clientExtId, userExtId, allParams);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileAuthenticationRESTServiceApi#getMobileAuthCredentials");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final map[String, String] allParams = new map[String, String](); // map[String, String] | 

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

import org.openapitools.client.api.MobileAuthenticationRESTServiceApi;

public class MobileAuthenticationRESTServiceApiExample {
    public static void main(String[] args) {
        MobileAuthenticationRESTServiceApi apiInstance = new MobileAuthenticationRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        map[String, String] allParams = Object; // map[String, String] | 

        try {
            ItemsWrapperForMobileAuthCredentialGetDTO result = apiInstance.getMobileAuthCredentials(clientExtId, userExtId, allParams);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileAuthenticationRESTServiceApi#getMobileAuthCredentials");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MobileAuthenticationRESTServiceApi *apiInstance = [[MobileAuthenticationRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
map[String, String] *allParams = Object; //  (default to null)

// Get mobile authentications
[apiInstance getMobileAuthCredentialsWith:clientExtId
    userExtId:userExtId
    allParams:allParams
              completionHandler: ^(ItemsWrapperForMobileAuthCredentialGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.MobileAuthenticationRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var allParams = Object; // {map[String, String]} 

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

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

            // Create an instance of the API class
            var apiInstance = new MobileAuthenticationRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var allParams = new map[String, String](); // map[String, String] |  (default to null)

            try {
                // Get mobile authentications
                ItemsWrapperForMobileAuthCredentialGetDTO result = apiInstance.getMobileAuthCredentials(clientExtId, userExtId, allParams);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MobileAuthenticationRESTServiceApi.getMobileAuthCredentials: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MobileAuthenticationRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$allParams = Object; // map[String, String] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MobileAuthenticationRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $allParams = Object; # map[String, String] | 

eval {
    my $result = $api_instance->getMobileAuthCredentials(clientExtId => $clientExtId, userExtId => $userExtId, allParams => $allParams);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MobileAuthenticationRESTServiceApi->getMobileAuthCredentials: $@\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.MobileAuthenticationRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
allParams = Object # map[String, String] |  (default to null)

try:
    # Get mobile authentications
    api_response = api_instance.get_mobile_auth_credentials(clientExtId, userExtId, allParams)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MobileAuthenticationRESTServiceApi->getMobileAuthCredentials: %s\n" % e)
extern crate MobileAuthenticationRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let allParams = Object; // map[String, String]

    let mut context = MobileAuthenticationRESTServiceApi::Context::default();
    let result = client.getMobileAuthCredentials(clientExtId, userExtId, allParams, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Query parameters
Name Description
allParams*
map[String, String]
Required

Responses


NotificationRESTService

getNotificationTypes

getNotificationTypes
get/notification/v1/system/notification-types

**Since:** 2.79.0 Returns the available notification types.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/notification/v1/system/notification-types"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationRESTServiceApi;

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

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

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

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

final api_instance = DefaultApi();


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

import org.openapitools.client.api.NotificationRESTServiceApi;

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

        try {
            ItemsWrapperDTO result = apiInstance.getNotificationTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationRESTServiceApi#getNotificationTypes");
            e.printStackTrace();
        }
    }
}


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

// Get notification types
[apiInstance getNotificationTypesWithCompletionHandler: 
              ^(ItemsWrapperDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

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

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

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

            try {
                // Get notification types
                ItemsWrapperDTO result = apiInstance.getNotificationTypes();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationRESTServiceApi.getNotificationTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try:
    # Get notification types
    api_response = api_instance.get_notification_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationRESTServiceApi->getNotificationTypes: %s\n" % e)
extern crate NotificationRESTServiceApi;

pub fn main() {

    let mut context = NotificationRESTServiceApi::Context::default();
    let result = client.getNotificationTypes(&context).wait();

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

Scopes

Parameters

Responses


sendNotificationToUser

sendNotificationToUser
post/notification/v1

**Since:** 2.79.0 **Required permission(s):** `AccessControl.UserView` Send notification to a user with the defined notificationType and sendingMethod.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/notification/v1" \
 -d '{
  "userExtId" : 88881051,
  "async" : false,
  "clientExtId" : 1000,
  "placeholders" : {
    "en" : {
      "EXTERNAL_CITY" : "Vienna"
    },
    "de" : {
      "EXTERNAL_CITY" : "Wien"
    },
    "languageIndependent" : {
      "EXTERNAL_IP_ADDRESS" : "173.170.190.74"
    }
  },
  "notificationType" : "userNotification2",
  "sendingMethod" : [ "Email" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationRESTServiceApi;

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

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

        // Create an instance of the API class
        NotificationRESTServiceApi apiInstance = new NotificationRESTServiceApi();
        NotificationDTO notificationDTO = {"clientExtId":"100","userExtId":"88881051","notificationType":"userNotification2","sendingMethod":["Email"],"async":false,"placeholders":{"en":{"EXTERNAL_CITY":"Vienna"},"de":{"EXTERNAL_CITY":"Wien"},"languageIndependent":{"EXTERNAL_IP_ADDRESS":"173.170.190.74"}}}; // NotificationDTO | 

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

final api_instance = DefaultApi();

final NotificationDTO notificationDTO = new NotificationDTO(); // NotificationDTO | 

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

import org.openapitools.client.api.NotificationRESTServiceApi;

public class NotificationRESTServiceApiExample {
    public static void main(String[] args) {
        NotificationRESTServiceApi apiInstance = new NotificationRESTServiceApi();
        NotificationDTO notificationDTO = {"clientExtId":"100","userExtId":"88881051","notificationType":"userNotification2","sendingMethod":["Email"],"async":false,"placeholders":{"en":{"EXTERNAL_CITY":"Vienna"},"de":{"EXTERNAL_CITY":"Wien"},"languageIndependent":{"EXTERNAL_IP_ADDRESS":"173.170.190.74"}}}; // NotificationDTO | 

        try {
            apiInstance.sendNotificationToUser(notificationDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationRESTServiceApi#sendNotificationToUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NotificationRESTServiceApi *apiInstance = [[NotificationRESTServiceApi alloc] init];
NotificationDTO *notificationDTO = {"clientExtId":"100","userExtId":"88881051","notificationType":"userNotification2","sendingMethod":["Email"],"async":false,"placeholders":{"en":{"EXTERNAL_CITY":"Vienna"},"de":{"EXTERNAL_CITY":"Wien"},"languageIndependent":{"EXTERNAL_IP_ADDRESS":"173.170.190.74"}}}; // 

// Send notification to user
[apiInstance sendNotificationToUserWith:notificationDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.NotificationRESTServiceApi()
var notificationDTO = {"clientExtId":"100","userExtId":"88881051","notificationType":"userNotification2","sendingMethod":["Email"],"async":false,"placeholders":{"en":{"EXTERNAL_CITY":"Vienna"},"de":{"EXTERNAL_CITY":"Wien"},"languageIndependent":{"EXTERNAL_IP_ADDRESS":"173.170.190.74"}}}; // {NotificationDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new NotificationRESTServiceApi();
            var notificationDTO = new NotificationDTO(); // NotificationDTO | 

            try {
                // Send notification to user
                apiInstance.sendNotificationToUser(notificationDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationRESTServiceApi.sendNotificationToUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationRESTServiceApi();
$notificationDTO = {"clientExtId":"100","userExtId":"88881051","notificationType":"userNotification2","sendingMethod":["Email"],"async":false,"placeholders":{"en":{"EXTERNAL_CITY":"Vienna"},"de":{"EXTERNAL_CITY":"Wien"},"languageIndependent":{"EXTERNAL_IP_ADDRESS":"173.170.190.74"}}}; // NotificationDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationRESTServiceApi->new();
my $notificationDTO = WWW::OPenAPIClient::Object::NotificationDTO->new(); # NotificationDTO | 

eval {
    $api_instance->sendNotificationToUser(notificationDTO => $notificationDTO);
};
if ($@) {
    warn "Exception when calling NotificationRESTServiceApi->sendNotificationToUser: $@\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.NotificationRESTServiceApi()
notificationDTO = {"clientExtId":"100","userExtId":"88881051","notificationType":"userNotification2","sendingMethod":["Email"],"async":false,"placeholders":{"en":{"EXTERNAL_CITY":"Vienna"},"de":{"EXTERNAL_CITY":"Wien"},"languageIndependent":{"EXTERNAL_IP_ADDRESS":"173.170.190.74"}}} # NotificationDTO | 

try:
    # Send notification to user
    api_instance.send_notification_to_user(notificationDTO)
except ApiException as e:
    print("Exception when calling NotificationRESTServiceApi->sendNotificationToUser: %s\n" % e)
extern crate NotificationRESTServiceApi;

pub fn main() {
    let notificationDTO = {"clientExtId":"100","userExtId":"88881051","notificationType":"userNotification2","sendingMethod":["Email"],"async":false,"placeholders":{"en":{"EXTERNAL_CITY":"Vienna"},"de":{"EXTERNAL_CITY":"Wien"},"languageIndependent":{"EXTERNAL_IP_ADDRESS":"173.170.190.74"}}}; // NotificationDTO

    let mut context = NotificationRESTServiceApi::Context::default();
    let result = client.sendNotificationToUser(notificationDTO, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
notificationDTO *

Responses


OATHRESTService

createOath

createOath
post/core/v1/{clientExtId}/users/{userExtId}/oath-credentials

**Since:** 2.71.0 **Required permission(s):** `AccessControl.CredentialCreate,AccessControl.CredentialView,AccessControl.PolicyConfigurationView` or `SelfAdmin` Role Creates a new OATH credential for the user with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/oath-credentials" \
 -d '{
  "policyExtId" : "policyExtId",
  "stateName" : "INITIAL",
  "label" : "label",
  "extId" : "extId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OATHRESTServiceApi;

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

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

        // Create an instance of the API class
        OATHRESTServiceApi apiInstance = new OATHRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        OathCreateDTO oathCreateDTO = {"extId":"4500","policyExtId":"6789","label":"label","stateName":"initial"}; // OathCreateDTO | 

        try {
            OathGetDTO result = apiInstance.createOath(clientExtId, userExtId, oathCreateDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OATHRESTServiceApi#createOath");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final OathCreateDTO oathCreateDTO = new OathCreateDTO(); // OathCreateDTO | 

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

import org.openapitools.client.api.OATHRESTServiceApi;

public class OATHRESTServiceApiExample {
    public static void main(String[] args) {
        OATHRESTServiceApi apiInstance = new OATHRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        OathCreateDTO oathCreateDTO = {"extId":"4500","policyExtId":"6789","label":"label","stateName":"initial"}; // OathCreateDTO | 

        try {
            OathGetDTO result = apiInstance.createOath(clientExtId, userExtId, oathCreateDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OATHRESTServiceApi#createOath");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
OATHRESTServiceApi *apiInstance = [[OATHRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
OathCreateDTO *oathCreateDTO = {"extId":"4500","policyExtId":"6789","label":"label","stateName":"initial"}; // 

// Create an OATH credential
[apiInstance createOathWith:clientExtId
    userExtId:userExtId
    oathCreateDTO:oathCreateDTO
              completionHandler: ^(OathGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.OATHRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var oathCreateDTO = {"extId":"4500","policyExtId":"6789","label":"label","stateName":"initial"}; // {OathCreateDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new OATHRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var oathCreateDTO = new OathCreateDTO(); // OathCreateDTO | 

            try {
                // Create an OATH credential
                OathGetDTO result = apiInstance.createOath(clientExtId, userExtId, oathCreateDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OATHRESTServiceApi.createOath: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OATHRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$oathCreateDTO = {"extId":"4500","policyExtId":"6789","label":"label","stateName":"initial"}; // OathCreateDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OATHRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $oathCreateDTO = WWW::OPenAPIClient::Object::OathCreateDTO->new(); # OathCreateDTO | 

eval {
    my $result = $api_instance->createOath(clientExtId => $clientExtId, userExtId => $userExtId, oathCreateDTO => $oathCreateDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OATHRESTServiceApi->createOath: $@\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.OATHRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
oathCreateDTO = {"extId":"4500","policyExtId":"6789","label":"label","stateName":"initial"} # OathCreateDTO | 

try:
    # Create an OATH credential
    api_response = api_instance.create_oath(clientExtId, userExtId, oathCreateDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OATHRESTServiceApi->createOath: %s\n" % e)
extern crate OATHRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let oathCreateDTO = {"extId":"4500","policyExtId":"6789","label":"label","stateName":"initial"}; // OathCreateDTO

    let mut context = OATHRESTServiceApi::Context::default();
    let result = client.createOath(clientExtId, userExtId, oathCreateDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
oathCreateDTO *

Responses


deleteOath

deleteOath
delete/core/v1/{clientExtId}/users/{userExtId}/oath-credentials/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.CredentialDelete` or `SelfAdmin` Role Deletes the OATH credential with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/oath-credentials/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OATHRESTServiceApi;

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

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

        // Create an instance of the API class
        OATHRESTServiceApi apiInstance = new OATHRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 4321; // String | ExtID of the OATH credential

        try {
            apiInstance.deleteOath(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OATHRESTServiceApi#deleteOath");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the OATH credential

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

import org.openapitools.client.api.OATHRESTServiceApi;

public class OATHRESTServiceApiExample {
    public static void main(String[] args) {
        OATHRESTServiceApi apiInstance = new OATHRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 4321; // String | ExtID of the OATH credential

        try {
            apiInstance.deleteOath(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OATHRESTServiceApi#deleteOath");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
OATHRESTServiceApi *apiInstance = [[OATHRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 4321; // ExtID of the OATH credential (default to null)

// Delete OATH credential
[apiInstance deleteOathWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.OATHRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 4321; // {String} ExtID of the OATH credential

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

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

            // Create an instance of the API class
            var apiInstance = new OATHRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 4321;  // String | ExtID of the OATH credential (default to null)

            try {
                // Delete OATH credential
                apiInstance.deleteOath(clientExtId, userExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling OATHRESTServiceApi.deleteOath: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OATHRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 4321; // String | ExtID of the OATH credential

try {
    $api_instance->deleteOath($clientExtId, $userExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling OATHRESTServiceApi->deleteOath: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OATHRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OATHRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 4321; # String | ExtID of the OATH credential

eval {
    $api_instance->deleteOath(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling OATHRESTServiceApi->deleteOath: $@\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.OATHRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 4321 # String | ExtID of the OATH credential (default to null)

try:
    # Delete OATH credential
    api_instance.delete_oath(clientExtId, userExtId, extId)
except ApiException as e:
    print("Exception when calling OATHRESTServiceApi->deleteOath: %s\n" % e)
extern crate OATHRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 4321; // String

    let mut context = OATHRESTServiceApi::Context::default();
    let result = client.deleteOath(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the OATH credential
Required

Responses


getOath

getOath
get/core/v1/{clientExtId}/users/{userExtId}/oath-credentials/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns the OATH credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/oath-credentials/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OATHRESTServiceApi;

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

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

        // Create an instance of the API class
        OATHRESTServiceApi apiInstance = new OATHRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 4321; // String | ExtID of the OATH credential

        try {
            OathGetDTO result = apiInstance.getOath(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OATHRESTServiceApi#getOath");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the OATH credential

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

import org.openapitools.client.api.OATHRESTServiceApi;

public class OATHRESTServiceApiExample {
    public static void main(String[] args) {
        OATHRESTServiceApi apiInstance = new OATHRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 4321; // String | ExtID of the OATH credential

        try {
            OathGetDTO result = apiInstance.getOath(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OATHRESTServiceApi#getOath");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
OATHRESTServiceApi *apiInstance = [[OATHRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 4321; // ExtID of the OATH credential (default to null)

// Get the OATH credential
[apiInstance getOathWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(OathGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.OATHRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 4321; // {String} ExtID of the OATH credential

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

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

            // Create an instance of the API class
            var apiInstance = new OATHRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 4321;  // String | ExtID of the OATH credential (default to null)

            try {
                // Get the OATH credential
                OathGetDTO result = apiInstance.getOath(clientExtId, userExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OATHRESTServiceApi.getOath: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OATHRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 4321; // String | ExtID of the OATH credential

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OATHRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 4321; # String | ExtID of the OATH credential

eval {
    my $result = $api_instance->getOath(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OATHRESTServiceApi->getOath: $@\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.OATHRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 4321 # String | ExtID of the OATH credential (default to null)

try:
    # Get the OATH credential
    api_response = api_instance.get_oath(clientExtId, userExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OATHRESTServiceApi->getOath: %s\n" % e)
extern crate OATHRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 4321; // String

    let mut context = OATHRESTServiceApi::Context::default();
    let result = client.getOath(clientExtId, userExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the OATH credential
Required

Responses


getOathCredentials

getOathCredentials
get/core/v1/{clientExtId}/users/{userExtId}/oath-credentials

**Since:** 2.71.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns all OATH credentials of the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/oath-credentials?continuationToken=continuationToken_example&limit=100"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OATHRESTServiceApi;

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

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

        // Create an instance of the API class
        OATHRESTServiceApi apiInstance = new OATHRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperForOathGetDTO result = apiInstance.getOathCredentials(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OATHRESTServiceApi#getOathCredentials");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

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

import org.openapitools.client.api.OATHRESTServiceApi;

public class OATHRESTServiceApiExample {
    public static void main(String[] args) {
        OATHRESTServiceApi apiInstance = new OATHRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperForOathGetDTO result = apiInstance.getOathCredentials(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OATHRESTServiceApi#getOathCredentials");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
OATHRESTServiceApi *apiInstance = [[OATHRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 100; // Pagination limit (optional) (default to 0)

// Get all OATH credentials of a user
[apiInstance getOathCredentialsWith:clientExtId
    userExtId:userExtId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForOathGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.OATHRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 100 // {Integer} Pagination limit
};

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

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

            // Create an instance of the API class
            var apiInstance = new OATHRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 100;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get all OATH credentials of a user
                ItemsWrapperForOathGetDTO result = apiInstance.getOathCredentials(clientExtId, userExtId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OATHRESTServiceApi.getOathCredentials: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OATHRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 100; // Integer | Pagination limit

try {
    $result = $api_instance->getOathCredentials($clientExtId, $userExtId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OATHRESTServiceApi->getOathCredentials: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OATHRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OATHRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 100; # Integer | Pagination limit

eval {
    my $result = $api_instance->getOathCredentials(clientExtId => $clientExtId, userExtId => $userExtId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OATHRESTServiceApi->getOathCredentials: $@\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.OATHRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 100 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get all OATH credentials of a user
    api_response = api_instance.get_oath_credentials(clientExtId, userExtId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OATHRESTServiceApi->getOathCredentials: %s\n" % e)
extern crate OATHRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let continuationToken = continuationToken_example; // String
    let limit = 100; // Integer

    let mut context = OATHRESTServiceApi::Context::default();
    let result = client.getOathCredentials(clientExtId, userExtId, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


updateOathCredential

updateOathCredential
patch/core/v1/{clientExtId}/users/{userExtId}/oath-credentials/{extId}

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialModify,AccessControl.CredentialView` or `SelfAdmin` Role Updates the OATH credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/oath-credentials/{extId}" \
 -d '{
  "policyExtId" : "policy-456",
  "stateName" : "active",
  "modificationComment" : "Label updated by admin.",
  "extId" : "oath-123",
  "label" : "My OATH Token"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OATHRESTServiceApi;

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

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

        // Create an instance of the API class
        OATHRESTServiceApi apiInstance = new OATHRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 4321; // String | ExtID of the OATH credential
        OathPatchDTO oathPatchDTO = {"stateName":"active","modificationComment":"Update OATH comment","label":"labelUpdate","policyExtId":"270000001"}; // OathPatchDTO | 

        try {
            OathGetDTO result = apiInstance.updateOathCredential(clientExtId, userExtId, extId, oathPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OATHRESTServiceApi#updateOathCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the OATH credential
final OathPatchDTO oathPatchDTO = new OathPatchDTO(); // OathPatchDTO | 

try {
    final result = await api_instance.updateOathCredential(clientExtId, userExtId, extId, oathPatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateOathCredential: $e\n');
}

import org.openapitools.client.api.OATHRESTServiceApi;

public class OATHRESTServiceApiExample {
    public static void main(String[] args) {
        OATHRESTServiceApi apiInstance = new OATHRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 4321; // String | ExtID of the OATH credential
        OathPatchDTO oathPatchDTO = {"stateName":"active","modificationComment":"Update OATH comment","label":"labelUpdate","policyExtId":"270000001"}; // OathPatchDTO | 

        try {
            OathGetDTO result = apiInstance.updateOathCredential(clientExtId, userExtId, extId, oathPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OATHRESTServiceApi#updateOathCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
OATHRESTServiceApi *apiInstance = [[OATHRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 4321; // ExtID of the OATH credential (default to null)
OathPatchDTO *oathPatchDTO = {"stateName":"active","modificationComment":"Update OATH comment","label":"labelUpdate","policyExtId":"270000001"}; // 

// Update OATH Credential
[apiInstance updateOathCredentialWith:clientExtId
    userExtId:userExtId
    extId:extId
    oathPatchDTO:oathPatchDTO
              completionHandler: ^(OathGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.OATHRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 4321; // {String} ExtID of the OATH credential
var oathPatchDTO = {"stateName":"active","modificationComment":"Update OATH comment","label":"labelUpdate","policyExtId":"270000001"}; // {OathPatchDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new OATHRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 4321;  // String | ExtID of the OATH credential (default to null)
            var oathPatchDTO = new OathPatchDTO(); // OathPatchDTO | 

            try {
                // Update OATH Credential
                OathGetDTO result = apiInstance.updateOathCredential(clientExtId, userExtId, extId, oathPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OATHRESTServiceApi.updateOathCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OATHRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 4321; // String | ExtID of the OATH credential
$oathPatchDTO = {"stateName":"active","modificationComment":"Update OATH comment","label":"labelUpdate","policyExtId":"270000001"}; // OathPatchDTO | 

try {
    $result = $api_instance->updateOathCredential($clientExtId, $userExtId, $extId, $oathPatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OATHRESTServiceApi->updateOathCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OATHRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OATHRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 4321; # String | ExtID of the OATH credential
my $oathPatchDTO = WWW::OPenAPIClient::Object::OathPatchDTO->new(); # OathPatchDTO | 

eval {
    my $result = $api_instance->updateOathCredential(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId, oathPatchDTO => $oathPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OATHRESTServiceApi->updateOathCredential: $@\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.OATHRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 4321 # String | ExtID of the OATH credential (default to null)
oathPatchDTO = {"stateName":"active","modificationComment":"Update OATH comment","label":"labelUpdate","policyExtId":"270000001"} # OathPatchDTO | 

try:
    # Update OATH Credential
    api_response = api_instance.update_oath_credential(clientExtId, userExtId, extId, oathPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OATHRESTServiceApi->updateOathCredential: %s\n" % e)
extern crate OATHRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 4321; // String
    let oathPatchDTO = {"stateName":"active","modificationComment":"Update OATH comment","label":"labelUpdate","policyExtId":"270000001"}; // OathPatchDTO

    let mut context = OATHRESTServiceApi::Context::default();
    let result = client.updateOathCredential(clientExtId, userExtId, extId, oathPatchDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the OATH credential
Required
Body parameters
Name Description
oathPatchDTO *

Responses


PasswordLoginRESTService

passwordLogin

passwordLogin
post/auth/v1/{clientExtId}/users/{userExtId}/password/login

**Since:** 2.88.0 Log in with the defined password credential of the user.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/auth/v1/{clientExtId}/users/{userExtId}/password/login" \
 -d '{
  "password" : "1StrongPassword!"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PasswordLoginRESTServiceApi;

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

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

        // Create an instance of the API class
        PasswordLoginRESTServiceApi apiInstance = new PasswordLoginRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        PasswordLoginDTO passwordLoginDTO = {"password":"1StrongPassword!"}; // PasswordLoginDTO | 

        try {
            LoginStatusDTO result = apiInstance.passwordLogin(clientExtId, userExtId, passwordLoginDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordLoginRESTServiceApi#passwordLogin");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final PasswordLoginDTO passwordLoginDTO = new PasswordLoginDTO(); // PasswordLoginDTO | 

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

import org.openapitools.client.api.PasswordLoginRESTServiceApi;

public class PasswordLoginRESTServiceApiExample {
    public static void main(String[] args) {
        PasswordLoginRESTServiceApi apiInstance = new PasswordLoginRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        PasswordLoginDTO passwordLoginDTO = {"password":"1StrongPassword!"}; // PasswordLoginDTO | 

        try {
            LoginStatusDTO result = apiInstance.passwordLogin(clientExtId, userExtId, passwordLoginDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordLoginRESTServiceApi#passwordLogin");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PasswordLoginRESTServiceApi *apiInstance = [[PasswordLoginRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
PasswordLoginDTO *passwordLoginDTO = {"password":"1StrongPassword!"}; // 

// Login with password credential
[apiInstance passwordLoginWith:clientExtId
    userExtId:userExtId
    passwordLoginDTO:passwordLoginDTO
              completionHandler: ^(LoginStatusDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PasswordLoginRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var passwordLoginDTO = {"password":"1StrongPassword!"}; // {PasswordLoginDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new PasswordLoginRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var passwordLoginDTO = new PasswordLoginDTO(); // PasswordLoginDTO | 

            try {
                // Login with password credential
                LoginStatusDTO result = apiInstance.passwordLogin(clientExtId, userExtId, passwordLoginDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PasswordLoginRESTServiceApi.passwordLogin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PasswordLoginRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$passwordLoginDTO = {"password":"1StrongPassword!"}; // PasswordLoginDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PasswordLoginRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $passwordLoginDTO = WWW::OPenAPIClient::Object::PasswordLoginDTO->new(); # PasswordLoginDTO | 

eval {
    my $result = $api_instance->passwordLogin(clientExtId => $clientExtId, userExtId => $userExtId, passwordLoginDTO => $passwordLoginDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PasswordLoginRESTServiceApi->passwordLogin: $@\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.PasswordLoginRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
passwordLoginDTO = {"password":"1StrongPassword!"} # PasswordLoginDTO | 

try:
    # Login with password credential
    api_response = api_instance.password_login(clientExtId, userExtId, passwordLoginDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PasswordLoginRESTServiceApi->passwordLogin: %s\n" % e)
extern crate PasswordLoginRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let passwordLoginDTO = {"password":"1StrongPassword!"}; // PasswordLoginDTO

    let mut context = PasswordLoginRESTServiceApi::Context::default();
    let result = client.passwordLogin(clientExtId, userExtId, passwordLoginDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
passwordLoginDTO *

Responses


PasswordRESTService

changePassword

changePassword
post/core/v1/{clientExtId}/users/{userExtId}/password/change

**Since:** 2.71.0 **Required permission(s):** `AccessControl.CredentialModify` or `SelfAdmin` Role Changes the password of the user with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/password/change" \
 -d '{
  "oldPassword" : "oldPassword",
  "newPassword" : "newPassword"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        PasswordRESTServiceApi apiInstance = new PasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        PasswordChangeDTO passwordChangeDTO = {"oldPassword":"oldPassword","newPassword":"newSecretPassword"}; // PasswordChangeDTO | 

        try {
            apiInstance.changePassword(clientExtId, userExtId, passwordChangeDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordRESTServiceApi#changePassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final PasswordChangeDTO passwordChangeDTO = new PasswordChangeDTO(); // PasswordChangeDTO | 

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

import org.openapitools.client.api.PasswordRESTServiceApi;

public class PasswordRESTServiceApiExample {
    public static void main(String[] args) {
        PasswordRESTServiceApi apiInstance = new PasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        PasswordChangeDTO passwordChangeDTO = {"oldPassword":"oldPassword","newPassword":"newSecretPassword"}; // PasswordChangeDTO | 

        try {
            apiInstance.changePassword(clientExtId, userExtId, passwordChangeDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordRESTServiceApi#changePassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PasswordRESTServiceApi *apiInstance = [[PasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
PasswordChangeDTO *passwordChangeDTO = {"oldPassword":"oldPassword","newPassword":"newSecretPassword"}; // 

// Change Password
[apiInstance changePasswordWith:clientExtId
    userExtId:userExtId
    passwordChangeDTO:passwordChangeDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var passwordChangeDTO = {"oldPassword":"oldPassword","newPassword":"newSecretPassword"}; // {PasswordChangeDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new PasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var passwordChangeDTO = new PasswordChangeDTO(); // PasswordChangeDTO | 

            try {
                // Change Password
                apiInstance.changePassword(clientExtId, userExtId, passwordChangeDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling PasswordRESTServiceApi.changePassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$passwordChangeDTO = {"oldPassword":"oldPassword","newPassword":"newSecretPassword"}; // PasswordChangeDTO | 

try {
    $api_instance->changePassword($clientExtId, $userExtId, $passwordChangeDTO);
} catch (Exception $e) {
    echo 'Exception when calling PasswordRESTServiceApi->changePassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PasswordRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $passwordChangeDTO = WWW::OPenAPIClient::Object::PasswordChangeDTO->new(); # PasswordChangeDTO | 

eval {
    $api_instance->changePassword(clientExtId => $clientExtId, userExtId => $userExtId, passwordChangeDTO => $passwordChangeDTO);
};
if ($@) {
    warn "Exception when calling PasswordRESTServiceApi->changePassword: $@\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.PasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
passwordChangeDTO = {"oldPassword":"oldPassword","newPassword":"newSecretPassword"} # PasswordChangeDTO | 

try:
    # Change Password
    api_instance.change_password(clientExtId, userExtId, passwordChangeDTO)
except ApiException as e:
    print("Exception when calling PasswordRESTServiceApi->changePassword: %s\n" % e)
extern crate PasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let passwordChangeDTO = {"oldPassword":"oldPassword","newPassword":"newSecretPassword"}; // PasswordChangeDTO

    let mut context = PasswordRESTServiceApi::Context::default();
    let result = client.changePassword(clientExtId, userExtId, passwordChangeDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
passwordChangeDTO *

Responses


createPassword

createPassword
post/core/v1/{clientExtId}/users/{userExtId}/password

**Since:** 2.71.0 **Required permission(s):** `AccessControl.CredentialCreate,AccessControl.CredentialChangeState` Creates a password for the user with the given external ID. No content is returned when in the given password policy the "Reset code" function is disabled (parameter _resetCodeEnabled_ is set to false), or the length of the returned part of the reset code is set to "0" (parameter _resetCodeLen0_). In all other cases, the response contains a part of the generated password, in the parameter _passwordFragment_. In case the password creation fails, because the provided password violates any password policies, all the related policies will be included in the error message.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/password" \
 -d '{
  "policyExtId" : "policyExtId",
  "password" : "password",
  "stateName" : "INITIAL",
  "extId" : "extId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        PasswordRESTServiceApi apiInstance = new PasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        PasswordCreateDTO passwordCreateDTO = {"extId":"1001","policyExtId":"100","stateName":"active","password":"secretpassword"}; // PasswordCreateDTO | 

        try {
            PasswordFragmentDTO result = apiInstance.createPassword(clientExtId, userExtId, passwordCreateDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordRESTServiceApi#createPassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final PasswordCreateDTO passwordCreateDTO = new PasswordCreateDTO(); // PasswordCreateDTO | 

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

import org.openapitools.client.api.PasswordRESTServiceApi;

public class PasswordRESTServiceApiExample {
    public static void main(String[] args) {
        PasswordRESTServiceApi apiInstance = new PasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        PasswordCreateDTO passwordCreateDTO = {"extId":"1001","policyExtId":"100","stateName":"active","password":"secretpassword"}; // PasswordCreateDTO | 

        try {
            PasswordFragmentDTO result = apiInstance.createPassword(clientExtId, userExtId, passwordCreateDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordRESTServiceApi#createPassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PasswordRESTServiceApi *apiInstance = [[PasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
PasswordCreateDTO *passwordCreateDTO = {"extId":"1001","policyExtId":"100","stateName":"active","password":"secretpassword"}; // 

// Create password
[apiInstance createPasswordWith:clientExtId
    userExtId:userExtId
    passwordCreateDTO:passwordCreateDTO
              completionHandler: ^(PasswordFragmentDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var passwordCreateDTO = {"extId":"1001","policyExtId":"100","stateName":"active","password":"secretpassword"}; // {PasswordCreateDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new PasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var passwordCreateDTO = new PasswordCreateDTO(); // PasswordCreateDTO | 

            try {
                // Create password
                PasswordFragmentDTO result = apiInstance.createPassword(clientExtId, userExtId, passwordCreateDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PasswordRESTServiceApi.createPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$passwordCreateDTO = {"extId":"1001","policyExtId":"100","stateName":"active","password":"secretpassword"}; // PasswordCreateDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $passwordCreateDTO = WWW::OPenAPIClient::Object::PasswordCreateDTO->new(); # PasswordCreateDTO | 

eval {
    my $result = $api_instance->createPassword(clientExtId => $clientExtId, userExtId => $userExtId, passwordCreateDTO => $passwordCreateDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PasswordRESTServiceApi->createPassword: $@\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.PasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
passwordCreateDTO = {"extId":"1001","policyExtId":"100","stateName":"active","password":"secretpassword"} # PasswordCreateDTO | 

try:
    # Create password
    api_response = api_instance.create_password(clientExtId, userExtId, passwordCreateDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PasswordRESTServiceApi->createPassword: %s\n" % e)
extern crate PasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let passwordCreateDTO = {"extId":"1001","policyExtId":"100","stateName":"active","password":"secretpassword"}; // PasswordCreateDTO

    let mut context = PasswordRESTServiceApi::Context::default();
    let result = client.createPassword(clientExtId, userExtId, passwordCreateDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
passwordCreateDTO *

Responses


deletePassword

deletePassword
delete/core/v1/{clientExtId}/users/{userExtId}/password

**Since:** 2.73.0 **Required permission(s):** `AccessControl.CredentialDelete` or `SelfAdmin` Role Deletes the password credential of the user with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/password"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        PasswordRESTServiceApi apiInstance = new PasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            apiInstance.deletePassword(clientExtId, userExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordRESTServiceApi#deletePassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user

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

import org.openapitools.client.api.PasswordRESTServiceApi;

public class PasswordRESTServiceApiExample {
    public static void main(String[] args) {
        PasswordRESTServiceApi apiInstance = new PasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            apiInstance.deletePassword(clientExtId, userExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordRESTServiceApi#deletePassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PasswordRESTServiceApi *apiInstance = [[PasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)

// Delete Password
[apiInstance deletePasswordWith:clientExtId
    userExtId:userExtId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user

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

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

            // Create an instance of the API class
            var apiInstance = new PasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)

            try {
                // Delete Password
                apiInstance.deletePassword(clientExtId, userExtId);
            } catch (Exception e) {
                Debug.Print("Exception when calling PasswordRESTServiceApi.deletePassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user

eval {
    $api_instance->deletePassword(clientExtId => $clientExtId, userExtId => $userExtId);
};
if ($@) {
    warn "Exception when calling PasswordRESTServiceApi->deletePassword: $@\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.PasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)

try:
    # Delete Password
    api_instance.delete_password(clientExtId, userExtId)
except ApiException as e:
    print("Exception when calling PasswordRESTServiceApi->deletePassword: %s\n" % e)
extern crate PasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String

    let mut context = PasswordRESTServiceApi::Context::default();
    let result = client.deletePassword(clientExtId, userExtId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required

Responses


getPassword

getPassword
get/core/v1/{clientExtId}/users/{userExtId}/password

**Since:** 2.71.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Gets the password credential of the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/password"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        PasswordRESTServiceApi apiInstance = new PasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            PasswordGetDTO result = apiInstance.getPassword(clientExtId, userExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordRESTServiceApi#getPassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user

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

import org.openapitools.client.api.PasswordRESTServiceApi;

public class PasswordRESTServiceApiExample {
    public static void main(String[] args) {
        PasswordRESTServiceApi apiInstance = new PasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            PasswordGetDTO result = apiInstance.getPassword(clientExtId, userExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordRESTServiceApi#getPassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PasswordRESTServiceApi *apiInstance = [[PasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)

// Get Password
[apiInstance getPasswordWith:clientExtId
    userExtId:userExtId
              completionHandler: ^(PasswordGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user

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

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

            // Create an instance of the API class
            var apiInstance = new PasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)

            try {
                // Get Password
                PasswordGetDTO result = apiInstance.getPassword(clientExtId, userExtId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PasswordRESTServiceApi.getPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user

eval {
    my $result = $api_instance->getPassword(clientExtId => $clientExtId, userExtId => $userExtId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PasswordRESTServiceApi->getPassword: $@\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.PasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)

try:
    # Get Password
    api_response = api_instance.get_password(clientExtId, userExtId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PasswordRESTServiceApi->getPassword: %s\n" % e)
extern crate PasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String

    let mut context = PasswordRESTServiceApi::Context::default();
    let result = client.getPassword(clientExtId, userExtId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required

Responses


resetPassword

resetPassword
post/core/v1/{clientExtId}/users/{userExtId}/password/reset

**Since:** 2.78.0 **Required permission(s):** `AccessControl.CredentialView,AccessControl.CredentialModify` or `SelfAdmin` Role Resets the password of the user with the given external ID. Depending on the password policy, the response either contains a part of the generated password in the parameter _passwordFragment_, or no content is returned. Changes the state of the credential to _initial_.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/password/reset"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        PasswordRESTServiceApi apiInstance = new PasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            PasswordFragmentDTO result = apiInstance.resetPassword(clientExtId, userExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordRESTServiceApi#resetPassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user

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

import org.openapitools.client.api.PasswordRESTServiceApi;

public class PasswordRESTServiceApiExample {
    public static void main(String[] args) {
        PasswordRESTServiceApi apiInstance = new PasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            PasswordFragmentDTO result = apiInstance.resetPassword(clientExtId, userExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordRESTServiceApi#resetPassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PasswordRESTServiceApi *apiInstance = [[PasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)

// Reset Password
[apiInstance resetPasswordWith:clientExtId
    userExtId:userExtId
              completionHandler: ^(PasswordFragmentDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user

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

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

            // Create an instance of the API class
            var apiInstance = new PasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)

            try {
                // Reset Password
                PasswordFragmentDTO result = apiInstance.resetPassword(clientExtId, userExtId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PasswordRESTServiceApi.resetPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user

eval {
    my $result = $api_instance->resetPassword(clientExtId => $clientExtId, userExtId => $userExtId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PasswordRESTServiceApi->resetPassword: $@\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.PasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)

try:
    # Reset Password
    api_response = api_instance.reset_password(clientExtId, userExtId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PasswordRESTServiceApi->resetPassword: %s\n" % e)
extern crate PasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String

    let mut context = PasswordRESTServiceApi::Context::default();
    let result = client.resetPassword(clientExtId, userExtId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required

Responses


unlockPassword

unlockPassword
post/core/v1/{clientExtId}/users/{userExtId}/password/unlock

**Since:** 2.78.0 **Required permission(s):** `AccessControl.CredentialView,AccessControl.CredentialModify` Unlocks the password of the user with the given external ID. No content is returned. Changes the state of the credential to _active_ and resets the _failedLoginCount_ and _successfulLoginCount_ to 0.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/password/unlock"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        PasswordRESTServiceApi apiInstance = new PasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            'String' result = apiInstance.unlockPassword(clientExtId, userExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordRESTServiceApi#unlockPassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user

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

import org.openapitools.client.api.PasswordRESTServiceApi;

public class PasswordRESTServiceApiExample {
    public static void main(String[] args) {
        PasswordRESTServiceApi apiInstance = new PasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            'String' result = apiInstance.unlockPassword(clientExtId, userExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordRESTServiceApi#unlockPassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PasswordRESTServiceApi *apiInstance = [[PasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)

// Unlock Password
[apiInstance unlockPasswordWith:clientExtId
    userExtId:userExtId
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user

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

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

            // Create an instance of the API class
            var apiInstance = new PasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)

            try {
                // Unlock Password
                'String' result = apiInstance.unlockPassword(clientExtId, userExtId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PasswordRESTServiceApi.unlockPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user

eval {
    my $result = $api_instance->unlockPassword(clientExtId => $clientExtId, userExtId => $userExtId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PasswordRESTServiceApi->unlockPassword: $@\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.PasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)

try:
    # Unlock Password
    api_response = api_instance.unlock_password(clientExtId, userExtId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PasswordRESTServiceApi->unlockPassword: %s\n" % e)
extern crate PasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String

    let mut context = PasswordRESTServiceApi::Context::default();
    let result = client.unlockPassword(clientExtId, userExtId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required

Responses


updatePassword

updatePassword
patch/core/v1/{clientExtId}/users/{userExtId}/password

**Since:** 2.71.0 **Required permission(s):** `AccessControl.CredentialView,AccessControl.CredentialModify` Updates the password credential of the user with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/password" \
 -d '{
  "stateName" : "INITIAL",
  "modificationComment" : "modificationComment",
  "version" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PasswordRESTServiceApi;

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

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

        // Create an instance of the API class
        PasswordRESTServiceApi apiInstance = new PasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        PasswordPatchDTO passwordPatchDTO = {"stateName":"active","modificationComment":"modified","version":0}; // PasswordPatchDTO | 

        try {
            PasswordGetDTO result = apiInstance.updatePassword(clientExtId, userExtId, passwordPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordRESTServiceApi#updatePassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final PasswordPatchDTO passwordPatchDTO = new PasswordPatchDTO(); // PasswordPatchDTO | 

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

import org.openapitools.client.api.PasswordRESTServiceApi;

public class PasswordRESTServiceApiExample {
    public static void main(String[] args) {
        PasswordRESTServiceApi apiInstance = new PasswordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        PasswordPatchDTO passwordPatchDTO = {"stateName":"active","modificationComment":"modified","version":0}; // PasswordPatchDTO | 

        try {
            PasswordGetDTO result = apiInstance.updatePassword(clientExtId, userExtId, passwordPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordRESTServiceApi#updatePassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PasswordRESTServiceApi *apiInstance = [[PasswordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
PasswordPatchDTO *passwordPatchDTO = {"stateName":"active","modificationComment":"modified","version":0}; // 

// Update Password
[apiInstance updatePasswordWith:clientExtId
    userExtId:userExtId
    passwordPatchDTO:passwordPatchDTO
              completionHandler: ^(PasswordGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PasswordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var passwordPatchDTO = {"stateName":"active","modificationComment":"modified","version":0}; // {PasswordPatchDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new PasswordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var passwordPatchDTO = new PasswordPatchDTO(); // PasswordPatchDTO | 

            try {
                // Update Password
                PasswordGetDTO result = apiInstance.updatePassword(clientExtId, userExtId, passwordPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PasswordRESTServiceApi.updatePassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PasswordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$passwordPatchDTO = {"stateName":"active","modificationComment":"modified","version":0}; // PasswordPatchDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PasswordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $passwordPatchDTO = WWW::OPenAPIClient::Object::PasswordPatchDTO->new(); # PasswordPatchDTO | 

eval {
    my $result = $api_instance->updatePassword(clientExtId => $clientExtId, userExtId => $userExtId, passwordPatchDTO => $passwordPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PasswordRESTServiceApi->updatePassword: $@\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.PasswordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
passwordPatchDTO = {"stateName":"active","modificationComment":"modified","version":0} # PasswordPatchDTO | 

try:
    # Update Password
    api_response = api_instance.update_password(clientExtId, userExtId, passwordPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PasswordRESTServiceApi->updatePassword: %s\n" % e)
extern crate PasswordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let passwordPatchDTO = {"stateName":"active","modificationComment":"modified","version":0}; // PasswordPatchDTO

    let mut context = PasswordRESTServiceApi::Context::default();
    let result = client.updatePassword(clientExtId, userExtId, passwordPatchDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
passwordPatchDTO *

Responses


PersonalQuestionRESTService

createPersonalQuestion

createPersonalQuestion
post/core/v1/{clientExtId}/personal-questions

**Since:** 2.79.0 **Required permission(s):** `AccessControl.ClientView,AccessControl.PersonalQuestionCreate` Creates a new personal question for the client with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/personal-questions" \
 -d '{
  "stateName" : "ACTIVE",
  "displayName" : {
    "key" : "displayName"
  },
  "description" : "description",
  "extId" : "extId",
  "content" : {
    "key" : "content"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PersonalQuestionRESTServiceApi;

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

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

        // Create an instance of the API class
        PersonalQuestionRESTServiceApi apiInstance = new PersonalQuestionRESTServiceApi();
        String clientExtId = clientExtId_example; // String | 
        PersonalQuestionCreateDTO personalQuestionCreateDTO = {"extId":"1003","description":"something","stateName":"active","displayName":{"DE":"QuestionNew","EN":"QuestionNew","FR":"QuestionNew","IT":"QuestionNew"},"content":{"DE":"QuestionNewContent","EN":"QuestionNewContent","FR":"QuestionNewContent","IT":"QuestionNewContent"}}; // PersonalQuestionCreateDTO | 

        try {
            apiInstance.createPersonalQuestion(clientExtId, personalQuestionCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalQuestionRESTServiceApi#createPersonalQuestion");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | 
final PersonalQuestionCreateDTO personalQuestionCreateDTO = new PersonalQuestionCreateDTO(); // PersonalQuestionCreateDTO | 

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

import org.openapitools.client.api.PersonalQuestionRESTServiceApi;

public class PersonalQuestionRESTServiceApiExample {
    public static void main(String[] args) {
        PersonalQuestionRESTServiceApi apiInstance = new PersonalQuestionRESTServiceApi();
        String clientExtId = clientExtId_example; // String | 
        PersonalQuestionCreateDTO personalQuestionCreateDTO = {"extId":"1003","description":"something","stateName":"active","displayName":{"DE":"QuestionNew","EN":"QuestionNew","FR":"QuestionNew","IT":"QuestionNew"},"content":{"DE":"QuestionNewContent","EN":"QuestionNewContent","FR":"QuestionNewContent","IT":"QuestionNewContent"}}; // PersonalQuestionCreateDTO | 

        try {
            apiInstance.createPersonalQuestion(clientExtId, personalQuestionCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalQuestionRESTServiceApi#createPersonalQuestion");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PersonalQuestionRESTServiceApi *apiInstance = [[PersonalQuestionRESTServiceApi alloc] init];
String *clientExtId = clientExtId_example; //  (default to null)
PersonalQuestionCreateDTO *personalQuestionCreateDTO = {"extId":"1003","description":"something","stateName":"active","displayName":{"DE":"QuestionNew","EN":"QuestionNew","FR":"QuestionNew","IT":"QuestionNew"},"content":{"DE":"QuestionNewContent","EN":"QuestionNewContent","FR":"QuestionNewContent","IT":"QuestionNewContent"}}; // 

// Create new personal question
[apiInstance createPersonalQuestionWith:clientExtId
    personalQuestionCreateDTO:personalQuestionCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PersonalQuestionRESTServiceApi()
var clientExtId = clientExtId_example; // {String} 
var personalQuestionCreateDTO = {"extId":"1003","description":"something","stateName":"active","displayName":{"DE":"QuestionNew","EN":"QuestionNew","FR":"QuestionNew","IT":"QuestionNew"},"content":{"DE":"QuestionNewContent","EN":"QuestionNewContent","FR":"QuestionNewContent","IT":"QuestionNewContent"}}; // {PersonalQuestionCreateDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new PersonalQuestionRESTServiceApi();
            var clientExtId = clientExtId_example;  // String |  (default to null)
            var personalQuestionCreateDTO = new PersonalQuestionCreateDTO(); // PersonalQuestionCreateDTO | 

            try {
                // Create new personal question
                apiInstance.createPersonalQuestion(clientExtId, personalQuestionCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling PersonalQuestionRESTServiceApi.createPersonalQuestion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PersonalQuestionRESTServiceApi();
$clientExtId = clientExtId_example; // String | 
$personalQuestionCreateDTO = {"extId":"1003","description":"something","stateName":"active","displayName":{"DE":"QuestionNew","EN":"QuestionNew","FR":"QuestionNew","IT":"QuestionNew"},"content":{"DE":"QuestionNewContent","EN":"QuestionNewContent","FR":"QuestionNewContent","IT":"QuestionNewContent"}}; // PersonalQuestionCreateDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PersonalQuestionRESTServiceApi->new();
my $clientExtId = clientExtId_example; # String | 
my $personalQuestionCreateDTO = WWW::OPenAPIClient::Object::PersonalQuestionCreateDTO->new(); # PersonalQuestionCreateDTO | 

eval {
    $api_instance->createPersonalQuestion(clientExtId => $clientExtId, personalQuestionCreateDTO => $personalQuestionCreateDTO);
};
if ($@) {
    warn "Exception when calling PersonalQuestionRESTServiceApi->createPersonalQuestion: $@\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.PersonalQuestionRESTServiceApi()
clientExtId = clientExtId_example # String |  (default to null)
personalQuestionCreateDTO = {"extId":"1003","description":"something","stateName":"active","displayName":{"DE":"QuestionNew","EN":"QuestionNew","FR":"QuestionNew","IT":"QuestionNew"},"content":{"DE":"QuestionNewContent","EN":"QuestionNewContent","FR":"QuestionNewContent","IT":"QuestionNewContent"}} # PersonalQuestionCreateDTO | 

try:
    # Create new personal question
    api_instance.create_personal_question(clientExtId, personalQuestionCreateDTO)
except ApiException as e:
    print("Exception when calling PersonalQuestionRESTServiceApi->createPersonalQuestion: %s\n" % e)
extern crate PersonalQuestionRESTServiceApi;

pub fn main() {
    let clientExtId = clientExtId_example; // String
    let personalQuestionCreateDTO = {"extId":"1003","description":"something","stateName":"active","displayName":{"DE":"QuestionNew","EN":"QuestionNew","FR":"QuestionNew","IT":"QuestionNew"},"content":{"DE":"QuestionNewContent","EN":"QuestionNewContent","FR":"QuestionNewContent","IT":"QuestionNewContent"}}; // PersonalQuestionCreateDTO

    let mut context = PersonalQuestionRESTServiceApi::Context::default();
    let result = client.createPersonalQuestion(clientExtId, personalQuestionCreateDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
Required
Body parameters
Name Description
personalQuestionCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

deletePersonalQuestion

deletePersonalQuestion
delete/core/v1/{clientExtId}/personal-questions/{extId}

**Since:** 2.79.0 **Required permission(s):** `AccessControl.PersonalQuestionDelete` Deletes a personal question with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/personal-questions/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PersonalQuestionRESTServiceApi;

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

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

        // Create an instance of the API class
        PersonalQuestionRESTServiceApi apiInstance = new PersonalQuestionRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2233; // String | ExtID of the personal question

        try {
            apiInstance.deletePersonalQuestion(clientExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalQuestionRESTServiceApi#deletePersonalQuestion");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the personal question

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

import org.openapitools.client.api.PersonalQuestionRESTServiceApi;

public class PersonalQuestionRESTServiceApiExample {
    public static void main(String[] args) {
        PersonalQuestionRESTServiceApi apiInstance = new PersonalQuestionRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2233; // String | ExtID of the personal question

        try {
            apiInstance.deletePersonalQuestion(clientExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalQuestionRESTServiceApi#deletePersonalQuestion");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PersonalQuestionRESTServiceApi *apiInstance = [[PersonalQuestionRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 2233; // ExtID of the personal question (default to null)

// Delete a personal question
[apiInstance deletePersonalQuestionWith:clientExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PersonalQuestionRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 2233; // {String} ExtID of the personal question

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

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

            // Create an instance of the API class
            var apiInstance = new PersonalQuestionRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 2233;  // String | ExtID of the personal question (default to null)

            try {
                // Delete a personal question
                apiInstance.deletePersonalQuestion(clientExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling PersonalQuestionRESTServiceApi.deletePersonalQuestion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PersonalQuestionRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 2233; // String | ExtID of the personal question

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PersonalQuestionRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 2233; # String | ExtID of the personal question

eval {
    $api_instance->deletePersonalQuestion(clientExtId => $clientExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling PersonalQuestionRESTServiceApi->deletePersonalQuestion: $@\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.PersonalQuestionRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 2233 # String | ExtID of the personal question (default to null)

try:
    # Delete a personal question
    api_instance.delete_personal_question(clientExtId, extId)
except ApiException as e:
    print("Exception when calling PersonalQuestionRESTServiceApi->deletePersonalQuestion: %s\n" % e)
extern crate PersonalQuestionRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 2233; // String

    let mut context = PersonalQuestionRESTServiceApi::Context::default();
    let result = client.deletePersonalQuestion(clientExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the personal question
Required

Responses


getPersonalQuestionByExtId

getPersonalQuestionByExtId
get/core/v1/{clientExtId}/personal-questions/{extId}

**Since:** 2.79.0 **Required permission(s):** `AccessControl.PersonalQuestionView,AccessControl.CredentialView` Returns the personal question with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/personal-questions/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PersonalQuestionRESTServiceApi;

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

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

        // Create an instance of the API class
        PersonalQuestionRESTServiceApi apiInstance = new PersonalQuestionRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2233; // String | ExtID of the personal question

        try {
            PersonalQuestionGetDTO result = apiInstance.getPersonalQuestionByExtId(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalQuestionRESTServiceApi#getPersonalQuestionByExtId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the personal question

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

import org.openapitools.client.api.PersonalQuestionRESTServiceApi;

public class PersonalQuestionRESTServiceApiExample {
    public static void main(String[] args) {
        PersonalQuestionRESTServiceApi apiInstance = new PersonalQuestionRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2233; // String | ExtID of the personal question

        try {
            PersonalQuestionGetDTO result = apiInstance.getPersonalQuestionByExtId(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalQuestionRESTServiceApi#getPersonalQuestionByExtId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PersonalQuestionRESTServiceApi *apiInstance = [[PersonalQuestionRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 2233; // ExtID of the personal question (default to null)

// Get a personal question
[apiInstance getPersonalQuestionByExtIdWith:clientExtId
    extId:extId
              completionHandler: ^(PersonalQuestionGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PersonalQuestionRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 2233; // {String} ExtID of the personal question

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

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

            // Create an instance of the API class
            var apiInstance = new PersonalQuestionRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 2233;  // String | ExtID of the personal question (default to null)

            try {
                // Get a personal question
                PersonalQuestionGetDTO result = apiInstance.getPersonalQuestionByExtId(clientExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PersonalQuestionRESTServiceApi.getPersonalQuestionByExtId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PersonalQuestionRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 2233; // String | ExtID of the personal question

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PersonalQuestionRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 2233; # String | ExtID of the personal question

eval {
    my $result = $api_instance->getPersonalQuestionByExtId(clientExtId => $clientExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PersonalQuestionRESTServiceApi->getPersonalQuestionByExtId: $@\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.PersonalQuestionRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 2233 # String | ExtID of the personal question (default to null)

try:
    # Get a personal question
    api_response = api_instance.get_personal_question_by_ext_id(clientExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalQuestionRESTServiceApi->getPersonalQuestionByExtId: %s\n" % e)
extern crate PersonalQuestionRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 2233; // String

    let mut context = PersonalQuestionRESTServiceApi::Context::default();
    let result = client.getPersonalQuestionByExtId(clientExtId, extId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the personal question
Required

Responses


getPersonalQuestions

getPersonalQuestions
get/core/v1/{clientExtId}/personal-questions

**Since:** 2.79.0 **Required permission(s):** `AccessControl.ClientView,AccessControl.PersonalQuestionView` Returns all personal questions of the client with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/personal-questions?continuationToken=continuationToken_example&limit=100"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PersonalQuestionRESTServiceApi;

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

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

        // Create an instance of the API class
        PersonalQuestionRESTServiceApi apiInstance = new PersonalQuestionRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperForPersonalQuestionGetDTO result = apiInstance.getPersonalQuestions(clientExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalQuestionRESTServiceApi#getPersonalQuestions");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

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

import org.openapitools.client.api.PersonalQuestionRESTServiceApi;

public class PersonalQuestionRESTServiceApiExample {
    public static void main(String[] args) {
        PersonalQuestionRESTServiceApi apiInstance = new PersonalQuestionRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperForPersonalQuestionGetDTO result = apiInstance.getPersonalQuestions(clientExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalQuestionRESTServiceApi#getPersonalQuestions");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PersonalQuestionRESTServiceApi *apiInstance = [[PersonalQuestionRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 100; // Pagination limit (optional) (default to 0)

// Get personal questions
[apiInstance getPersonalQuestionsWith:clientExtId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForPersonalQuestionGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PersonalQuestionRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 100 // {Integer} Pagination limit
};

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

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

            // Create an instance of the API class
            var apiInstance = new PersonalQuestionRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 100;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get personal questions
                ItemsWrapperForPersonalQuestionGetDTO result = apiInstance.getPersonalQuestions(clientExtId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PersonalQuestionRESTServiceApi.getPersonalQuestions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PersonalQuestionRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 100; // Integer | Pagination limit

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PersonalQuestionRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 100; # Integer | Pagination limit

eval {
    my $result = $api_instance->getPersonalQuestions(clientExtId => $clientExtId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PersonalQuestionRESTServiceApi->getPersonalQuestions: $@\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.PersonalQuestionRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 100 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get personal questions
    api_response = api_instance.get_personal_questions(clientExtId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalQuestionRESTServiceApi->getPersonalQuestions: %s\n" % e)
extern crate PersonalQuestionRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let continuationToken = continuationToken_example; // String
    let limit = 100; // Integer

    let mut context = PersonalQuestionRESTServiceApi::Context::default();
    let result = client.getPersonalQuestions(clientExtId, continuationToken, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


updatePersonalQuestion

updatePersonalQuestion
patch/core/v1/{clientExtId}/personal-questions/{extId}

**Since:** 2.79.0 **Required permission(s):** `AccessControl.PersonalQuestionView,AccessControl.PersonalQuestionModify,AccessControl.CredentialView` Updates the personal question with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/personal-questions/{extId}" \
 -d '{
  "stateName" : "ACTIVE",
  "displayName" : {
    "key" : "displayName"
  },
  "description" : "description",
  "version" : 0,
  "content" : {
    "key" : "content"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PersonalQuestionRESTServiceApi;

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

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

        // Create an instance of the API class
        PersonalQuestionRESTServiceApi apiInstance = new PersonalQuestionRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2233; // String | ExtID of the personal question
        PersonalQuestionPatchDTO personalQuestionPatchDTO = {"version":1,"description":"new description","stateName":"disabled"}; // PersonalQuestionPatchDTO | 

        try {
            PersonalQuestionGetDTO result = apiInstance.updatePersonalQuestion(clientExtId, extId, personalQuestionPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalQuestionRESTServiceApi#updatePersonalQuestion");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the personal question
final PersonalQuestionPatchDTO personalQuestionPatchDTO = new PersonalQuestionPatchDTO(); // PersonalQuestionPatchDTO | 

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

import org.openapitools.client.api.PersonalQuestionRESTServiceApi;

public class PersonalQuestionRESTServiceApiExample {
    public static void main(String[] args) {
        PersonalQuestionRESTServiceApi apiInstance = new PersonalQuestionRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2233; // String | ExtID of the personal question
        PersonalQuestionPatchDTO personalQuestionPatchDTO = {"version":1,"description":"new description","stateName":"disabled"}; // PersonalQuestionPatchDTO | 

        try {
            PersonalQuestionGetDTO result = apiInstance.updatePersonalQuestion(clientExtId, extId, personalQuestionPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalQuestionRESTServiceApi#updatePersonalQuestion");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PersonalQuestionRESTServiceApi *apiInstance = [[PersonalQuestionRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 2233; // ExtID of the personal question (default to null)
PersonalQuestionPatchDTO *personalQuestionPatchDTO = {"version":1,"description":"new description","stateName":"disabled"}; // 

// Update a personal question
[apiInstance updatePersonalQuestionWith:clientExtId
    extId:extId
    personalQuestionPatchDTO:personalQuestionPatchDTO
              completionHandler: ^(PersonalQuestionGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PersonalQuestionRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 2233; // {String} ExtID of the personal question
var personalQuestionPatchDTO = {"version":1,"description":"new description","stateName":"disabled"}; // {PersonalQuestionPatchDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new PersonalQuestionRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 2233;  // String | ExtID of the personal question (default to null)
            var personalQuestionPatchDTO = new PersonalQuestionPatchDTO(); // PersonalQuestionPatchDTO | 

            try {
                // Update a personal question
                PersonalQuestionGetDTO result = apiInstance.updatePersonalQuestion(clientExtId, extId, personalQuestionPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PersonalQuestionRESTServiceApi.updatePersonalQuestion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PersonalQuestionRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 2233; // String | ExtID of the personal question
$personalQuestionPatchDTO = {"version":1,"description":"new description","stateName":"disabled"}; // PersonalQuestionPatchDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PersonalQuestionRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 2233; # String | ExtID of the personal question
my $personalQuestionPatchDTO = WWW::OPenAPIClient::Object::PersonalQuestionPatchDTO->new(); # PersonalQuestionPatchDTO | 

eval {
    my $result = $api_instance->updatePersonalQuestion(clientExtId => $clientExtId, extId => $extId, personalQuestionPatchDTO => $personalQuestionPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PersonalQuestionRESTServiceApi->updatePersonalQuestion: $@\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.PersonalQuestionRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 2233 # String | ExtID of the personal question (default to null)
personalQuestionPatchDTO = {"version":1,"description":"new description","stateName":"disabled"} # PersonalQuestionPatchDTO | 

try:
    # Update a personal question
    api_response = api_instance.update_personal_question(clientExtId, extId, personalQuestionPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalQuestionRESTServiceApi->updatePersonalQuestion: %s\n" % e)
extern crate PersonalQuestionRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 2233; // String
    let personalQuestionPatchDTO = {"version":1,"description":"new description","stateName":"disabled"}; // PersonalQuestionPatchDTO

    let mut context = PersonalQuestionRESTServiceApi::Context::default();
    let result = client.updatePersonalQuestion(clientExtId, extId, personalQuestionPatchDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the personal question
Required
Body parameters
Name Description
personalQuestionPatchDTO *

Responses


PolicyRESTService

createPolicyConfiguration

createPolicyConfiguration
post/core/v1/{clientExtId}/policies

**Since:** 2.79.0 **Required permission(s):** `AccessControl.PolicyCreate` Creates a new policy for the client with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/policies" \
 -d '{
  "defaultPolicy" : true,
  "policyType" : "PwdPolicy",
  "name" : "Customized Password Policy",
  "description" : "description",
  "extId" : "policy-123",
  "parameters" : {
    "minLength" : "8",
    "maxLength" : "64"
  },
  "version" : 1
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PolicyRESTServiceApi;

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

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

        // Create an instance of the API class
        PolicyRESTServiceApi apiInstance = new PolicyRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        PolicyConfigurationCreateDTO policyConfigurationCreateDTO = ; // PolicyConfigurationCreateDTO | 

        try {
            apiInstance.createPolicyConfiguration(clientExtId, policyConfigurationCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling PolicyRESTServiceApi#createPolicyConfiguration");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final PolicyConfigurationCreateDTO policyConfigurationCreateDTO = new PolicyConfigurationCreateDTO(); // PolicyConfigurationCreateDTO | 

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

import org.openapitools.client.api.PolicyRESTServiceApi;

public class PolicyRESTServiceApiExample {
    public static void main(String[] args) {
        PolicyRESTServiceApi apiInstance = new PolicyRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        PolicyConfigurationCreateDTO policyConfigurationCreateDTO = ; // PolicyConfigurationCreateDTO | 

        try {
            apiInstance.createPolicyConfiguration(clientExtId, policyConfigurationCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling PolicyRESTServiceApi#createPolicyConfiguration");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PolicyRESTServiceApi *apiInstance = [[PolicyRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
PolicyConfigurationCreateDTO *policyConfigurationCreateDTO = ; // 

// Create policy configuration
[apiInstance createPolicyConfigurationWith:clientExtId
    policyConfigurationCreateDTO:policyConfigurationCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PolicyRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var policyConfigurationCreateDTO = ; // {PolicyConfigurationCreateDTO} 

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

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

            // Create an instance of the API class
            var apiInstance = new PolicyRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var policyConfigurationCreateDTO = new PolicyConfigurationCreateDTO(); // PolicyConfigurationCreateDTO | 

            try {
                // Create policy configuration
                apiInstance.createPolicyConfiguration(clientExtId, policyConfigurationCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling PolicyRESTServiceApi.createPolicyConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PolicyRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$policyConfigurationCreateDTO = ; // PolicyConfigurationCreateDTO | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PolicyRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $policyConfigurationCreateDTO = WWW::OPenAPIClient::Object::PolicyConfigurationCreateDTO->new(); # PolicyConfigurationCreateDTO | 

eval {
    $api_instance->createPolicyConfiguration(clientExtId => $clientExtId, policyConfigurationCreateDTO => $policyConfigurationCreateDTO);
};
if ($@) {
    warn "Exception when calling PolicyRESTServiceApi->createPolicyConfiguration: $@\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.PolicyRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
policyConfigurationCreateDTO =  # PolicyConfigurationCreateDTO | 

try:
    # Create policy configuration
    api_instance.create_policy_configuration(clientExtId, policyConfigurationCreateDTO)
except ApiException as e:
    print("Exception when calling PolicyRESTServiceApi->createPolicyConfiguration: %s\n" % e)
extern crate PolicyRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let policyConfigurationCreateDTO = ; // PolicyConfigurationCreateDTO

    let mut context = PolicyRESTServiceApi::Context::default();
    let result = client.createPolicyConfiguration(clientExtId, policyConfigurationCreateDTO, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
Body parameters
Name Description
policyConfigurationCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

deletePolicyConfiguration

deletePolicyConfiguration
delete/core/v1/{clientExtId}/policies/{extId}

**Since:** 2.79.0 **Required permission(s):** `AccessControl.PolicyDelete` Deletes the policy with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/policies/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PolicyRESTServiceApi;

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

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

        // Create an instance of the API class
        PolicyRESTServiceApi apiInstance = new PolicyRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2001; // String | ExtID of the policy

        try {
            apiInstance.deletePolicyConfiguration(clientExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PolicyRESTServiceApi#deletePolicyConfiguration");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the policy

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

import org.openapitools.client.api.PolicyRESTServiceApi;

public class PolicyRESTServiceApiExample {
    public static void main(String[] args) {
        PolicyRESTServiceApi apiInstance = new PolicyRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2001; // String | ExtID of the policy

        try {
            apiInstance.deletePolicyConfiguration(clientExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PolicyRESTServiceApi#deletePolicyConfiguration");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PolicyRESTServiceApi *apiInstance = [[PolicyRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 2001; // ExtID of the policy (default to null)

// Delete policy configuration
[apiInstance deletePolicyConfigurationWith:clientExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PolicyRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 2001; // {String} ExtID of the policy

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deletePolicyConfiguration(clientExtId, extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deletePolicyConfigurationExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new PolicyRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 2001;  // String | ExtID of the policy (default to null)

            try {
                // Delete policy configuration
                apiInstance.deletePolicyConfiguration(clientExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling PolicyRESTServiceApi.deletePolicyConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PolicyRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 2001; // String | ExtID of the policy

try {
    $api_instance->deletePolicyConfiguration($clientExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling PolicyRESTServiceApi->deletePolicyConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PolicyRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PolicyRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 2001; # String | ExtID of the policy

eval {
    $api_instance->deletePolicyConfiguration(clientExtId => $clientExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling PolicyRESTServiceApi->deletePolicyConfiguration: $@\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.PolicyRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 2001 # String | ExtID of the policy (default to null)

try:
    # Delete policy configuration
    api_instance.delete_policy_configuration(clientExtId, extId)
except ApiException as e:
    print("Exception when calling PolicyRESTServiceApi->deletePolicyConfiguration: %s\n" % e)
extern crate PolicyRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 2001; // String

    let mut context = PolicyRESTServiceApi::Context::default();
    let result = client.deletePolicyConfiguration(clientExtId, extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the policy
Required

Responses


getPolicyConfiguration

getPolicyConfiguration
get/core/v1/{clientExtId}/policies/{extId}

**Since:** 2.79.0 **Required permission(s):** `AccessControl.PolicyView` Returns the policy with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/policies/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PolicyRESTServiceApi;

import java.io.File;
import java.util.*;

public class PolicyRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        PolicyRESTServiceApi apiInstance = new PolicyRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2001; // String | ExtID of the policy

        try {
            PolicyConfigurationGetDTO result = apiInstance.getPolicyConfiguration(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PolicyRESTServiceApi#getPolicyConfiguration");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the policy

try {
    final result = await api_instance.getPolicyConfiguration(clientExtId, extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPolicyConfiguration: $e\n');
}

import org.openapitools.client.api.PolicyRESTServiceApi;

public class PolicyRESTServiceApiExample {
    public static void main(String[] args) {
        PolicyRESTServiceApi apiInstance = new PolicyRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2001; // String | ExtID of the policy

        try {
            PolicyConfigurationGetDTO result = apiInstance.getPolicyConfiguration(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PolicyRESTServiceApi#getPolicyConfiguration");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PolicyRESTServiceApi *apiInstance = [[PolicyRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 2001; // ExtID of the policy (default to null)

// Get policy configuration
[apiInstance getPolicyConfigurationWith:clientExtId
    extId:extId
              completionHandler: ^(PolicyConfigurationGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PolicyRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 2001; // {String} ExtID of the policy

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPolicyConfiguration(clientExtId, extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getPolicyConfigurationExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new PolicyRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 2001;  // String | ExtID of the policy (default to null)

            try {
                // Get policy configuration
                PolicyConfigurationGetDTO result = apiInstance.getPolicyConfiguration(clientExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PolicyRESTServiceApi.getPolicyConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PolicyRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 2001; // String | ExtID of the policy

try {
    $result = $api_instance->getPolicyConfiguration($clientExtId, $extId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PolicyRESTServiceApi->getPolicyConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PolicyRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PolicyRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 2001; # String | ExtID of the policy

eval {
    my $result = $api_instance->getPolicyConfiguration(clientExtId => $clientExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PolicyRESTServiceApi->getPolicyConfiguration: $@\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.PolicyRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 2001 # String | ExtID of the policy (default to null)

try:
    # Get policy configuration
    api_response = api_instance.get_policy_configuration(clientExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PolicyRESTServiceApi->getPolicyConfiguration: %s\n" % e)
extern crate PolicyRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 2001; // String

    let mut context = PolicyRESTServiceApi::Context::default();
    let result = client.getPolicyConfiguration(clientExtId, extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the policy
Required

Responses


patchPolicyConfiguration

patchPolicyConfiguration
patch/core/v1/{clientExtId}/policies/{extId}

**Since:** 2.79.0 **Required permission(s):** `AccessControl.PolicyView,AccessControl.PolicyModify` Updates the policy with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/policies/{extId}" \
 -d '{
  "defaultPolicy" : true,
  "name" : "Customized Password Policy",
  "description" : "description",
  "parameters" : {
    "minLength" : "8",
    "maxLength" : "64"
  },
  "version" : 1
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PolicyRESTServiceApi;

import java.io.File;
import java.util.*;

public class PolicyRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        PolicyRESTServiceApi apiInstance = new PolicyRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2001; // String | ExtID of the policy
        PolicyConfigurationPatchDTO policyConfigurationPatchDTO = ; // PolicyConfigurationPatchDTO | 

        try {
            PolicyConfigurationGetDTO result = apiInstance.patchPolicyConfiguration(clientExtId, extId, policyConfigurationPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PolicyRESTServiceApi#patchPolicyConfiguration");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the policy
final PolicyConfigurationPatchDTO policyConfigurationPatchDTO = new PolicyConfigurationPatchDTO(); // PolicyConfigurationPatchDTO | 

try {
    final result = await api_instance.patchPolicyConfiguration(clientExtId, extId, policyConfigurationPatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchPolicyConfiguration: $e\n');
}

import org.openapitools.client.api.PolicyRESTServiceApi;

public class PolicyRESTServiceApiExample {
    public static void main(String[] args) {
        PolicyRESTServiceApi apiInstance = new PolicyRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 2001; // String | ExtID of the policy
        PolicyConfigurationPatchDTO policyConfigurationPatchDTO = ; // PolicyConfigurationPatchDTO | 

        try {
            PolicyConfigurationGetDTO result = apiInstance.patchPolicyConfiguration(clientExtId, extId, policyConfigurationPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PolicyRESTServiceApi#patchPolicyConfiguration");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PolicyRESTServiceApi *apiInstance = [[PolicyRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 2001; // ExtID of the policy (default to null)
PolicyConfigurationPatchDTO *policyConfigurationPatchDTO = ; // 

// Update policy configuration
[apiInstance patchPolicyConfigurationWith:clientExtId
    extId:extId
    policyConfigurationPatchDTO:policyConfigurationPatchDTO
              completionHandler: ^(PolicyConfigurationGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PolicyRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 2001; // {String} ExtID of the policy
var policyConfigurationPatchDTO = ; // {PolicyConfigurationPatchDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchPolicyConfiguration(clientExtId, extId, policyConfigurationPatchDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class patchPolicyConfigurationExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new PolicyRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 2001;  // String | ExtID of the policy (default to null)
            var policyConfigurationPatchDTO = new PolicyConfigurationPatchDTO(); // PolicyConfigurationPatchDTO | 

            try {
                // Update policy configuration
                PolicyConfigurationGetDTO result = apiInstance.patchPolicyConfiguration(clientExtId, extId, policyConfigurationPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PolicyRESTServiceApi.patchPolicyConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PolicyRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 2001; // String | ExtID of the policy
$policyConfigurationPatchDTO = ; // PolicyConfigurationPatchDTO | 

try {
    $result = $api_instance->patchPolicyConfiguration($clientExtId, $extId, $policyConfigurationPatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PolicyRESTServiceApi->patchPolicyConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PolicyRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PolicyRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 2001; # String | ExtID of the policy
my $policyConfigurationPatchDTO = WWW::OPenAPIClient::Object::PolicyConfigurationPatchDTO->new(); # PolicyConfigurationPatchDTO | 

eval {
    my $result = $api_instance->patchPolicyConfiguration(clientExtId => $clientExtId, extId => $extId, policyConfigurationPatchDTO => $policyConfigurationPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PolicyRESTServiceApi->patchPolicyConfiguration: $@\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.PolicyRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 2001 # String | ExtID of the policy (default to null)
policyConfigurationPatchDTO =  # PolicyConfigurationPatchDTO | 

try:
    # Update policy configuration
    api_response = api_instance.patch_policy_configuration(clientExtId, extId, policyConfigurationPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PolicyRESTServiceApi->patchPolicyConfiguration: %s\n" % e)
extern crate PolicyRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 2001; // String
    let policyConfigurationPatchDTO = ; // PolicyConfigurationPatchDTO

    let mut context = PolicyRESTServiceApi::Context::default();
    let result = client.patchPolicyConfiguration(clientExtId, extId, policyConfigurationPatchDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the policy
Required
Body parameters
Name Description
policyConfigurationPatchDTO *

Responses


PrincipalRESTService

generateBearerToken

generateBearerToken
post/principal/v1/token

**Required permission(s):** ``SelfAdmin` Role Generates a bearer token., to use it add it to X-Token header of the request.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/principal/v1/token" \
 -d '{
  "password" : "secret",
  "grant_type" : "password",
  "username" : "homersimpson"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PrincipalRESTServiceApi;

import java.io.File;
import java.util.*;

public class PrincipalRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        PrincipalRESTServiceApi apiInstance = new PrincipalRESTServiceApi();
        GrantDTO grantDTO = {"grant_type":"password","username":"exampleUser","password":"secret"}; // GrantDTO | 

        try {
            TokenDTO result = apiInstance.generateBearerToken(grantDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PrincipalRESTServiceApi#generateBearerToken");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GrantDTO grantDTO = new GrantDTO(); // GrantDTO | 

try {
    final result = await api_instance.generateBearerToken(grantDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateBearerToken: $e\n');
}

import org.openapitools.client.api.PrincipalRESTServiceApi;

public class PrincipalRESTServiceApiExample {
    public static void main(String[] args) {
        PrincipalRESTServiceApi apiInstance = new PrincipalRESTServiceApi();
        GrantDTO grantDTO = {"grant_type":"password","username":"exampleUser","password":"secret"}; // GrantDTO | 

        try {
            TokenDTO result = apiInstance.generateBearerToken(grantDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PrincipalRESTServiceApi#generateBearerToken");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PrincipalRESTServiceApi *apiInstance = [[PrincipalRESTServiceApi alloc] init];
GrantDTO *grantDTO = {"grant_type":"password","username":"exampleUser","password":"secret"}; // 

// Get token
[apiInstance generateBearerTokenWith:grantDTO
              completionHandler: ^(TokenDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PrincipalRESTServiceApi()
var grantDTO = {"grant_type":"password","username":"exampleUser","password":"secret"}; // {GrantDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateBearerToken(grantDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class generateBearerTokenExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new PrincipalRESTServiceApi();
            var grantDTO = new GrantDTO(); // GrantDTO | 

            try {
                // Get token
                TokenDTO result = apiInstance.generateBearerToken(grantDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PrincipalRESTServiceApi.generateBearerToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PrincipalRESTServiceApi();
$grantDTO = {"grant_type":"password","username":"exampleUser","password":"secret"}; // GrantDTO | 

try {
    $result = $api_instance->generateBearerToken($grantDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PrincipalRESTServiceApi->generateBearerToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PrincipalRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PrincipalRESTServiceApi->new();
my $grantDTO = WWW::OPenAPIClient::Object::GrantDTO->new(); # GrantDTO | 

eval {
    my $result = $api_instance->generateBearerToken(grantDTO => $grantDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PrincipalRESTServiceApi->generateBearerToken: $@\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.PrincipalRESTServiceApi()
grantDTO = {"grant_type":"password","username":"exampleUser","password":"secret"} # GrantDTO | 

try:
    # Get token
    api_response = api_instance.generate_bearer_token(grantDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PrincipalRESTServiceApi->generateBearerToken: %s\n" % e)
extern crate PrincipalRESTServiceApi;

pub fn main() {
    let grantDTO = {"grant_type":"password","username":"exampleUser","password":"secret"}; // GrantDTO

    let mut context = PrincipalRESTServiceApi::Context::default();
    let result = client.generateBearerToken(grantDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
grantDTO *

Responses

Name Type Format Description
Cache-Control String no-store
Pragma String no-cache

getCallerUserInfo

getCallerUserInfo
get/principal/v1/me

**Required permission(s):** ``SelfAdmin` Role Returns information about the actual user. Used to display basic information about the user without having to query many different resources.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/principal/v1/me"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PrincipalRESTServiceApi;

import java.io.File;
import java.util.*;

public class PrincipalRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        PrincipalRESTServiceApi apiInstance = new PrincipalRESTServiceApi();

        try {
            PrincipalDTO result = apiInstance.getCallerUserInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PrincipalRESTServiceApi#getCallerUserInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getCallerUserInfo();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCallerUserInfo: $e\n');
}

import org.openapitools.client.api.PrincipalRESTServiceApi;

public class PrincipalRESTServiceApiExample {
    public static void main(String[] args) {
        PrincipalRESTServiceApi apiInstance = new PrincipalRESTServiceApi();

        try {
            PrincipalDTO result = apiInstance.getCallerUserInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PrincipalRESTServiceApi#getCallerUserInfo");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PrincipalRESTServiceApi *apiInstance = [[PrincipalRESTServiceApi alloc] init];

// Get my info
[apiInstance getCallerUserInfoWithCompletionHandler: 
              ^(PrincipalDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PrincipalRESTServiceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCallerUserInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCallerUserInfoExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new PrincipalRESTServiceApi();

            try {
                // Get my info
                PrincipalDTO result = apiInstance.getCallerUserInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PrincipalRESTServiceApi.getCallerUserInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PrincipalRESTServiceApi();

try {
    $result = $api_instance->getCallerUserInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PrincipalRESTServiceApi->getCallerUserInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PrincipalRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PrincipalRESTServiceApi->new();

eval {
    my $result = $api_instance->getCallerUserInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PrincipalRESTServiceApi->getCallerUserInfo: $@\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.PrincipalRESTServiceApi()

try:
    # Get my info
    api_response = api_instance.get_caller_user_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PrincipalRESTServiceApi->getCallerUserInfo: %s\n" % e)
extern crate PrincipalRESTServiceApi;

pub fn main() {

    let mut context = PrincipalRESTServiceApi::Context::default();
    let result = client.getCallerUserInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getCallerUserPermissions

getCallerUserPermissions
get/principal/v1/permissions

**Since:** 2.80.0 Returns the elementary permissions of the user.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/principal/v1/permissions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PrincipalRESTServiceApi;

import java.io.File;
import java.util.*;

public class PrincipalRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        PrincipalRESTServiceApi apiInstance = new PrincipalRESTServiceApi();

        try {
            PermissionGetDTO result = apiInstance.getCallerUserPermissions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PrincipalRESTServiceApi#getCallerUserPermissions");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getCallerUserPermissions();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCallerUserPermissions: $e\n');
}

import org.openapitools.client.api.PrincipalRESTServiceApi;

public class PrincipalRESTServiceApiExample {
    public static void main(String[] args) {
        PrincipalRESTServiceApi apiInstance = new PrincipalRESTServiceApi();

        try {
            PermissionGetDTO result = apiInstance.getCallerUserPermissions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PrincipalRESTServiceApi#getCallerUserPermissions");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PrincipalRESTServiceApi *apiInstance = [[PrincipalRESTServiceApi alloc] init];

// Get my permissions
[apiInstance getCallerUserPermissionsWithCompletionHandler: 
              ^(PermissionGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.PrincipalRESTServiceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCallerUserPermissions(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCallerUserPermissionsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new PrincipalRESTServiceApi();

            try {
                // Get my permissions
                PermissionGetDTO result = apiInstance.getCallerUserPermissions();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PrincipalRESTServiceApi.getCallerUserPermissions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PrincipalRESTServiceApi();

try {
    $result = $api_instance->getCallerUserPermissions();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PrincipalRESTServiceApi->getCallerUserPermissions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PrincipalRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PrincipalRESTServiceApi->new();

eval {
    my $result = $api_instance->getCallerUserPermissions();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PrincipalRESTServiceApi->getCallerUserPermissions: $@\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.PrincipalRESTServiceApi()

try:
    # Get my permissions
    api_response = api_instance.get_caller_user_permissions()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PrincipalRESTServiceApi->getCallerUserPermissions: %s\n" % e)
extern crate PrincipalRESTServiceApi;

pub fn main() {

    let mut context = PrincipalRESTServiceApi::Context::default();
    let result = client.getCallerUserPermissions(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


ProfileRESTService

changeUnitOfProfile

changeUnitOfProfile
put/core/v1/{clientExtId}/profiles/{extId}/unit/{unitExtId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.ProfileModify` Changes the unit of the profile with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X PUT \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{extId}/unit/{unitExtId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfileRESTServiceApi;

import java.io.File;
import java.util.*;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile
        String unitExtId = 2001; // String | ExtID of the new unit

        try {
            apiInstance.changeUnitOfProfile(clientExtId, extId, unitExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#changeUnitOfProfile");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the profile
final String unitExtId = new String(); // String | ExtID of the new unit

try {
    final result = await api_instance.changeUnitOfProfile(clientExtId, extId, unitExtId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->changeUnitOfProfile: $e\n');
}

import org.openapitools.client.api.ProfileRESTServiceApi;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile
        String unitExtId = 2001; // String | ExtID of the new unit

        try {
            apiInstance.changeUnitOfProfile(clientExtId, extId, unitExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#changeUnitOfProfile");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfileRESTServiceApi *apiInstance = [[ProfileRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1001; // ExtID of the profile (default to null)
String *unitExtId = 2001; // ExtID of the new unit (default to null)

// Change unit of profile
[apiInstance changeUnitOfProfileWith:clientExtId
    extId:extId
    unitExtId:unitExtId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ProfileRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1001; // {String} ExtID of the profile
var unitExtId = 2001; // {String} ExtID of the new unit

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.changeUnitOfProfile(clientExtId, extId, unitExtId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class changeUnitOfProfileExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProfileRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1001;  // String | ExtID of the profile (default to null)
            var unitExtId = 2001;  // String | ExtID of the new unit (default to null)

            try {
                // Change unit of profile
                apiInstance.changeUnitOfProfile(clientExtId, extId, unitExtId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfileRESTServiceApi.changeUnitOfProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfileRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1001; // String | ExtID of the profile
$unitExtId = 2001; // String | ExtID of the new unit

try {
    $api_instance->changeUnitOfProfile($clientExtId, $extId, $unitExtId);
} catch (Exception $e) {
    echo 'Exception when calling ProfileRESTServiceApi->changeUnitOfProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfileRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfileRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1001; # String | ExtID of the profile
my $unitExtId = 2001; # String | ExtID of the new unit

eval {
    $api_instance->changeUnitOfProfile(clientExtId => $clientExtId, extId => $extId, unitExtId => $unitExtId);
};
if ($@) {
    warn "Exception when calling ProfileRESTServiceApi->changeUnitOfProfile: $@\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.ProfileRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1001 # String | ExtID of the profile (default to null)
unitExtId = 2001 # String | ExtID of the new unit (default to null)

try:
    # Change unit of profile
    api_instance.change_unit_of_profile(clientExtId, extId, unitExtId)
except ApiException as e:
    print("Exception when calling ProfileRESTServiceApi->changeUnitOfProfile: %s\n" % e)
extern crate ProfileRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1001; // String
    let unitExtId = 2001; // String

    let mut context = ProfileRESTServiceApi::Context::default();
    let result = client.changeUnitOfProfile(clientExtId, extId, unitExtId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the profile
Required
unitExtId*
String
ExtID of the new unit
Required

Responses


createEnterpriseAuthorizations

createEnterpriseAuthorizations
post/core/v1/{clientExtId}/profiles/{profileExtId}/eauthorizations

**Since:** 2.75.2, 2.76.0 **Required permission(s):** `AccessControl.ProfileModify` Creates a new enterprise authorization for the profile with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{profileExtId}/eauthorizations" \
 -d '{
  "enterpriseRoleExtId" : "enterpriseRoleExtId",
  "extId" : "extId",
  "validity" : {
    "from" : "2023-01-01T00:00:00Z",
    "to" : "2033-12-31T23:59:59Z"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfileRESTServiceApi;

import java.io.File;
import java.util.*;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String profileExtId = 1001; // String | ExtID of the profile
        EnterpriseAuthorizationCreateDTO enterpriseAuthorizationCreateDTO = {
  "extId": "1020",
  "enterpriseRoleExtId": "1002",
  "validity": {
    "from":"2016-12-31T12:00:00Z",
    "to":"2022-01-01T12:00:00Z"
   },
}; // EnterpriseAuthorizationCreateDTO | 

        try {
            apiInstance.createEnterpriseAuthorizations(clientExtId, profileExtId, enterpriseAuthorizationCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#createEnterpriseAuthorizations");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String profileExtId = new String(); // String | ExtID of the profile
final EnterpriseAuthorizationCreateDTO enterpriseAuthorizationCreateDTO = new EnterpriseAuthorizationCreateDTO(); // EnterpriseAuthorizationCreateDTO | 

try {
    final result = await api_instance.createEnterpriseAuthorizations(clientExtId, profileExtId, enterpriseAuthorizationCreateDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createEnterpriseAuthorizations: $e\n');
}

import org.openapitools.client.api.ProfileRESTServiceApi;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String profileExtId = 1001; // String | ExtID of the profile
        EnterpriseAuthorizationCreateDTO enterpriseAuthorizationCreateDTO = {
  "extId": "1020",
  "enterpriseRoleExtId": "1002",
  "validity": {
    "from":"2016-12-31T12:00:00Z",
    "to":"2022-01-01T12:00:00Z"
   },
}; // EnterpriseAuthorizationCreateDTO | 

        try {
            apiInstance.createEnterpriseAuthorizations(clientExtId, profileExtId, enterpriseAuthorizationCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#createEnterpriseAuthorizations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfileRESTServiceApi *apiInstance = [[ProfileRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *profileExtId = 1001; // ExtID of the profile (default to null)
EnterpriseAuthorizationCreateDTO *enterpriseAuthorizationCreateDTO = {
  "extId": "1020",
  "enterpriseRoleExtId": "1002",
  "validity": {
    "from":"2016-12-31T12:00:00Z",
    "to":"2022-01-01T12:00:00Z"
   },
}; // 

// Create enterprise authorization for profile
[apiInstance createEnterpriseAuthorizationsWith:clientExtId
    profileExtId:profileExtId
    enterpriseAuthorizationCreateDTO:enterpriseAuthorizationCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ProfileRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var profileExtId = 1001; // {String} ExtID of the profile
var enterpriseAuthorizationCreateDTO = {
  "extId": "1020",
  "enterpriseRoleExtId": "1002",
  "validity": {
    "from":"2016-12-31T12:00:00Z",
    "to":"2022-01-01T12:00:00Z"
   },
}; // {EnterpriseAuthorizationCreateDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createEnterpriseAuthorizations(clientExtId, profileExtId, enterpriseAuthorizationCreateDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createEnterpriseAuthorizationsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProfileRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var profileExtId = 1001;  // String | ExtID of the profile (default to null)
            var enterpriseAuthorizationCreateDTO = new EnterpriseAuthorizationCreateDTO(); // EnterpriseAuthorizationCreateDTO | 

            try {
                // Create enterprise authorization for profile
                apiInstance.createEnterpriseAuthorizations(clientExtId, profileExtId, enterpriseAuthorizationCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfileRESTServiceApi.createEnterpriseAuthorizations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfileRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$profileExtId = 1001; // String | ExtID of the profile
$enterpriseAuthorizationCreateDTO = {
  "extId": "1020",
  "enterpriseRoleExtId": "1002",
  "validity": {
    "from":"2016-12-31T12:00:00Z",
    "to":"2022-01-01T12:00:00Z"
   },
}; // EnterpriseAuthorizationCreateDTO | 

try {
    $api_instance->createEnterpriseAuthorizations($clientExtId, $profileExtId, $enterpriseAuthorizationCreateDTO);
} catch (Exception $e) {
    echo 'Exception when calling ProfileRESTServiceApi->createEnterpriseAuthorizations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfileRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfileRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $profileExtId = 1001; # String | ExtID of the profile
my $enterpriseAuthorizationCreateDTO = WWW::OPenAPIClient::Object::EnterpriseAuthorizationCreateDTO->new(); # EnterpriseAuthorizationCreateDTO | 

eval {
    $api_instance->createEnterpriseAuthorizations(clientExtId => $clientExtId, profileExtId => $profileExtId, enterpriseAuthorizationCreateDTO => $enterpriseAuthorizationCreateDTO);
};
if ($@) {
    warn "Exception when calling ProfileRESTServiceApi->createEnterpriseAuthorizations: $@\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.ProfileRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
profileExtId = 1001 # String | ExtID of the profile (default to null)
enterpriseAuthorizationCreateDTO = {
  "extId": "1020",
  "enterpriseRoleExtId": "1002",
  "validity": {
    "from":"2016-12-31T12:00:00Z",
    "to":"2022-01-01T12:00:00Z"
   },
} # EnterpriseAuthorizationCreateDTO | 

try:
    # Create enterprise authorization for profile
    api_instance.create_enterprise_authorizations(clientExtId, profileExtId, enterpriseAuthorizationCreateDTO)
except ApiException as e:
    print("Exception when calling ProfileRESTServiceApi->createEnterpriseAuthorizations: %s\n" % e)
extern crate ProfileRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let profileExtId = 1001; // String
    let enterpriseAuthorizationCreateDTO = {
  "extId": "1020",
  "enterpriseRoleExtId": "1002",
  "validity": {
    "from":"2016-12-31T12:00:00Z",
    "to":"2022-01-01T12:00:00Z"
   },
}; // EnterpriseAuthorizationCreateDTO

    let mut context = ProfileRESTServiceApi::Context::default();
    let result = client.createEnterpriseAuthorizations(clientExtId, profileExtId, enterpriseAuthorizationCreateDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
profileExtId*
String
ExtID of the profile
Required
Body parameters
Name Description
enterpriseAuthorizationCreateDTO *

Responses


deleteEnterpriseAuthorization

deleteEnterpriseAuthorization
delete/core/v1/{clientExtId}/profiles/{profileExtId}/eauthorizations/{extId}

**Since:** 2.75.2, 2.76.0

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{profileExtId}/eauthorizations/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfileRESTServiceApi;

import java.io.File;
import java.util.*;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = clientExtId_example; // String | 
        String profileExtId = profileExtId_example; // String | 
        String extId = extId_example; // String | 

        try {
            apiInstance.deleteEnterpriseAuthorization(clientExtId, profileExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#deleteEnterpriseAuthorization");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | 
final String profileExtId = new String(); // String | 
final String extId = new String(); // String | 

try {
    final result = await api_instance.deleteEnterpriseAuthorization(clientExtId, profileExtId, extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteEnterpriseAuthorization: $e\n');
}

import org.openapitools.client.api.ProfileRESTServiceApi;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = clientExtId_example; // String | 
        String profileExtId = profileExtId_example; // String | 
        String extId = extId_example; // String | 

        try {
            apiInstance.deleteEnterpriseAuthorization(clientExtId, profileExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#deleteEnterpriseAuthorization");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfileRESTServiceApi *apiInstance = [[ProfileRESTServiceApi alloc] init];
String *clientExtId = clientExtId_example; //  (default to null)
String *profileExtId = profileExtId_example; //  (default to null)
String *extId = extId_example; //  (default to null)

[apiInstance deleteEnterpriseAuthorizationWith:clientExtId
    profileExtId:profileExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ProfileRESTServiceApi()
var clientExtId = clientExtId_example; // {String} 
var profileExtId = profileExtId_example; // {String} 
var extId = extId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteEnterpriseAuthorization(clientExtId, profileExtId, extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteEnterpriseAuthorizationExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProfileRESTServiceApi();
            var clientExtId = clientExtId_example;  // String |  (default to null)
            var profileExtId = profileExtId_example;  // String |  (default to null)
            var extId = extId_example;  // String |  (default to null)

            try {
                apiInstance.deleteEnterpriseAuthorization(clientExtId, profileExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfileRESTServiceApi.deleteEnterpriseAuthorization: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfileRESTServiceApi();
$clientExtId = clientExtId_example; // String | 
$profileExtId = profileExtId_example; // String | 
$extId = extId_example; // String | 

try {
    $api_instance->deleteEnterpriseAuthorization($clientExtId, $profileExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling ProfileRESTServiceApi->deleteEnterpriseAuthorization: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfileRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfileRESTServiceApi->new();
my $clientExtId = clientExtId_example; # String | 
my $profileExtId = profileExtId_example; # String | 
my $extId = extId_example; # String | 

eval {
    $api_instance->deleteEnterpriseAuthorization(clientExtId => $clientExtId, profileExtId => $profileExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling ProfileRESTServiceApi->deleteEnterpriseAuthorization: $@\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.ProfileRESTServiceApi()
clientExtId = clientExtId_example # String |  (default to null)
profileExtId = profileExtId_example # String |  (default to null)
extId = extId_example # String |  (default to null)

try:
    api_instance.delete_enterprise_authorization(clientExtId, profileExtId, extId)
except ApiException as e:
    print("Exception when calling ProfileRESTServiceApi->deleteEnterpriseAuthorization: %s\n" % e)
extern crate ProfileRESTServiceApi;

pub fn main() {
    let clientExtId = clientExtId_example; // String
    let profileExtId = profileExtId_example; // String
    let extId = extId_example; // String

    let mut context = ProfileRESTServiceApi::Context::default();
    let result = client.deleteEnterpriseAuthorization(clientExtId, profileExtId, extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
Required
profileExtId*
String
Required
extId*
String
Required

Responses


deleteProfile

deleteProfile
delete/core/v1/{clientExtId}/profiles/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.ProfileDelete` Deletes the profile with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfileRESTServiceApi;

import java.io.File;
import java.util.*;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile

        try {
            apiInstance.deleteProfile(clientExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#deleteProfile");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the profile

try {
    final result = await api_instance.deleteProfile(clientExtId, extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteProfile: $e\n');
}

import org.openapitools.client.api.ProfileRESTServiceApi;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile

        try {
            apiInstance.deleteProfile(clientExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#deleteProfile");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfileRESTServiceApi *apiInstance = [[ProfileRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1001; // ExtID of the profile (default to null)

// Delete profile
[apiInstance deleteProfileWith:clientExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ProfileRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1001; // {String} ExtID of the profile

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteProfile(clientExtId, extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteProfileExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProfileRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1001;  // String | ExtID of the profile (default to null)

            try {
                // Delete profile
                apiInstance.deleteProfile(clientExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfileRESTServiceApi.deleteProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfileRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1001; // String | ExtID of the profile

try {
    $api_instance->deleteProfile($clientExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling ProfileRESTServiceApi->deleteProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfileRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfileRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1001; # String | ExtID of the profile

eval {
    $api_instance->deleteProfile(clientExtId => $clientExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling ProfileRESTServiceApi->deleteProfile: $@\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.ProfileRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1001 # String | ExtID of the profile (default to null)

try:
    # Delete profile
    api_instance.delete_profile(clientExtId, extId)
except ApiException as e:
    print("Exception when calling ProfileRESTServiceApi->deleteProfile: %s\n" % e)
extern crate ProfileRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1001; // String

    let mut context = ProfileRESTServiceApi::Context::default();
    let result = client.deleteProfile(clientExtId, extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the profile
Required

Responses


getAllEnterpriseAuthorizationsOfProfile

getAllEnterpriseAuthorizationsOfProfile
get/core/v1/{clientExtId}/profiles/{extId}/eauthorizations

**Since:** 2.75.2, 2.76.0 **Required permission(s):** `AccessControl.ProfileView` or `SelfAdmin` Role Returns all enterprise authorizations assigned to the profile with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{extId}/eauthorizations?continuationToken=2023-01-01_1002&limit=10"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfileRESTServiceApi;

import java.io.File;
import java.util.*;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile
        String continuationToken = 2023-01-01_1002; // String | Continuation token for paging
        Integer limit = 10; // Integer | Maximum number of results

        try {
            ItemsWrapperDTO result = apiInstance.getAllEnterpriseAuthorizationsOfProfile(clientExtId, extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#getAllEnterpriseAuthorizationsOfProfile");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the profile
final String continuationToken = new String(); // String | Continuation token for paging
final Integer limit = new Integer(); // Integer | Maximum number of results

try {
    final result = await api_instance.getAllEnterpriseAuthorizationsOfProfile(clientExtId, extId, continuationToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllEnterpriseAuthorizationsOfProfile: $e\n');
}

import org.openapitools.client.api.ProfileRESTServiceApi;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile
        String continuationToken = 2023-01-01_1002; // String | Continuation token for paging
        Integer limit = 10; // Integer | Maximum number of results

        try {
            ItemsWrapperDTO result = apiInstance.getAllEnterpriseAuthorizationsOfProfile(clientExtId, extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#getAllEnterpriseAuthorizationsOfProfile");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfileRESTServiceApi *apiInstance = [[ProfileRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1001; // ExtID of the profile (default to null)
String *continuationToken = 2023-01-01_1002; // Continuation token for paging (optional) (default to )
Integer *limit = 10; // Maximum number of results (optional) (default to 0)

// Get all enterprise authorizations of a profile
[apiInstance getAllEnterpriseAuthorizationsOfProfileWith:clientExtId
    extId:extId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ProfileRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1001; // {String} ExtID of the profile
var opts = {
  'continuationToken': 2023-01-01_1002, // {String} Continuation token for paging
  'limit': 10 // {Integer} Maximum number of results
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllEnterpriseAuthorizationsOfProfile(clientExtId, extId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAllEnterpriseAuthorizationsOfProfileExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProfileRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1001;  // String | ExtID of the profile (default to null)
            var continuationToken = 2023-01-01_1002;  // String | Continuation token for paging (optional)  (default to )
            var limit = 10;  // Integer | Maximum number of results (optional)  (default to 0)

            try {
                // Get all enterprise authorizations of a profile
                ItemsWrapperDTO result = apiInstance.getAllEnterpriseAuthorizationsOfProfile(clientExtId, extId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfileRESTServiceApi.getAllEnterpriseAuthorizationsOfProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfileRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1001; // String | ExtID of the profile
$continuationToken = 2023-01-01_1002; // String | Continuation token for paging
$limit = 10; // Integer | Maximum number of results

try {
    $result = $api_instance->getAllEnterpriseAuthorizationsOfProfile($clientExtId, $extId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfileRESTServiceApi->getAllEnterpriseAuthorizationsOfProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfileRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfileRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1001; # String | ExtID of the profile
my $continuationToken = 2023-01-01_1002; # String | Continuation token for paging
my $limit = 10; # Integer | Maximum number of results

eval {
    my $result = $api_instance->getAllEnterpriseAuthorizationsOfProfile(clientExtId => $clientExtId, extId => $extId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfileRESTServiceApi->getAllEnterpriseAuthorizationsOfProfile: $@\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.ProfileRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1001 # String | ExtID of the profile (default to null)
continuationToken = 2023-01-01_1002 # String | Continuation token for paging (optional) (default to )
limit = 10 # Integer | Maximum number of results (optional) (default to 0)

try:
    # Get all enterprise authorizations of a profile
    api_response = api_instance.get_all_enterprise_authorizations_of_profile(clientExtId, extId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfileRESTServiceApi->getAllEnterpriseAuthorizationsOfProfile: %s\n" % e)
extern crate ProfileRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1001; // String
    let continuationToken = 2023-01-01_1002; // String
    let limit = 10; // Integer

    let mut context = ProfileRESTServiceApi::Context::default();
    let result = client.getAllEnterpriseAuthorizationsOfProfile(clientExtId, extId, continuationToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the profile
Required
Query parameters
Name Description
continuationToken
String
Continuation token for paging
limit
Integer (int32)
Maximum number of results

Responses


getAllRolesOfProfile

getAllRolesOfProfile
get/core/v1/{clientExtId}/profiles/{extId}/roles

**Since:** 2.71.0 **Required permission(s):** `AccessControl.ProfileView` or `SelfAdmin` Role Returns all roles assigned to the profile with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{extId}/roles?continuationToken=2023-01-01_1002&limit=10"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfileRESTServiceApi;

import java.io.File;
import java.util.*;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile
        String continuationToken = 2023-01-01_1002; // String | Continuation token for paging
        Integer limit = 10; // Integer | Maximum number of results

        try {
            ItemsWrapperDTO result = apiInstance.getAllRolesOfProfile(clientExtId, extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#getAllRolesOfProfile");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the profile
final String continuationToken = new String(); // String | Continuation token for paging
final Integer limit = new Integer(); // Integer | Maximum number of results

try {
    final result = await api_instance.getAllRolesOfProfile(clientExtId, extId, continuationToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllRolesOfProfile: $e\n');
}

import org.openapitools.client.api.ProfileRESTServiceApi;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile
        String continuationToken = 2023-01-01_1002; // String | Continuation token for paging
        Integer limit = 10; // Integer | Maximum number of results

        try {
            ItemsWrapperDTO result = apiInstance.getAllRolesOfProfile(clientExtId, extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#getAllRolesOfProfile");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfileRESTServiceApi *apiInstance = [[ProfileRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1001; // ExtID of the profile (default to null)
String *continuationToken = 2023-01-01_1002; // Continuation token for paging (optional) (default to )
Integer *limit = 10; // Maximum number of results (optional) (default to 0)

// Get all roles of a profile
[apiInstance getAllRolesOfProfileWith:clientExtId
    extId:extId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ProfileRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1001; // {String} ExtID of the profile
var opts = {
  'continuationToken': 2023-01-01_1002, // {String} Continuation token for paging
  'limit': 10 // {Integer} Maximum number of results
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllRolesOfProfile(clientExtId, extId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAllRolesOfProfileExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProfileRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1001;  // String | ExtID of the profile (default to null)
            var continuationToken = 2023-01-01_1002;  // String | Continuation token for paging (optional)  (default to )
            var limit = 10;  // Integer | Maximum number of results (optional)  (default to 0)

            try {
                // Get all roles of a profile
                ItemsWrapperDTO result = apiInstance.getAllRolesOfProfile(clientExtId, extId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfileRESTServiceApi.getAllRolesOfProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfileRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1001; // String | ExtID of the profile
$continuationToken = 2023-01-01_1002; // String | Continuation token for paging
$limit = 10; // Integer | Maximum number of results

try {
    $result = $api_instance->getAllRolesOfProfile($clientExtId, $extId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfileRESTServiceApi->getAllRolesOfProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfileRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfileRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1001; # String | ExtID of the profile
my $continuationToken = 2023-01-01_1002; # String | Continuation token for paging
my $limit = 10; # Integer | Maximum number of results

eval {
    my $result = $api_instance->getAllRolesOfProfile(clientExtId => $clientExtId, extId => $extId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfileRESTServiceApi->getAllRolesOfProfile: $@\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.ProfileRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1001 # String | ExtID of the profile (default to null)
continuationToken = 2023-01-01_1002 # String | Continuation token for paging (optional) (default to )
limit = 10 # Integer | Maximum number of results (optional) (default to 0)

try:
    # Get all roles of a profile
    api_response = api_instance.get_all_roles_of_profile(clientExtId, extId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfileRESTServiceApi->getAllRolesOfProfile: %s\n" % e)
extern crate ProfileRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1001; // String
    let continuationToken = 2023-01-01_1002; // String
    let limit = 10; // Integer

    let mut context = ProfileRESTServiceApi::Context::default();
    let result = client.getAllRolesOfProfile(clientExtId, extId, continuationToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the profile
Required
Query parameters
Name Description
continuationToken
String
Continuation token for paging
limit
Integer (int32)
Maximum number of results

Responses


getApplications

getApplications
get/core/v1/{clientExtId}/profiles/{extId}/applications

**Since:** 2.71.0 **Required permission(s):** `AccessControl.ProfileView` or `SelfAdmin` Role Returns all applications assigned to the profile with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{extId}/applications?continuationToken=2023-01-01_1002&limit=10"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfileRESTServiceApi;

import java.io.File;
import java.util.*;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile
        String continuationToken = 2023-01-01_1002; // String | Continuation token for paging
        Integer limit = 10; // Integer | Maximum number of results

        try {
            ItemsWrapperDTO result = apiInstance.getApplications(clientExtId, extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#getApplications");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the profile
final String continuationToken = new String(); // String | Continuation token for paging
final Integer limit = new Integer(); // Integer | Maximum number of results

try {
    final result = await api_instance.getApplications(clientExtId, extId, continuationToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getApplications: $e\n');
}

import org.openapitools.client.api.ProfileRESTServiceApi;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile
        String continuationToken = 2023-01-01_1002; // String | Continuation token for paging
        Integer limit = 10; // Integer | Maximum number of results

        try {
            ItemsWrapperDTO result = apiInstance.getApplications(clientExtId, extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#getApplications");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfileRESTServiceApi *apiInstance = [[ProfileRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1001; // ExtID of the profile (default to null)
String *continuationToken = 2023-01-01_1002; // Continuation token for paging (optional) (default to )
Integer *limit = 10; // Maximum number of results (optional) (default to 0)

// Get all applications of a profile
[apiInstance getApplicationsWith:clientExtId
    extId:extId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ProfileRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1001; // {String} ExtID of the profile
var opts = {
  'continuationToken': 2023-01-01_1002, // {String} Continuation token for paging
  'limit': 10 // {Integer} Maximum number of results
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApplications(clientExtId, extId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getApplicationsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProfileRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1001;  // String | ExtID of the profile (default to null)
            var continuationToken = 2023-01-01_1002;  // String | Continuation token for paging (optional)  (default to )
            var limit = 10;  // Integer | Maximum number of results (optional)  (default to 0)

            try {
                // Get all applications of a profile
                ItemsWrapperDTO result = apiInstance.getApplications(clientExtId, extId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfileRESTServiceApi.getApplications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfileRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1001; // String | ExtID of the profile
$continuationToken = 2023-01-01_1002; // String | Continuation token for paging
$limit = 10; // Integer | Maximum number of results

try {
    $result = $api_instance->getApplications($clientExtId, $extId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfileRESTServiceApi->getApplications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfileRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfileRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1001; # String | ExtID of the profile
my $continuationToken = 2023-01-01_1002; # String | Continuation token for paging
my $limit = 10; # Integer | Maximum number of results

eval {
    my $result = $api_instance->getApplications(clientExtId => $clientExtId, extId => $extId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfileRESTServiceApi->getApplications: $@\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.ProfileRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1001 # String | ExtID of the profile (default to null)
continuationToken = 2023-01-01_1002 # String | Continuation token for paging (optional) (default to )
limit = 10 # Integer | Maximum number of results (optional) (default to 0)

try:
    # Get all applications of a profile
    api_response = api_instance.get_applications(clientExtId, extId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfileRESTServiceApi->getApplications: %s\n" % e)
extern crate ProfileRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1001; // String
    let continuationToken = 2023-01-01_1002; // String
    let limit = 10; // Integer

    let mut context = ProfileRESTServiceApi::Context::default();
    let result = client.getApplications(clientExtId, extId, continuationToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the profile
Required
Query parameters
Name Description
continuationToken
String
Continuation token for paging
limit
Integer (int32)
Maximum number of results

Responses


getEnterpriseAuthorizationOfProfile

getEnterpriseAuthorizationOfProfile
get/core/v1/{clientExtId}/profiles/{profileExtId}/eauthorizations/{extId}

**Since:** 2.75.2, 2.76.0 **Required permission(s):** `AccessControl.ProfileView` or `SelfAdmin` Role Returns the enterprise authorization with the given external ID for the profile and client.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{profileExtId}/eauthorizations/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfileRESTServiceApi;

import java.io.File;
import java.util.*;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String profileExtId = 1001; // String | ExtID of the profile
        String extId = 2001; // String | ExtID of the enterprise authorization

        try {
            EnterpriseAuthorizationGetDTO result = apiInstance.getEnterpriseAuthorizationOfProfile(clientExtId, profileExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#getEnterpriseAuthorizationOfProfile");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String profileExtId = new String(); // String | ExtID of the profile
final String extId = new String(); // String | ExtID of the enterprise authorization

try {
    final result = await api_instance.getEnterpriseAuthorizationOfProfile(clientExtId, profileExtId, extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEnterpriseAuthorizationOfProfile: $e\n');
}

import org.openapitools.client.api.ProfileRESTServiceApi;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String profileExtId = 1001; // String | ExtID of the profile
        String extId = 2001; // String | ExtID of the enterprise authorization

        try {
            EnterpriseAuthorizationGetDTO result = apiInstance.getEnterpriseAuthorizationOfProfile(clientExtId, profileExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#getEnterpriseAuthorizationOfProfile");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfileRESTServiceApi *apiInstance = [[ProfileRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *profileExtId = 1001; // ExtID of the profile (default to null)
String *extId = 2001; // ExtID of the enterprise authorization (default to null)

// Get enterprise authorization of a profile
[apiInstance getEnterpriseAuthorizationOfProfileWith:clientExtId
    profileExtId:profileExtId
    extId:extId
              completionHandler: ^(EnterpriseAuthorizationGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ProfileRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var profileExtId = 1001; // {String} ExtID of the profile
var extId = 2001; // {String} ExtID of the enterprise authorization

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEnterpriseAuthorizationOfProfile(clientExtId, profileExtId, extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getEnterpriseAuthorizationOfProfileExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProfileRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var profileExtId = 1001;  // String | ExtID of the profile (default to null)
            var extId = 2001;  // String | ExtID of the enterprise authorization (default to null)

            try {
                // Get enterprise authorization of a profile
                EnterpriseAuthorizationGetDTO result = apiInstance.getEnterpriseAuthorizationOfProfile(clientExtId, profileExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfileRESTServiceApi.getEnterpriseAuthorizationOfProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfileRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$profileExtId = 1001; // String | ExtID of the profile
$extId = 2001; // String | ExtID of the enterprise authorization

try {
    $result = $api_instance->getEnterpriseAuthorizationOfProfile($clientExtId, $profileExtId, $extId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfileRESTServiceApi->getEnterpriseAuthorizationOfProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfileRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfileRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $profileExtId = 1001; # String | ExtID of the profile
my $extId = 2001; # String | ExtID of the enterprise authorization

eval {
    my $result = $api_instance->getEnterpriseAuthorizationOfProfile(clientExtId => $clientExtId, profileExtId => $profileExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfileRESTServiceApi->getEnterpriseAuthorizationOfProfile: $@\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.ProfileRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
profileExtId = 1001 # String | ExtID of the profile (default to null)
extId = 2001 # String | ExtID of the enterprise authorization (default to null)

try:
    # Get enterprise authorization of a profile
    api_response = api_instance.get_enterprise_authorization_of_profile(clientExtId, profileExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfileRESTServiceApi->getEnterpriseAuthorizationOfProfile: %s\n" % e)
extern crate ProfileRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let profileExtId = 1001; // String
    let extId = 2001; // String

    let mut context = ProfileRESTServiceApi::Context::default();
    let result = client.getEnterpriseAuthorizationOfProfile(clientExtId, profileExtId, extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
profileExtId*
String
ExtID of the profile
Required
extId*
String
ExtID of the enterprise authorization
Required

Responses


getEnterpriseRoles

getEnterpriseRoles
get/core/v1/{clientExtId}/profiles/{extId}/eroles

**Since:** 2.75.2, 2.76.0 **Required permission(s):** `AccessControl.ProfileView` or `SelfAdmin` Role Returns all enterprise roles assigned to the profile with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{extId}/eroles?continuationToken=2023-01-01_1002&limit=10"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfileRESTServiceApi;

import java.io.File;
import java.util.*;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile
        String continuationToken = 2023-01-01_1002; // String | Continuation token for paging
        Integer limit = 10; // Integer | Maximum number of results

        try {
            ItemsWrapperDTO result = apiInstance.getEnterpriseRoles(clientExtId, extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#getEnterpriseRoles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the profile
final String continuationToken = new String(); // String | Continuation token for paging
final Integer limit = new Integer(); // Integer | Maximum number of results

try {
    final result = await api_instance.getEnterpriseRoles(clientExtId, extId, continuationToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEnterpriseRoles: $e\n');
}

import org.openapitools.client.api.ProfileRESTServiceApi;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile
        String continuationToken = 2023-01-01_1002; // String | Continuation token for paging
        Integer limit = 10; // Integer | Maximum number of results

        try {
            ItemsWrapperDTO result = apiInstance.getEnterpriseRoles(clientExtId, extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#getEnterpriseRoles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfileRESTServiceApi *apiInstance = [[ProfileRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1001; // ExtID of the profile (default to null)
String *continuationToken = 2023-01-01_1002; // Continuation token for paging (optional) (default to )
Integer *limit = 10; // Maximum number of results (optional) (default to 0)

// Get all enterprise roles of a profile
[apiInstance getEnterpriseRolesWith:clientExtId
    extId:extId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ProfileRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1001; // {String} ExtID of the profile
var opts = {
  'continuationToken': 2023-01-01_1002, // {String} Continuation token for paging
  'limit': 10 // {Integer} Maximum number of results
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEnterpriseRoles(clientExtId, extId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getEnterpriseRolesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProfileRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1001;  // String | ExtID of the profile (default to null)
            var continuationToken = 2023-01-01_1002;  // String | Continuation token for paging (optional)  (default to )
            var limit = 10;  // Integer | Maximum number of results (optional)  (default to 0)

            try {
                // Get all enterprise roles of a profile
                ItemsWrapperDTO result = apiInstance.getEnterpriseRoles(clientExtId, extId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfileRESTServiceApi.getEnterpriseRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfileRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1001; // String | ExtID of the profile
$continuationToken = 2023-01-01_1002; // String | Continuation token for paging
$limit = 10; // Integer | Maximum number of results

try {
    $result = $api_instance->getEnterpriseRoles($clientExtId, $extId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfileRESTServiceApi->getEnterpriseRoles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfileRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfileRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1001; # String | ExtID of the profile
my $continuationToken = 2023-01-01_1002; # String | Continuation token for paging
my $limit = 10; # Integer | Maximum number of results

eval {
    my $result = $api_instance->getEnterpriseRoles(clientExtId => $clientExtId, extId => $extId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfileRESTServiceApi->getEnterpriseRoles: $@\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.ProfileRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1001 # String | ExtID of the profile (default to null)
continuationToken = 2023-01-01_1002 # String | Continuation token for paging (optional) (default to )
limit = 10 # Integer | Maximum number of results (optional) (default to 0)

try:
    # Get all enterprise roles of a profile
    api_response = api_instance.get_enterprise_roles(clientExtId, extId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfileRESTServiceApi->getEnterpriseRoles: %s\n" % e)
extern crate ProfileRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1001; // String
    let continuationToken = 2023-01-01_1002; // String
    let limit = 10; // Integer

    let mut context = ProfileRESTServiceApi::Context::default();
    let result = client.getEnterpriseRoles(clientExtId, extId, continuationToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the profile
Required
Query parameters
Name Description
continuationToken
String
Continuation token for paging
limit
Integer (int32)
Maximum number of results

Responses


getProfileWithExtId

getProfileWithExtId
get/core/v1/{clientExtId}/profiles/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.ProfileView` or `SelfAdmin` Role Returns the profile with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfileRESTServiceApi;

import java.io.File;
import java.util.*;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile

        try {
            ProfileGetDTO result = apiInstance.getProfileWithExtId(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#getProfileWithExtId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the profile

try {
    final result = await api_instance.getProfileWithExtId(clientExtId, extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getProfileWithExtId: $e\n');
}

import org.openapitools.client.api.ProfileRESTServiceApi;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile

        try {
            ProfileGetDTO result = apiInstance.getProfileWithExtId(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#getProfileWithExtId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfileRESTServiceApi *apiInstance = [[ProfileRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1001; // ExtID of the profile (default to null)

// Get profile
[apiInstance getProfileWithExtIdWith:clientExtId
    extId:extId
              completionHandler: ^(ProfileGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ProfileRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1001; // {String} ExtID of the profile

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProfileWithExtId(clientExtId, extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getProfileWithExtIdExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProfileRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1001;  // String | ExtID of the profile (default to null)

            try {
                // Get profile
                ProfileGetDTO result = apiInstance.getProfileWithExtId(clientExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfileRESTServiceApi.getProfileWithExtId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfileRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1001; // String | ExtID of the profile

try {
    $result = $api_instance->getProfileWithExtId($clientExtId, $extId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfileRESTServiceApi->getProfileWithExtId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfileRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfileRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1001; # String | ExtID of the profile

eval {
    my $result = $api_instance->getProfileWithExtId(clientExtId => $clientExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfileRESTServiceApi->getProfileWithExtId: $@\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.ProfileRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1001 # String | ExtID of the profile (default to null)

try:
    # Get profile
    api_response = api_instance.get_profile_with_ext_id(clientExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfileRESTServiceApi->getProfileWithExtId: %s\n" % e)
extern crate ProfileRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1001; // String

    let mut context = ProfileRESTServiceApi::Context::default();
    let result = client.getProfileWithExtId(clientExtId, extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the profile
Required

Responses


getProperties2

getProperties2
get/core/v1/{clientExtId}/profiles/{extId}/properties

**Since:** 2.79.0 **Required permission(s):** `AccessControl.ProfileView` Returns the properties and their classifications for the profile with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{extId}/properties"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfileRESTServiceApi;

import java.io.File;
import java.util.*;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile

        try {
            PropertyGetWithClassificationDTO result = apiInstance.getProperties2(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#getProperties2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the profile

try {
    final result = await api_instance.getProperties2(clientExtId, extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getProperties2: $e\n');
}

import org.openapitools.client.api.ProfileRESTServiceApi;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile

        try {
            PropertyGetWithClassificationDTO result = apiInstance.getProperties2(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#getProperties2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfileRESTServiceApi *apiInstance = [[ProfileRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1001; // ExtID of the profile (default to null)

// Get properties of profile
[apiInstance getProperties2With:clientExtId
    extId:extId
              completionHandler: ^(PropertyGetWithClassificationDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ProfileRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1001; // {String} ExtID of the profile

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProperties2(clientExtId, extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getProperties2Example
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProfileRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1001;  // String | ExtID of the profile (default to null)

            try {
                // Get properties of profile
                PropertyGetWithClassificationDTO result = apiInstance.getProperties2(clientExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfileRESTServiceApi.getProperties2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfileRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1001; // String | ExtID of the profile

try {
    $result = $api_instance->getProperties2($clientExtId, $extId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfileRESTServiceApi->getProperties2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfileRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfileRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1001; # String | ExtID of the profile

eval {
    my $result = $api_instance->getProperties2(clientExtId => $clientExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfileRESTServiceApi->getProperties2: $@\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.ProfileRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1001 # String | ExtID of the profile (default to null)

try:
    # Get properties of profile
    api_response = api_instance.get_properties2(clientExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfileRESTServiceApi->getProperties2: %s\n" % e)
extern crate ProfileRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1001; // String

    let mut context = ProfileRESTServiceApi::Context::default();
    let result = client.getProperties2(clientExtId, extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the profile
Required

Responses


getUnitOfProfile

getUnitOfProfile
get/core/v1/{clientExtId}/profiles/{extId}/unit

**Since:** 2.71.0 **Required permission(s):** `AccessControl.ProfileView` or `SelfAdmin` Role Returns the unit assigned to the profile with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{extId}/unit"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfileRESTServiceApi;

import java.io.File;
import java.util.*;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile

        try {
            UnitGetDTO result = apiInstance.getUnitOfProfile(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#getUnitOfProfile");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the profile

try {
    final result = await api_instance.getUnitOfProfile(clientExtId, extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUnitOfProfile: $e\n');
}

import org.openapitools.client.api.ProfileRESTServiceApi;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile

        try {
            UnitGetDTO result = apiInstance.getUnitOfProfile(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#getUnitOfProfile");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfileRESTServiceApi *apiInstance = [[ProfileRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1001; // ExtID of the profile (default to null)

// Get unit of profile
[apiInstance getUnitOfProfileWith:clientExtId
    extId:extId
              completionHandler: ^(UnitGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ProfileRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1001; // {String} ExtID of the profile

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUnitOfProfile(clientExtId, extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUnitOfProfileExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProfileRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1001;  // String | ExtID of the profile (default to null)

            try {
                // Get unit of profile
                UnitGetDTO result = apiInstance.getUnitOfProfile(clientExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfileRESTServiceApi.getUnitOfProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfileRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1001; // String | ExtID of the profile

try {
    $result = $api_instance->getUnitOfProfile($clientExtId, $extId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfileRESTServiceApi->getUnitOfProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfileRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfileRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1001; # String | ExtID of the profile

eval {
    my $result = $api_instance->getUnitOfProfile(clientExtId => $clientExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfileRESTServiceApi->getUnitOfProfile: $@\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.ProfileRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1001 # String | ExtID of the profile (default to null)

try:
    # Get unit of profile
    api_response = api_instance.get_unit_of_profile(clientExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfileRESTServiceApi->getUnitOfProfile: %s\n" % e)
extern crate ProfileRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1001; // String

    let mut context = ProfileRESTServiceApi::Context::default();
    let result = client.getUnitOfProfile(clientExtId, extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the profile
Required

Responses


patchProfile

patchProfile
patch/core/v1/{clientExtId}/profiles/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.ProfileView,AccessControl.ProfileModify` Updates the profile with the given external ID, which belongs to the client with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{extId}" \
 -d '{
  "profileState" : "profileState",
  "modificationComment" : "modificationComment",
  "name" : "name",
  "validity" : {
    "from" : "2023-01-01T00:00:00Z",
    "to" : "2033-12-31T23:59:59Z"
  },
  "isDefaultProfile" : true,
  "version" : 0,
  "remarks" : "remarks"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfileRESTServiceApi;

import java.io.File;
import java.util.*;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile
        ProfilePatchDTO profilePatchDTO = {"profileState":"active","version":1,"name":"something","isDefaultProfile":true,"remarks":"something","modificationComment":"new validity","validity":{"from":"2016-12-31T12:00:00Z","to":"2024-01-01T12:00:00Z"}}; // ProfilePatchDTO | 

        try {
            ProfileGetDTO result = apiInstance.patchProfile(clientExtId, extId, profilePatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#patchProfile");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the profile
final ProfilePatchDTO profilePatchDTO = new ProfilePatchDTO(); // ProfilePatchDTO | 

try {
    final result = await api_instance.patchProfile(clientExtId, extId, profilePatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchProfile: $e\n');
}

import org.openapitools.client.api.ProfileRESTServiceApi;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile
        ProfilePatchDTO profilePatchDTO = {"profileState":"active","version":1,"name":"something","isDefaultProfile":true,"remarks":"something","modificationComment":"new validity","validity":{"from":"2016-12-31T12:00:00Z","to":"2024-01-01T12:00:00Z"}}; // ProfilePatchDTO | 

        try {
            ProfileGetDTO result = apiInstance.patchProfile(clientExtId, extId, profilePatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#patchProfile");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfileRESTServiceApi *apiInstance = [[ProfileRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1001; // ExtID of the profile (default to null)
ProfilePatchDTO *profilePatchDTO = {"profileState":"active","version":1,"name":"something","isDefaultProfile":true,"remarks":"something","modificationComment":"new validity","validity":{"from":"2016-12-31T12:00:00Z","to":"2024-01-01T12:00:00Z"}}; // 

// Update profile
[apiInstance patchProfileWith:clientExtId
    extId:extId
    profilePatchDTO:profilePatchDTO
              completionHandler: ^(ProfileGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ProfileRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1001; // {String} ExtID of the profile
var profilePatchDTO = {"profileState":"active","version":1,"name":"something","isDefaultProfile":true,"remarks":"something","modificationComment":"new validity","validity":{"from":"2016-12-31T12:00:00Z","to":"2024-01-01T12:00:00Z"}}; // {ProfilePatchDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchProfile(clientExtId, extId, profilePatchDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class patchProfileExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProfileRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1001;  // String | ExtID of the profile (default to null)
            var profilePatchDTO = new ProfilePatchDTO(); // ProfilePatchDTO | 

            try {
                // Update profile
                ProfileGetDTO result = apiInstance.patchProfile(clientExtId, extId, profilePatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfileRESTServiceApi.patchProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfileRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1001; // String | ExtID of the profile
$profilePatchDTO = {"profileState":"active","version":1,"name":"something","isDefaultProfile":true,"remarks":"something","modificationComment":"new validity","validity":{"from":"2016-12-31T12:00:00Z","to":"2024-01-01T12:00:00Z"}}; // ProfilePatchDTO | 

try {
    $result = $api_instance->patchProfile($clientExtId, $extId, $profilePatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfileRESTServiceApi->patchProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfileRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfileRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1001; # String | ExtID of the profile
my $profilePatchDTO = WWW::OPenAPIClient::Object::ProfilePatchDTO->new(); # ProfilePatchDTO | 

eval {
    my $result = $api_instance->patchProfile(clientExtId => $clientExtId, extId => $extId, profilePatchDTO => $profilePatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfileRESTServiceApi->patchProfile: $@\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.ProfileRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1001 # String | ExtID of the profile (default to null)
profilePatchDTO = {"profileState":"active","version":1,"name":"something","isDefaultProfile":true,"remarks":"something","modificationComment":"new validity","validity":{"from":"2016-12-31T12:00:00Z","to":"2024-01-01T12:00:00Z"}} # ProfilePatchDTO | 

try:
    # Update profile
    api_response = api_instance.patch_profile(clientExtId, extId, profilePatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfileRESTServiceApi->patchProfile: %s\n" % e)
extern crate ProfileRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1001; // String
    let profilePatchDTO = {"profileState":"active","version":1,"name":"something","isDefaultProfile":true,"remarks":"something","modificationComment":"new validity","validity":{"from":"2016-12-31T12:00:00Z","to":"2024-01-01T12:00:00Z"}}; // ProfilePatchDTO

    let mut context = ProfileRESTServiceApi::Context::default();
    let result = client.patchProfile(clientExtId, extId, profilePatchDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the profile
Required
Body parameters
Name Description
profilePatchDTO *

Responses


updateEnterpriseAuthorization

updateEnterpriseAuthorization
patch/core/v1/{clientExtId}/profiles/{profileExtId}/eauthorizations/{extId}

**Since:** 2.75.2, 2.76.0 **Required permission(s):** `AccessControl.ProfileModify` Updates the enterprise authorization with the given external ID for the profile and client.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{profileExtId}/eauthorizations/{extId}" \
 -d '{
  "validity" : {
    "from" : "2023-01-01T00:00:00Z",
    "to" : "2033-12-31T23:59:59Z"
  },
  "version" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfileRESTServiceApi;

import java.io.File;
import java.util.*;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String profileExtId = 1001; // String | ExtID of the profile
        String extId = 2001; // String | ExtID of the enterprise authorization
        EnterpriseAuthorizationPatchDTO enterpriseAuthorizationPatchDTO = {"version":1,"validity":{"from":"2016-12-31T12:00:00Z","to":"2024-01-01T12:00:00Z"}}; // EnterpriseAuthorizationPatchDTO | 

        try {
            EnterpriseAuthorizationGetDTO result = apiInstance.updateEnterpriseAuthorization(clientExtId, profileExtId, extId, enterpriseAuthorizationPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#updateEnterpriseAuthorization");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String profileExtId = new String(); // String | ExtID of the profile
final String extId = new String(); // String | ExtID of the enterprise authorization
final EnterpriseAuthorizationPatchDTO enterpriseAuthorizationPatchDTO = new EnterpriseAuthorizationPatchDTO(); // EnterpriseAuthorizationPatchDTO | 

try {
    final result = await api_instance.updateEnterpriseAuthorization(clientExtId, profileExtId, extId, enterpriseAuthorizationPatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateEnterpriseAuthorization: $e\n');
}

import org.openapitools.client.api.ProfileRESTServiceApi;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String profileExtId = 1001; // String | ExtID of the profile
        String extId = 2001; // String | ExtID of the enterprise authorization
        EnterpriseAuthorizationPatchDTO enterpriseAuthorizationPatchDTO = {"version":1,"validity":{"from":"2016-12-31T12:00:00Z","to":"2024-01-01T12:00:00Z"}}; // EnterpriseAuthorizationPatchDTO | 

        try {
            EnterpriseAuthorizationGetDTO result = apiInstance.updateEnterpriseAuthorization(clientExtId, profileExtId, extId, enterpriseAuthorizationPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#updateEnterpriseAuthorization");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfileRESTServiceApi *apiInstance = [[ProfileRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *profileExtId = 1001; // ExtID of the profile (default to null)
String *extId = 2001; // ExtID of the enterprise authorization (default to null)
EnterpriseAuthorizationPatchDTO *enterpriseAuthorizationPatchDTO = {"version":1,"validity":{"from":"2016-12-31T12:00:00Z","to":"2024-01-01T12:00:00Z"}}; // 

// Update enterprise authorization for profile
[apiInstance updateEnterpriseAuthorizationWith:clientExtId
    profileExtId:profileExtId
    extId:extId
    enterpriseAuthorizationPatchDTO:enterpriseAuthorizationPatchDTO
              completionHandler: ^(EnterpriseAuthorizationGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ProfileRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var profileExtId = 1001; // {String} ExtID of the profile
var extId = 2001; // {String} ExtID of the enterprise authorization
var enterpriseAuthorizationPatchDTO = {"version":1,"validity":{"from":"2016-12-31T12:00:00Z","to":"2024-01-01T12:00:00Z"}}; // {EnterpriseAuthorizationPatchDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateEnterpriseAuthorization(clientExtId, profileExtId, extId, enterpriseAuthorizationPatchDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateEnterpriseAuthorizationExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProfileRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var profileExtId = 1001;  // String | ExtID of the profile (default to null)
            var extId = 2001;  // String | ExtID of the enterprise authorization (default to null)
            var enterpriseAuthorizationPatchDTO = new EnterpriseAuthorizationPatchDTO(); // EnterpriseAuthorizationPatchDTO | 

            try {
                // Update enterprise authorization for profile
                EnterpriseAuthorizationGetDTO result = apiInstance.updateEnterpriseAuthorization(clientExtId, profileExtId, extId, enterpriseAuthorizationPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfileRESTServiceApi.updateEnterpriseAuthorization: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfileRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$profileExtId = 1001; // String | ExtID of the profile
$extId = 2001; // String | ExtID of the enterprise authorization
$enterpriseAuthorizationPatchDTO = {"version":1,"validity":{"from":"2016-12-31T12:00:00Z","to":"2024-01-01T12:00:00Z"}}; // EnterpriseAuthorizationPatchDTO | 

try {
    $result = $api_instance->updateEnterpriseAuthorization($clientExtId, $profileExtId, $extId, $enterpriseAuthorizationPatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfileRESTServiceApi->updateEnterpriseAuthorization: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfileRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfileRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $profileExtId = 1001; # String | ExtID of the profile
my $extId = 2001; # String | ExtID of the enterprise authorization
my $enterpriseAuthorizationPatchDTO = WWW::OPenAPIClient::Object::EnterpriseAuthorizationPatchDTO->new(); # EnterpriseAuthorizationPatchDTO | 

eval {
    my $result = $api_instance->updateEnterpriseAuthorization(clientExtId => $clientExtId, profileExtId => $profileExtId, extId => $extId, enterpriseAuthorizationPatchDTO => $enterpriseAuthorizationPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfileRESTServiceApi->updateEnterpriseAuthorization: $@\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.ProfileRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
profileExtId = 1001 # String | ExtID of the profile (default to null)
extId = 2001 # String | ExtID of the enterprise authorization (default to null)
enterpriseAuthorizationPatchDTO = {"version":1,"validity":{"from":"2016-12-31T12:00:00Z","to":"2024-01-01T12:00:00Z"}} # EnterpriseAuthorizationPatchDTO | 

try:
    # Update enterprise authorization for profile
    api_response = api_instance.update_enterprise_authorization(clientExtId, profileExtId, extId, enterpriseAuthorizationPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfileRESTServiceApi->updateEnterpriseAuthorization: %s\n" % e)
extern crate ProfileRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let profileExtId = 1001; // String
    let extId = 2001; // String
    let enterpriseAuthorizationPatchDTO = {"version":1,"validity":{"from":"2016-12-31T12:00:00Z","to":"2024-01-01T12:00:00Z"}}; // EnterpriseAuthorizationPatchDTO

    let mut context = ProfileRESTServiceApi::Context::default();
    let result = client.updateEnterpriseAuthorization(clientExtId, profileExtId, extId, enterpriseAuthorizationPatchDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
profileExtId*
String
ExtID of the profile
Required
extId*
String
ExtID of the enterprise authorization
Required
Body parameters
Name Description
enterpriseAuthorizationPatchDTO *

Responses


updateProperties3

updateProperties3
patch/core/v1/{clientExtId}/profiles/{extId}/properties

**Since:** 2.79.0 **Required permission(s):** `AccessControl.ProfileModify` Updates the properties for the profile with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/profiles/{extId}/properties" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfileRESTServiceApi;

import java.io.File;
import java.util.*;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile
        map[String, String] requestBody = {"propertyName1":"propertyNewValue1","propertyName3":"propertyNewValue3","propertyName4":""}; // map[String, String] | 

        try {
            PropertyGetWithClassificationDTO result = apiInstance.updateProperties3(clientExtId, extId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#updateProperties3");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the profile
final map[String, String] requestBody = new map[String, String](); // map[String, String] | 

try {
    final result = await api_instance.updateProperties3(clientExtId, extId, requestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateProperties3: $e\n');
}

import org.openapitools.client.api.ProfileRESTServiceApi;

public class ProfileRESTServiceApiExample {
    public static void main(String[] args) {
        ProfileRESTServiceApi apiInstance = new ProfileRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1001; // String | ExtID of the profile
        map[String, String] requestBody = {"propertyName1":"propertyNewValue1","propertyName3":"propertyNewValue3","propertyName4":""}; // map[String, String] | 

        try {
            PropertyGetWithClassificationDTO result = apiInstance.updateProperties3(clientExtId, extId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileRESTServiceApi#updateProperties3");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfileRESTServiceApi *apiInstance = [[ProfileRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1001; // ExtID of the profile (default to null)
map[String, String] *requestBody = {"propertyName1":"propertyNewValue1","propertyName3":"propertyNewValue3","propertyName4":""}; // 

// Update properties of profile
[apiInstance updateProperties3With:clientExtId
    extId:extId
    requestBody:requestBody
              completionHandler: ^(PropertyGetWithClassificationDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.ProfileRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1001; // {String} ExtID of the profile
var requestBody = {"propertyName1":"propertyNewValue1","propertyName3":"propertyNewValue3","propertyName4":""}; // {map[String, String]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateProperties3(clientExtId, extId, requestBody, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateProperties3Example
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProfileRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1001;  // String | ExtID of the profile (default to null)
            var requestBody = new map[String, String](); // map[String, String] | 

            try {
                // Update properties of profile
                PropertyGetWithClassificationDTO result = apiInstance.updateProperties3(clientExtId, extId, requestBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfileRESTServiceApi.updateProperties3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfileRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1001; // String | ExtID of the profile
$requestBody = {"propertyName1":"propertyNewValue1","propertyName3":"propertyNewValue3","propertyName4":""}; // map[String, String] | 

try {
    $result = $api_instance->updateProperties3($clientExtId, $extId, $requestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfileRESTServiceApi->updateProperties3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfileRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfileRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1001; # String | ExtID of the profile
my $requestBody = WWW::OPenAPIClient::Object::map[String, String]->new(); # map[String, String] | 

eval {
    my $result = $api_instance->updateProperties3(clientExtId => $clientExtId, extId => $extId, requestBody => $requestBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfileRESTServiceApi->updateProperties3: $@\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.ProfileRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1001 # String | ExtID of the profile (default to null)
requestBody = {"propertyName1":"propertyNewValue1","propertyName3":"propertyNewValue3","propertyName4":""} # map[String, String] | 

try:
    # Update properties of profile
    api_response = api_instance.update_properties3(clientExtId, extId, requestBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfileRESTServiceApi->updateProperties3: %s\n" % e)
extern crate ProfileRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1001; // String
    let requestBody = {"propertyName1":"propertyNewValue1","propertyName3":"propertyNewValue3","propertyName4":""}; // map[String, String]

    let mut context = ProfileRESTServiceApi::Context::default();
    let result = client.updateProperties3(clientExtId, extId, requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the profile
Required
Body parameters
Name Description
requestBody *

Responses


QueryService

all

all
get/query/v1/all

Performs a full text search for all indexed entities (users, units, clients).

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/query/v1/all?q=q_example&from=56&size=56&df=&s=s_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.QueryServiceApi;

import java.io.File;
import java.util.*;

public class QueryServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.all(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#all");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String q = new String(); // String | Lucene query string.
final Integer from = new Integer(); // Integer | Paging offset.
final Integer size = new Integer(); // Integer | Paging size.
final array[String] df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query.
final String s = new String(); // String | Sort order.

try {
    final result = await api_instance.all(q, from, size, df, s);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->all: $e\n');
}

import org.openapitools.client.api.QueryServiceApi;

public class QueryServiceApiExample {
    public static void main(String[] args) {
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.all(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#all");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
QueryServiceApi *apiInstance = [[QueryServiceApi alloc] init];
String *q = q_example; // Lucene query string. (default to null)
Integer *from = 56; // Paging offset. (optional) (default to 0)
Integer *size = 56; // Paging size. (optional) (default to 10)
array[String] *df = ; // The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
String *s = s_example; // Sort order. (optional) (default to null)

// Query all indexed entities
[apiInstance allWith:q
    from:from
    size:size
    df:df
    s:s
              completionHandler: ^(EnvelopeDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.QueryServiceApi()
var q = q_example; // {String} Lucene query string.
var opts = {
  'from': 56, // {Integer} Paging offset.
  'size': 56, // {Integer} Paging size.
  'df': , // {array[String]} The list of default fields to use when no field prefix is defined within the query.
  's': s_example // {String} Sort order.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.all(q, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class allExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new QueryServiceApi();
            var q = q_example;  // String | Lucene query string. (default to null)
            var from = 56;  // Integer | Paging offset. (optional)  (default to 0)
            var size = 56;  // Integer | Paging size. (optional)  (default to 10)
            var df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query. (optional)  (default to null)
            var s = s_example;  // String | Sort order. (optional)  (default to null)

            try {
                // Query all indexed entities
                EnvelopeDTO result = apiInstance.all(q, from, size, df, s);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling QueryServiceApi.all: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\QueryServiceApi();
$q = q_example; // String | Lucene query string.
$from = 56; // Integer | Paging offset.
$size = 56; // Integer | Paging size.
$df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
$s = s_example; // String | Sort order.

try {
    $result = $api_instance->all($q, $from, $size, $df, $s);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryServiceApi->all: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::QueryServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::QueryServiceApi->new();
my $q = q_example; # String | Lucene query string.
my $from = 56; # Integer | Paging offset.
my $size = 56; # Integer | Paging size.
my $df = []; # array[String] | The list of default fields to use when no field prefix is defined within the query.
my $s = s_example; # String | Sort order.

eval {
    my $result = $api_instance->all(q => $q, from => $from, size => $size, df => $df, s => $s);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryServiceApi->all: $@\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.QueryServiceApi()
q = q_example # String | Lucene query string. (default to null)
from = 56 # Integer | Paging offset. (optional) (default to 0)
size = 56 # Integer | Paging size. (optional) (default to 10)
df =  # array[String] | The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
s = s_example # String | Sort order. (optional) (default to null)

try:
    # Query all indexed entities
    api_response = api_instance.all(q, from=from, size=size, df=df, s=s)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryServiceApi->all: %s\n" % e)
extern crate QueryServiceApi;

pub fn main() {
    let q = q_example; // String
    let from = 56; // Integer
    let size = 56; // Integer
    let df = ; // array[String]
    let s = s_example; // String

    let mut context = QueryServiceApi::Context::default();
    let result = client.all(q, from, size, df, s, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
q*
String
Lucene query string.
Required
from
Integer (int32)
Paging offset.
size
Integer (int32)
Paging size.
df
array[String]
The list of default fields to use when no field prefix is defined within the query.
s
String
Sort order.

Responses


all1

all1
get/v1/query/all

Performs a full text search for all indexed entities (users, units, clients).

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/v1/query/all?q=q_example&from=56&size=56&df=&s=s_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.QueryServiceApi;

import java.io.File;
import java.util.*;

public class QueryServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.all1(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#all1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String q = new String(); // String | Lucene query string.
final Integer from = new Integer(); // Integer | Paging offset.
final Integer size = new Integer(); // Integer | Paging size.
final array[String] df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query.
final String s = new String(); // String | Sort order.

try {
    final result = await api_instance.all1(q, from, size, df, s);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->all1: $e\n');
}

import org.openapitools.client.api.QueryServiceApi;

public class QueryServiceApiExample {
    public static void main(String[] args) {
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.all1(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#all1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
QueryServiceApi *apiInstance = [[QueryServiceApi alloc] init];
String *q = q_example; // Lucene query string. (default to null)
Integer *from = 56; // Paging offset. (optional) (default to 0)
Integer *size = 56; // Paging size. (optional) (default to 10)
array[String] *df = ; // The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
String *s = s_example; // Sort order. (optional) (default to null)

// Query all indexed entities
[apiInstance all1With:q
    from:from
    size:size
    df:df
    s:s
              completionHandler: ^(EnvelopeDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.QueryServiceApi()
var q = q_example; // {String} Lucene query string.
var opts = {
  'from': 56, // {Integer} Paging offset.
  'size': 56, // {Integer} Paging size.
  'df': , // {array[String]} The list of default fields to use when no field prefix is defined within the query.
  's': s_example // {String} Sort order.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.all1(q, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class all1Example
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new QueryServiceApi();
            var q = q_example;  // String | Lucene query string. (default to null)
            var from = 56;  // Integer | Paging offset. (optional)  (default to 0)
            var size = 56;  // Integer | Paging size. (optional)  (default to 10)
            var df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query. (optional)  (default to null)
            var s = s_example;  // String | Sort order. (optional)  (default to null)

            try {
                // Query all indexed entities
                EnvelopeDTO result = apiInstance.all1(q, from, size, df, s);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling QueryServiceApi.all1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\QueryServiceApi();
$q = q_example; // String | Lucene query string.
$from = 56; // Integer | Paging offset.
$size = 56; // Integer | Paging size.
$df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
$s = s_example; // String | Sort order.

try {
    $result = $api_instance->all1($q, $from, $size, $df, $s);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryServiceApi->all1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::QueryServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::QueryServiceApi->new();
my $q = q_example; # String | Lucene query string.
my $from = 56; # Integer | Paging offset.
my $size = 56; # Integer | Paging size.
my $df = []; # array[String] | The list of default fields to use when no field prefix is defined within the query.
my $s = s_example; # String | Sort order.

eval {
    my $result = $api_instance->all1(q => $q, from => $from, size => $size, df => $df, s => $s);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryServiceApi->all1: $@\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.QueryServiceApi()
q = q_example # String | Lucene query string. (default to null)
from = 56 # Integer | Paging offset. (optional) (default to 0)
size = 56 # Integer | Paging size. (optional) (default to 10)
df =  # array[String] | The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
s = s_example # String | Sort order. (optional) (default to null)

try:
    # Query all indexed entities
    api_response = api_instance.all1(q, from=from, size=size, df=df, s=s)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryServiceApi->all1: %s\n" % e)
extern crate QueryServiceApi;

pub fn main() {
    let q = q_example; // String
    let from = 56; // Integer
    let size = 56; // Integer
    let df = ; // array[String]
    let s = s_example; // String

    let mut context = QueryServiceApi::Context::default();
    let result = client.all1(q, from, size, df, s, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
q*
String
Lucene query string.
Required
from
Integer (int32)
Paging offset.
size
Integer (int32)
Paging size.
df
array[String]
The list of default fields to use when no field prefix is defined within the query.
s
String
Sort order.

Responses


applications

applications
get/v1/query/applications

Performs a full text search for applications.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/v1/query/applications?q=q_example&from=56&size=56&df=&s=s_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.QueryServiceApi;

import java.io.File;
import java.util.*;

public class QueryServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.applications(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#applications");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String q = new String(); // String | Lucene query string.
final Integer from = new Integer(); // Integer | Paging offset.
final Integer size = new Integer(); // Integer | Paging size.
final array[String] df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query.
final String s = new String(); // String | Sort order.

try {
    final result = await api_instance.applications(q, from, size, df, s);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->applications: $e\n');
}

import org.openapitools.client.api.QueryServiceApi;

public class QueryServiceApiExample {
    public static void main(String[] args) {
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.applications(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#applications");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
QueryServiceApi *apiInstance = [[QueryServiceApi alloc] init];
String *q = q_example; // Lucene query string. (default to null)
Integer *from = 56; // Paging offset. (optional) (default to 0)
Integer *size = 56; // Paging size. (optional) (default to 10)
array[String] *df = ; // The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
String *s = s_example; // Sort order. (optional) (default to null)

// Query applications
[apiInstance applicationsWith:q
    from:from
    size:size
    df:df
    s:s
              completionHandler: ^(EnvelopeDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.QueryServiceApi()
var q = q_example; // {String} Lucene query string.
var opts = {
  'from': 56, // {Integer} Paging offset.
  'size': 56, // {Integer} Paging size.
  'df': , // {array[String]} The list of default fields to use when no field prefix is defined within the query.
  's': s_example // {String} Sort order.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.applications(q, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class applicationsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new QueryServiceApi();
            var q = q_example;  // String | Lucene query string. (default to null)
            var from = 56;  // Integer | Paging offset. (optional)  (default to 0)
            var size = 56;  // Integer | Paging size. (optional)  (default to 10)
            var df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query. (optional)  (default to null)
            var s = s_example;  // String | Sort order. (optional)  (default to null)

            try {
                // Query applications
                EnvelopeDTO result = apiInstance.applications(q, from, size, df, s);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling QueryServiceApi.applications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\QueryServiceApi();
$q = q_example; // String | Lucene query string.
$from = 56; // Integer | Paging offset.
$size = 56; // Integer | Paging size.
$df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
$s = s_example; // String | Sort order.

try {
    $result = $api_instance->applications($q, $from, $size, $df, $s);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryServiceApi->applications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::QueryServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::QueryServiceApi->new();
my $q = q_example; # String | Lucene query string.
my $from = 56; # Integer | Paging offset.
my $size = 56; # Integer | Paging size.
my $df = []; # array[String] | The list of default fields to use when no field prefix is defined within the query.
my $s = s_example; # String | Sort order.

eval {
    my $result = $api_instance->applications(q => $q, from => $from, size => $size, df => $df, s => $s);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryServiceApi->applications: $@\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.QueryServiceApi()
q = q_example # String | Lucene query string. (default to null)
from = 56 # Integer | Paging offset. (optional) (default to 0)
size = 56 # Integer | Paging size. (optional) (default to 10)
df =  # array[String] | The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
s = s_example # String | Sort order. (optional) (default to null)

try:
    # Query applications
    api_response = api_instance.applications(q, from=from, size=size, df=df, s=s)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryServiceApi->applications: %s\n" % e)
extern crate QueryServiceApi;

pub fn main() {
    let q = q_example; // String
    let from = 56; // Integer
    let size = 56; // Integer
    let df = ; // array[String]
    let s = s_example; // String

    let mut context = QueryServiceApi::Context::default();
    let result = client.applications(q, from, size, df, s, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
q*
String
Lucene query string.
Required
from
Integer (int32)
Paging offset.
size
Integer (int32)
Paging size.
df
array[String]
The list of default fields to use when no field prefix is defined within the query.
s
String
Sort order.

Responses


applications1

applications1
get/query/v1/applications

Performs a full text search for applications.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/query/v1/applications?q=q_example&from=56&size=56&df=&s=s_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.QueryServiceApi;

import java.io.File;
import java.util.*;

public class QueryServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.applications1(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#applications1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String q = new String(); // String | Lucene query string.
final Integer from = new Integer(); // Integer | Paging offset.
final Integer size = new Integer(); // Integer | Paging size.
final array[String] df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query.
final String s = new String(); // String | Sort order.

try {
    final result = await api_instance.applications1(q, from, size, df, s);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->applications1: $e\n');
}

import org.openapitools.client.api.QueryServiceApi;

public class QueryServiceApiExample {
    public static void main(String[] args) {
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.applications1(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#applications1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
QueryServiceApi *apiInstance = [[QueryServiceApi alloc] init];
String *q = q_example; // Lucene query string. (default to null)
Integer *from = 56; // Paging offset. (optional) (default to 0)
Integer *size = 56; // Paging size. (optional) (default to 10)
array[String] *df = ; // The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
String *s = s_example; // Sort order. (optional) (default to null)

// Query applications
[apiInstance applications1With:q
    from:from
    size:size
    df:df
    s:s
              completionHandler: ^(EnvelopeDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.QueryServiceApi()
var q = q_example; // {String} Lucene query string.
var opts = {
  'from': 56, // {Integer} Paging offset.
  'size': 56, // {Integer} Paging size.
  'df': , // {array[String]} The list of default fields to use when no field prefix is defined within the query.
  's': s_example // {String} Sort order.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.applications1(q, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class applications1Example
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new QueryServiceApi();
            var q = q_example;  // String | Lucene query string. (default to null)
            var from = 56;  // Integer | Paging offset. (optional)  (default to 0)
            var size = 56;  // Integer | Paging size. (optional)  (default to 10)
            var df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query. (optional)  (default to null)
            var s = s_example;  // String | Sort order. (optional)  (default to null)

            try {
                // Query applications
                EnvelopeDTO result = apiInstance.applications1(q, from, size, df, s);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling QueryServiceApi.applications1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\QueryServiceApi();
$q = q_example; // String | Lucene query string.
$from = 56; // Integer | Paging offset.
$size = 56; // Integer | Paging size.
$df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
$s = s_example; // String | Sort order.

try {
    $result = $api_instance->applications1($q, $from, $size, $df, $s);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryServiceApi->applications1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::QueryServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::QueryServiceApi->new();
my $q = q_example; # String | Lucene query string.
my $from = 56; # Integer | Paging offset.
my $size = 56; # Integer | Paging size.
my $df = []; # array[String] | The list of default fields to use when no field prefix is defined within the query.
my $s = s_example; # String | Sort order.

eval {
    my $result = $api_instance->applications1(q => $q, from => $from, size => $size, df => $df, s => $s);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryServiceApi->applications1: $@\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.QueryServiceApi()
q = q_example # String | Lucene query string. (default to null)
from = 56 # Integer | Paging offset. (optional) (default to 0)
size = 56 # Integer | Paging size. (optional) (default to 10)
df =  # array[String] | The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
s = s_example # String | Sort order. (optional) (default to null)

try:
    # Query applications
    api_response = api_instance.applications1(q, from=from, size=size, df=df, s=s)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryServiceApi->applications1: %s\n" % e)
extern crate QueryServiceApi;

pub fn main() {
    let q = q_example; // String
    let from = 56; // Integer
    let size = 56; // Integer
    let df = ; // array[String]
    let s = s_example; // String

    let mut context = QueryServiceApi::Context::default();
    let result = client.applications1(q, from, size, df, s, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
q*
String
Lucene query string.
Required
from
Integer (int32)
Paging offset.
size
Integer (int32)
Paging size.
df
array[String]
The list of default fields to use when no field prefix is defined within the query.
s
String
Sort order.

Responses


clients

clients
get/query/v1/clients

Performs a full text search for clients.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/query/v1/clients?q=q_example&from=56&size=56&df=&s=s_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.QueryServiceApi;

import java.io.File;
import java.util.*;

public class QueryServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.clients(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#clients");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String q = new String(); // String | Lucene query string.
final Integer from = new Integer(); // Integer | Paging offset.
final Integer size = new Integer(); // Integer | Paging size.
final array[String] df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query.
final String s = new String(); // String | Sort order.

try {
    final result = await api_instance.clients(q, from, size, df, s);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->clients: $e\n');
}

import org.openapitools.client.api.QueryServiceApi;

public class QueryServiceApiExample {
    public static void main(String[] args) {
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.clients(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#clients");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
QueryServiceApi *apiInstance = [[QueryServiceApi alloc] init];
String *q = q_example; // Lucene query string. (default to null)
Integer *from = 56; // Paging offset. (optional) (default to 0)
Integer *size = 56; // Paging size. (optional) (default to 10)
array[String] *df = ; // The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
String *s = s_example; // Sort order. (optional) (default to null)

// Query clients
[apiInstance clientsWith:q
    from:from
    size:size
    df:df
    s:s
              completionHandler: ^(EnvelopeDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.QueryServiceApi()
var q = q_example; // {String} Lucene query string.
var opts = {
  'from': 56, // {Integer} Paging offset.
  'size': 56, // {Integer} Paging size.
  'df': , // {array[String]} The list of default fields to use when no field prefix is defined within the query.
  's': s_example // {String} Sort order.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.clients(q, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class clientsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new QueryServiceApi();
            var q = q_example;  // String | Lucene query string. (default to null)
            var from = 56;  // Integer | Paging offset. (optional)  (default to 0)
            var size = 56;  // Integer | Paging size. (optional)  (default to 10)
            var df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query. (optional)  (default to null)
            var s = s_example;  // String | Sort order. (optional)  (default to null)

            try {
                // Query clients
                EnvelopeDTO result = apiInstance.clients(q, from, size, df, s);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling QueryServiceApi.clients: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\QueryServiceApi();
$q = q_example; // String | Lucene query string.
$from = 56; // Integer | Paging offset.
$size = 56; // Integer | Paging size.
$df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
$s = s_example; // String | Sort order.

try {
    $result = $api_instance->clients($q, $from, $size, $df, $s);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryServiceApi->clients: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::QueryServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::QueryServiceApi->new();
my $q = q_example; # String | Lucene query string.
my $from = 56; # Integer | Paging offset.
my $size = 56; # Integer | Paging size.
my $df = []; # array[String] | The list of default fields to use when no field prefix is defined within the query.
my $s = s_example; # String | Sort order.

eval {
    my $result = $api_instance->clients(q => $q, from => $from, size => $size, df => $df, s => $s);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryServiceApi->clients: $@\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.QueryServiceApi()
q = q_example # String | Lucene query string. (default to null)
from = 56 # Integer | Paging offset. (optional) (default to 0)
size = 56 # Integer | Paging size. (optional) (default to 10)
df =  # array[String] | The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
s = s_example # String | Sort order. (optional) (default to null)

try:
    # Query clients
    api_response = api_instance.clients(q, from=from, size=size, df=df, s=s)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryServiceApi->clients: %s\n" % e)
extern crate QueryServiceApi;

pub fn main() {
    let q = q_example; // String
    let from = 56; // Integer
    let size = 56; // Integer
    let df = ; // array[String]
    let s = s_example; // String

    let mut context = QueryServiceApi::Context::default();
    let result = client.clients(q, from, size, df, s, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
q*
String
Lucene query string.
Required
from
Integer (int32)
Paging offset.
size
Integer (int32)
Paging size.
df
array[String]
The list of default fields to use when no field prefix is defined within the query.
s
String
Sort order.

Responses


clients1

clients1
get/v1/query/clients

Performs a full text search for clients.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/v1/query/clients?q=q_example&from=56&size=56&df=&s=s_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.QueryServiceApi;

import java.io.File;
import java.util.*;

public class QueryServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.clients1(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#clients1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String q = new String(); // String | Lucene query string.
final Integer from = new Integer(); // Integer | Paging offset.
final Integer size = new Integer(); // Integer | Paging size.
final array[String] df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query.
final String s = new String(); // String | Sort order.

try {
    final result = await api_instance.clients1(q, from, size, df, s);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->clients1: $e\n');
}

import org.openapitools.client.api.QueryServiceApi;

public class QueryServiceApiExample {
    public static void main(String[] args) {
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.clients1(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#clients1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
QueryServiceApi *apiInstance = [[QueryServiceApi alloc] init];
String *q = q_example; // Lucene query string. (default to null)
Integer *from = 56; // Paging offset. (optional) (default to 0)
Integer *size = 56; // Paging size. (optional) (default to 10)
array[String] *df = ; // The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
String *s = s_example; // Sort order. (optional) (default to null)

// Query clients
[apiInstance clients1With:q
    from:from
    size:size
    df:df
    s:s
              completionHandler: ^(EnvelopeDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.QueryServiceApi()
var q = q_example; // {String} Lucene query string.
var opts = {
  'from': 56, // {Integer} Paging offset.
  'size': 56, // {Integer} Paging size.
  'df': , // {array[String]} The list of default fields to use when no field prefix is defined within the query.
  's': s_example // {String} Sort order.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.clients1(q, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class clients1Example
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new QueryServiceApi();
            var q = q_example;  // String | Lucene query string. (default to null)
            var from = 56;  // Integer | Paging offset. (optional)  (default to 0)
            var size = 56;  // Integer | Paging size. (optional)  (default to 10)
            var df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query. (optional)  (default to null)
            var s = s_example;  // String | Sort order. (optional)  (default to null)

            try {
                // Query clients
                EnvelopeDTO result = apiInstance.clients1(q, from, size, df, s);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling QueryServiceApi.clients1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\QueryServiceApi();
$q = q_example; // String | Lucene query string.
$from = 56; // Integer | Paging offset.
$size = 56; // Integer | Paging size.
$df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
$s = s_example; // String | Sort order.

try {
    $result = $api_instance->clients1($q, $from, $size, $df, $s);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryServiceApi->clients1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::QueryServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::QueryServiceApi->new();
my $q = q_example; # String | Lucene query string.
my $from = 56; # Integer | Paging offset.
my $size = 56; # Integer | Paging size.
my $df = []; # array[String] | The list of default fields to use when no field prefix is defined within the query.
my $s = s_example; # String | Sort order.

eval {
    my $result = $api_instance->clients1(q => $q, from => $from, size => $size, df => $df, s => $s);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryServiceApi->clients1: $@\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.QueryServiceApi()
q = q_example # String | Lucene query string. (default to null)
from = 56 # Integer | Paging offset. (optional) (default to 0)
size = 56 # Integer | Paging size. (optional) (default to 10)
df =  # array[String] | The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
s = s_example # String | Sort order. (optional) (default to null)

try:
    # Query clients
    api_response = api_instance.clients1(q, from=from, size=size, df=df, s=s)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryServiceApi->clients1: %s\n" % e)
extern crate QueryServiceApi;

pub fn main() {
    let q = q_example; // String
    let from = 56; // Integer
    let size = 56; // Integer
    let df = ; // array[String]
    let s = s_example; // String

    let mut context = QueryServiceApi::Context::default();
    let result = client.clients1(q, from, size, df, s, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
q*
String
Lucene query string.
Required
from
Integer (int32)
Paging offset.
size
Integer (int32)
Paging size.
df
array[String]
The list of default fields to use when no field prefix is defined within the query.
s
String
Sort order.

Responses


roles

roles
get/query/v1/roles

Performs a full text search for roles.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/query/v1/roles?q=q_example&from=56&size=56&df=&s=s_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.QueryServiceApi;

import java.io.File;
import java.util.*;

public class QueryServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.roles(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#roles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String q = new String(); // String | Lucene query string.
final Integer from = new Integer(); // Integer | Paging offset.
final Integer size = new Integer(); // Integer | Paging size.
final array[String] df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query.
final String s = new String(); // String | Sort order.

try {
    final result = await api_instance.roles(q, from, size, df, s);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->roles: $e\n');
}

import org.openapitools.client.api.QueryServiceApi;

public class QueryServiceApiExample {
    public static void main(String[] args) {
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.roles(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#roles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
QueryServiceApi *apiInstance = [[QueryServiceApi alloc] init];
String *q = q_example; // Lucene query string. (default to null)
Integer *from = 56; // Paging offset. (optional) (default to 0)
Integer *size = 56; // Paging size. (optional) (default to 10)
array[String] *df = ; // The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
String *s = s_example; // Sort order. (optional) (default to null)

// Query roles
[apiInstance rolesWith:q
    from:from
    size:size
    df:df
    s:s
              completionHandler: ^(EnvelopeDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.QueryServiceApi()
var q = q_example; // {String} Lucene query string.
var opts = {
  'from': 56, // {Integer} Paging offset.
  'size': 56, // {Integer} Paging size.
  'df': , // {array[String]} The list of default fields to use when no field prefix is defined within the query.
  's': s_example // {String} Sort order.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.roles(q, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class rolesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new QueryServiceApi();
            var q = q_example;  // String | Lucene query string. (default to null)
            var from = 56;  // Integer | Paging offset. (optional)  (default to 0)
            var size = 56;  // Integer | Paging size. (optional)  (default to 10)
            var df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query. (optional)  (default to null)
            var s = s_example;  // String | Sort order. (optional)  (default to null)

            try {
                // Query roles
                EnvelopeDTO result = apiInstance.roles(q, from, size, df, s);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling QueryServiceApi.roles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\QueryServiceApi();
$q = q_example; // String | Lucene query string.
$from = 56; // Integer | Paging offset.
$size = 56; // Integer | Paging size.
$df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
$s = s_example; // String | Sort order.

try {
    $result = $api_instance->roles($q, $from, $size, $df, $s);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryServiceApi->roles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::QueryServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::QueryServiceApi->new();
my $q = q_example; # String | Lucene query string.
my $from = 56; # Integer | Paging offset.
my $size = 56; # Integer | Paging size.
my $df = []; # array[String] | The list of default fields to use when no field prefix is defined within the query.
my $s = s_example; # String | Sort order.

eval {
    my $result = $api_instance->roles(q => $q, from => $from, size => $size, df => $df, s => $s);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryServiceApi->roles: $@\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.QueryServiceApi()
q = q_example # String | Lucene query string. (default to null)
from = 56 # Integer | Paging offset. (optional) (default to 0)
size = 56 # Integer | Paging size. (optional) (default to 10)
df =  # array[String] | The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
s = s_example # String | Sort order. (optional) (default to null)

try:
    # Query roles
    api_response = api_instance.roles(q, from=from, size=size, df=df, s=s)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryServiceApi->roles: %s\n" % e)
extern crate QueryServiceApi;

pub fn main() {
    let q = q_example; // String
    let from = 56; // Integer
    let size = 56; // Integer
    let df = ; // array[String]
    let s = s_example; // String

    let mut context = QueryServiceApi::Context::default();
    let result = client.roles(q, from, size, df, s, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
q*
String
Lucene query string.
Required
from
Integer (int32)
Paging offset.
size
Integer (int32)
Paging size.
df
array[String]
The list of default fields to use when no field prefix is defined within the query.
s
String
Sort order.

Responses


roles1

roles1
get/v1/query/roles

Performs a full text search for roles.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/v1/query/roles?q=q_example&from=56&size=56&df=&s=s_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.QueryServiceApi;

import java.io.File;
import java.util.*;

public class QueryServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.roles1(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#roles1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String q = new String(); // String | Lucene query string.
final Integer from = new Integer(); // Integer | Paging offset.
final Integer size = new Integer(); // Integer | Paging size.
final array[String] df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query.
final String s = new String(); // String | Sort order.

try {
    final result = await api_instance.roles1(q, from, size, df, s);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->roles1: $e\n');
}

import org.openapitools.client.api.QueryServiceApi;

public class QueryServiceApiExample {
    public static void main(String[] args) {
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.roles1(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#roles1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
QueryServiceApi *apiInstance = [[QueryServiceApi alloc] init];
String *q = q_example; // Lucene query string. (default to null)
Integer *from = 56; // Paging offset. (optional) (default to 0)
Integer *size = 56; // Paging size. (optional) (default to 10)
array[String] *df = ; // The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
String *s = s_example; // Sort order. (optional) (default to null)

// Query roles
[apiInstance roles1With:q
    from:from
    size:size
    df:df
    s:s
              completionHandler: ^(EnvelopeDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.QueryServiceApi()
var q = q_example; // {String} Lucene query string.
var opts = {
  'from': 56, // {Integer} Paging offset.
  'size': 56, // {Integer} Paging size.
  'df': , // {array[String]} The list of default fields to use when no field prefix is defined within the query.
  's': s_example // {String} Sort order.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.roles1(q, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class roles1Example
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new QueryServiceApi();
            var q = q_example;  // String | Lucene query string. (default to null)
            var from = 56;  // Integer | Paging offset. (optional)  (default to 0)
            var size = 56;  // Integer | Paging size. (optional)  (default to 10)
            var df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query. (optional)  (default to null)
            var s = s_example;  // String | Sort order. (optional)  (default to null)

            try {
                // Query roles
                EnvelopeDTO result = apiInstance.roles1(q, from, size, df, s);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling QueryServiceApi.roles1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\QueryServiceApi();
$q = q_example; // String | Lucene query string.
$from = 56; // Integer | Paging offset.
$size = 56; // Integer | Paging size.
$df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
$s = s_example; // String | Sort order.

try {
    $result = $api_instance->roles1($q, $from, $size, $df, $s);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryServiceApi->roles1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::QueryServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::QueryServiceApi->new();
my $q = q_example; # String | Lucene query string.
my $from = 56; # Integer | Paging offset.
my $size = 56; # Integer | Paging size.
my $df = []; # array[String] | The list of default fields to use when no field prefix is defined within the query.
my $s = s_example; # String | Sort order.

eval {
    my $result = $api_instance->roles1(q => $q, from => $from, size => $size, df => $df, s => $s);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryServiceApi->roles1: $@\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.QueryServiceApi()
q = q_example # String | Lucene query string. (default to null)
from = 56 # Integer | Paging offset. (optional) (default to 0)
size = 56 # Integer | Paging size. (optional) (default to 10)
df =  # array[String] | The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
s = s_example # String | Sort order. (optional) (default to null)

try:
    # Query roles
    api_response = api_instance.roles1(q, from=from, size=size, df=df, s=s)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryServiceApi->roles1: %s\n" % e)
extern crate QueryServiceApi;

pub fn main() {
    let q = q_example; // String
    let from = 56; // Integer
    let size = 56; // Integer
    let df = ; // array[String]
    let s = s_example; // String

    let mut context = QueryServiceApi::Context::default();
    let result = client.roles1(q, from, size, df, s, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
q*
String
Lucene query string.
Required
from
Integer (int32)
Paging offset.
size
Integer (int32)
Paging size.
df
array[String]
The list of default fields to use when no field prefix is defined within the query.
s
String
Sort order.

Responses


units

units
get/query/v1/units

Performs a full text search for units.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/query/v1/units?q=q_example&from=56&size=56&df=&s=s_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.QueryServiceApi;

import java.io.File;
import java.util.*;

public class QueryServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.units(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#units");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String q = new String(); // String | Lucene query string.
final Integer from = new Integer(); // Integer | Paging offset.
final Integer size = new Integer(); // Integer | Paging size.
final array[String] df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query.
final String s = new String(); // String | Sort order.

try {
    final result = await api_instance.units(q, from, size, df, s);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->units: $e\n');
}

import org.openapitools.client.api.QueryServiceApi;

public class QueryServiceApiExample {
    public static void main(String[] args) {
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.units(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#units");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
QueryServiceApi *apiInstance = [[QueryServiceApi alloc] init];
String *q = q_example; // Lucene query string. (default to null)
Integer *from = 56; // Paging offset. (optional) (default to 0)
Integer *size = 56; // Paging size. (optional) (default to 10)
array[String] *df = ; // The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
String *s = s_example; // Sort order. (optional) (default to null)

// Query units
[apiInstance unitsWith:q
    from:from
    size:size
    df:df
    s:s
              completionHandler: ^(EnvelopeDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.QueryServiceApi()
var q = q_example; // {String} Lucene query string.
var opts = {
  'from': 56, // {Integer} Paging offset.
  'size': 56, // {Integer} Paging size.
  'df': , // {array[String]} The list of default fields to use when no field prefix is defined within the query.
  's': s_example // {String} Sort order.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.units(q, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class unitsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new QueryServiceApi();
            var q = q_example;  // String | Lucene query string. (default to null)
            var from = 56;  // Integer | Paging offset. (optional)  (default to 0)
            var size = 56;  // Integer | Paging size. (optional)  (default to 10)
            var df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query. (optional)  (default to null)
            var s = s_example;  // String | Sort order. (optional)  (default to null)

            try {
                // Query units
                EnvelopeDTO result = apiInstance.units(q, from, size, df, s);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling QueryServiceApi.units: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\QueryServiceApi();
$q = q_example; // String | Lucene query string.
$from = 56; // Integer | Paging offset.
$size = 56; // Integer | Paging size.
$df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
$s = s_example; // String | Sort order.

try {
    $result = $api_instance->units($q, $from, $size, $df, $s);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryServiceApi->units: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::QueryServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::QueryServiceApi->new();
my $q = q_example; # String | Lucene query string.
my $from = 56; # Integer | Paging offset.
my $size = 56; # Integer | Paging size.
my $df = []; # array[String] | The list of default fields to use when no field prefix is defined within the query.
my $s = s_example; # String | Sort order.

eval {
    my $result = $api_instance->units(q => $q, from => $from, size => $size, df => $df, s => $s);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryServiceApi->units: $@\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.QueryServiceApi()
q = q_example # String | Lucene query string. (default to null)
from = 56 # Integer | Paging offset. (optional) (default to 0)
size = 56 # Integer | Paging size. (optional) (default to 10)
df =  # array[String] | The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
s = s_example # String | Sort order. (optional) (default to null)

try:
    # Query units
    api_response = api_instance.units(q, from=from, size=size, df=df, s=s)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryServiceApi->units: %s\n" % e)
extern crate QueryServiceApi;

pub fn main() {
    let q = q_example; // String
    let from = 56; // Integer
    let size = 56; // Integer
    let df = ; // array[String]
    let s = s_example; // String

    let mut context = QueryServiceApi::Context::default();
    let result = client.units(q, from, size, df, s, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
q*
String
Lucene query string.
Required
from
Integer (int32)
Paging offset.
size
Integer (int32)
Paging size.
df
array[String]
The list of default fields to use when no field prefix is defined within the query.
s
String
Sort order.

Responses


units1

units1
get/v1/query/units

Performs a full text search for units.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/v1/query/units?q=q_example&from=56&size=56&df=&s=s_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.QueryServiceApi;

import java.io.File;
import java.util.*;

public class QueryServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.units1(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#units1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String q = new String(); // String | Lucene query string.
final Integer from = new Integer(); // Integer | Paging offset.
final Integer size = new Integer(); // Integer | Paging size.
final array[String] df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query.
final String s = new String(); // String | Sort order.

try {
    final result = await api_instance.units1(q, from, size, df, s);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->units1: $e\n');
}

import org.openapitools.client.api.QueryServiceApi;

public class QueryServiceApiExample {
    public static void main(String[] args) {
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.units1(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#units1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
QueryServiceApi *apiInstance = [[QueryServiceApi alloc] init];
String *q = q_example; // Lucene query string. (default to null)
Integer *from = 56; // Paging offset. (optional) (default to 0)
Integer *size = 56; // Paging size. (optional) (default to 10)
array[String] *df = ; // The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
String *s = s_example; // Sort order. (optional) (default to null)

// Query units
[apiInstance units1With:q
    from:from
    size:size
    df:df
    s:s
              completionHandler: ^(EnvelopeDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.QueryServiceApi()
var q = q_example; // {String} Lucene query string.
var opts = {
  'from': 56, // {Integer} Paging offset.
  'size': 56, // {Integer} Paging size.
  'df': , // {array[String]} The list of default fields to use when no field prefix is defined within the query.
  's': s_example // {String} Sort order.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.units1(q, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class units1Example
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new QueryServiceApi();
            var q = q_example;  // String | Lucene query string. (default to null)
            var from = 56;  // Integer | Paging offset. (optional)  (default to 0)
            var size = 56;  // Integer | Paging size. (optional)  (default to 10)
            var df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query. (optional)  (default to null)
            var s = s_example;  // String | Sort order. (optional)  (default to null)

            try {
                // Query units
                EnvelopeDTO result = apiInstance.units1(q, from, size, df, s);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling QueryServiceApi.units1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\QueryServiceApi();
$q = q_example; // String | Lucene query string.
$from = 56; // Integer | Paging offset.
$size = 56; // Integer | Paging size.
$df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
$s = s_example; // String | Sort order.

try {
    $result = $api_instance->units1($q, $from, $size, $df, $s);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryServiceApi->units1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::QueryServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::QueryServiceApi->new();
my $q = q_example; # String | Lucene query string.
my $from = 56; # Integer | Paging offset.
my $size = 56; # Integer | Paging size.
my $df = []; # array[String] | The list of default fields to use when no field prefix is defined within the query.
my $s = s_example; # String | Sort order.

eval {
    my $result = $api_instance->units1(q => $q, from => $from, size => $size, df => $df, s => $s);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryServiceApi->units1: $@\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.QueryServiceApi()
q = q_example # String | Lucene query string. (default to null)
from = 56 # Integer | Paging offset. (optional) (default to 0)
size = 56 # Integer | Paging size. (optional) (default to 10)
df =  # array[String] | The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
s = s_example # String | Sort order. (optional) (default to null)

try:
    # Query units
    api_response = api_instance.units1(q, from=from, size=size, df=df, s=s)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryServiceApi->units1: %s\n" % e)
extern crate QueryServiceApi;

pub fn main() {
    let q = q_example; // String
    let from = 56; // Integer
    let size = 56; // Integer
    let df = ; // array[String]
    let s = s_example; // String

    let mut context = QueryServiceApi::Context::default();
    let result = client.units1(q, from, size, df, s, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
q*
String
Lucene query string.
Required
from
Integer (int32)
Paging offset.
size
Integer (int32)
Paging size.
df
array[String]
The list of default fields to use when no field prefix is defined within the query.
s
String
Sort order.

Responses


users

users
get/query/v1/users

Performs a full text search for users.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/query/v1/users?q=q_example&from=56&size=56&df=&s=s_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.QueryServiceApi;

import java.io.File;
import java.util.*;

public class QueryServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.users(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#users");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String q = new String(); // String | Lucene query string.
final Integer from = new Integer(); // Integer | Paging offset.
final Integer size = new Integer(); // Integer | Paging size.
final array[String] df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query.
final String s = new String(); // String | Sort order.

try {
    final result = await api_instance.users(q, from, size, df, s);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->users: $e\n');
}

import org.openapitools.client.api.QueryServiceApi;

public class QueryServiceApiExample {
    public static void main(String[] args) {
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.users(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#users");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
QueryServiceApi *apiInstance = [[QueryServiceApi alloc] init];
String *q = q_example; // Lucene query string. (default to null)
Integer *from = 56; // Paging offset. (optional) (default to 0)
Integer *size = 56; // Paging size. (optional) (default to 10)
array[String] *df = ; // The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
String *s = s_example; // Sort order. (optional) (default to null)

// Query users
[apiInstance usersWith:q
    from:from
    size:size
    df:df
    s:s
              completionHandler: ^(EnvelopeDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.QueryServiceApi()
var q = q_example; // {String} Lucene query string.
var opts = {
  'from': 56, // {Integer} Paging offset.
  'size': 56, // {Integer} Paging size.
  'df': , // {array[String]} The list of default fields to use when no field prefix is defined within the query.
  's': s_example // {String} Sort order.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.users(q, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class usersExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new QueryServiceApi();
            var q = q_example;  // String | Lucene query string. (default to null)
            var from = 56;  // Integer | Paging offset. (optional)  (default to 0)
            var size = 56;  // Integer | Paging size. (optional)  (default to 10)
            var df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query. (optional)  (default to null)
            var s = s_example;  // String | Sort order. (optional)  (default to null)

            try {
                // Query users
                EnvelopeDTO result = apiInstance.users(q, from, size, df, s);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling QueryServiceApi.users: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\QueryServiceApi();
$q = q_example; // String | Lucene query string.
$from = 56; // Integer | Paging offset.
$size = 56; // Integer | Paging size.
$df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
$s = s_example; // String | Sort order.

try {
    $result = $api_instance->users($q, $from, $size, $df, $s);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryServiceApi->users: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::QueryServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::QueryServiceApi->new();
my $q = q_example; # String | Lucene query string.
my $from = 56; # Integer | Paging offset.
my $size = 56; # Integer | Paging size.
my $df = []; # array[String] | The list of default fields to use when no field prefix is defined within the query.
my $s = s_example; # String | Sort order.

eval {
    my $result = $api_instance->users(q => $q, from => $from, size => $size, df => $df, s => $s);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryServiceApi->users: $@\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.QueryServiceApi()
q = q_example # String | Lucene query string. (default to null)
from = 56 # Integer | Paging offset. (optional) (default to 0)
size = 56 # Integer | Paging size. (optional) (default to 10)
df =  # array[String] | The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
s = s_example # String | Sort order. (optional) (default to null)

try:
    # Query users
    api_response = api_instance.users(q, from=from, size=size, df=df, s=s)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryServiceApi->users: %s\n" % e)
extern crate QueryServiceApi;

pub fn main() {
    let q = q_example; // String
    let from = 56; // Integer
    let size = 56; // Integer
    let df = ; // array[String]
    let s = s_example; // String

    let mut context = QueryServiceApi::Context::default();
    let result = client.users(q, from, size, df, s, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
q*
String
Lucene query string.
Required
from
Integer (int32)
Paging offset.
size
Integer (int32)
Paging size.
df
array[String]
The list of default fields to use when no field prefix is defined within the query.
s
String
Sort order.

Responses


users1

users1
get/v1/query/users

Performs a full text search for users.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/v1/query/users?q=q_example&from=56&size=56&df=&s=s_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.QueryServiceApi;

import java.io.File;
import java.util.*;

public class QueryServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.users1(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#users1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String q = new String(); // String | Lucene query string.
final Integer from = new Integer(); // Integer | Paging offset.
final Integer size = new Integer(); // Integer | Paging size.
final array[String] df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query.
final String s = new String(); // String | Sort order.

try {
    final result = await api_instance.users1(q, from, size, df, s);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->users1: $e\n');
}

import org.openapitools.client.api.QueryServiceApi;

public class QueryServiceApiExample {
    public static void main(String[] args) {
        QueryServiceApi apiInstance = new QueryServiceApi();
        String q = q_example; // String | Lucene query string.
        Integer from = 56; // Integer | Paging offset.
        Integer size = 56; // Integer | Paging size.
        array[String] df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
        String s = s_example; // String | Sort order.

        try {
            EnvelopeDTO result = apiInstance.users1(q, from, size, df, s);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryServiceApi#users1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
QueryServiceApi *apiInstance = [[QueryServiceApi alloc] init];
String *q = q_example; // Lucene query string. (default to null)
Integer *from = 56; // Paging offset. (optional) (default to 0)
Integer *size = 56; // Paging size. (optional) (default to 10)
array[String] *df = ; // The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
String *s = s_example; // Sort order. (optional) (default to null)

// Query users
[apiInstance users1With:q
    from:from
    size:size
    df:df
    s:s
              completionHandler: ^(EnvelopeDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.QueryServiceApi()
var q = q_example; // {String} Lucene query string.
var opts = {
  'from': 56, // {Integer} Paging offset.
  'size': 56, // {Integer} Paging size.
  'df': , // {array[String]} The list of default fields to use when no field prefix is defined within the query.
  's': s_example // {String} Sort order.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.users1(q, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class users1Example
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new QueryServiceApi();
            var q = q_example;  // String | Lucene query string. (default to null)
            var from = 56;  // Integer | Paging offset. (optional)  (default to 0)
            var size = 56;  // Integer | Paging size. (optional)  (default to 10)
            var df = new array[String](); // array[String] | The list of default fields to use when no field prefix is defined within the query. (optional)  (default to null)
            var s = s_example;  // String | Sort order. (optional)  (default to null)

            try {
                // Query users
                EnvelopeDTO result = apiInstance.users1(q, from, size, df, s);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling QueryServiceApi.users1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\QueryServiceApi();
$q = q_example; // String | Lucene query string.
$from = 56; // Integer | Paging offset.
$size = 56; // Integer | Paging size.
$df = ; // array[String] | The list of default fields to use when no field prefix is defined within the query.
$s = s_example; // String | Sort order.

try {
    $result = $api_instance->users1($q, $from, $size, $df, $s);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryServiceApi->users1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::QueryServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::QueryServiceApi->new();
my $q = q_example; # String | Lucene query string.
my $from = 56; # Integer | Paging offset.
my $size = 56; # Integer | Paging size.
my $df = []; # array[String] | The list of default fields to use when no field prefix is defined within the query.
my $s = s_example; # String | Sort order.

eval {
    my $result = $api_instance->users1(q => $q, from => $from, size => $size, df => $df, s => $s);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryServiceApi->users1: $@\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.QueryServiceApi()
q = q_example # String | Lucene query string. (default to null)
from = 56 # Integer | Paging offset. (optional) (default to 0)
size = 56 # Integer | Paging size. (optional) (default to 10)
df =  # array[String] | The list of default fields to use when no field prefix is defined within the query. (optional) (default to null)
s = s_example # String | Sort order. (optional) (default to null)

try:
    # Query users
    api_response = api_instance.users1(q, from=from, size=size, df=df, s=s)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryServiceApi->users1: %s\n" % e)
extern crate QueryServiceApi;

pub fn main() {
    let q = q_example; // String
    let from = 56; // Integer
    let size = 56; // Integer
    let df = ; // array[String]
    let s = s_example; // String

    let mut context = QueryServiceApi::Context::default();
    let result = client.users1(q, from, size, df, s, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
q*
String
Lucene query string.
Required
from
Integer (int32)
Paging offset.
size
Integer (int32)
Paging size.
df
array[String]
The list of default fields to use when no field prefix is defined within the query.
s
String
Sort order.

Responses


RecoveryCodeLoginRESTService

useRecoveryCode

useRecoveryCode
post/auth/v1/{clientExtId}/users/{userExtId}/recovery-codes/login

**Since:** 2.78.0 **Required permission(s):** `AccessControl.CredentialView,AccessControl.CredentialModify,AccessControl.CredentialChangeState` Log in with the defined recovery code credential of the user.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/auth/v1/{clientExtId}/users/{userExtId}/recovery-codes/login" \
 -d '{
  "code" : "recovery-code-123"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RecoveryCodeLoginRESTServiceApi;

import java.io.File;
import java.util.*;

public class RecoveryCodeLoginRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        RecoveryCodeLoginRESTServiceApi apiInstance = new RecoveryCodeLoginRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        RecoveryCodeLoginDTO recoveryCodeLoginDTO = {"code":"abcd-efgh-1234-5678"}; // RecoveryCodeLoginDTO | 

        try {
            apiInstance.useRecoveryCode(clientExtId, userExtId, recoveryCodeLoginDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecoveryCodeLoginRESTServiceApi#useRecoveryCode");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final RecoveryCodeLoginDTO recoveryCodeLoginDTO = new RecoveryCodeLoginDTO(); // RecoveryCodeLoginDTO | 

try {
    final result = await api_instance.useRecoveryCode(clientExtId, userExtId, recoveryCodeLoginDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->useRecoveryCode: $e\n');
}

import org.openapitools.client.api.RecoveryCodeLoginRESTServiceApi;

public class RecoveryCodeLoginRESTServiceApiExample {
    public static void main(String[] args) {
        RecoveryCodeLoginRESTServiceApi apiInstance = new RecoveryCodeLoginRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        RecoveryCodeLoginDTO recoveryCodeLoginDTO = {"code":"abcd-efgh-1234-5678"}; // RecoveryCodeLoginDTO | 

        try {
            apiInstance.useRecoveryCode(clientExtId, userExtId, recoveryCodeLoginDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecoveryCodeLoginRESTServiceApi#useRecoveryCode");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RecoveryCodeLoginRESTServiceApi *apiInstance = [[RecoveryCodeLoginRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
RecoveryCodeLoginDTO *recoveryCodeLoginDTO = {"code":"abcd-efgh-1234-5678"}; // 

// Login with recovery code credential
[apiInstance useRecoveryCodeWith:clientExtId
    userExtId:userExtId
    recoveryCodeLoginDTO:recoveryCodeLoginDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.RecoveryCodeLoginRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var recoveryCodeLoginDTO = {"code":"abcd-efgh-1234-5678"}; // {RecoveryCodeLoginDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.useRecoveryCode(clientExtId, userExtId, recoveryCodeLoginDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class useRecoveryCodeExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new RecoveryCodeLoginRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var recoveryCodeLoginDTO = new RecoveryCodeLoginDTO(); // RecoveryCodeLoginDTO | 

            try {
                // Login with recovery code credential
                apiInstance.useRecoveryCode(clientExtId, userExtId, recoveryCodeLoginDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling RecoveryCodeLoginRESTServiceApi.useRecoveryCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RecoveryCodeLoginRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$recoveryCodeLoginDTO = {"code":"abcd-efgh-1234-5678"}; // RecoveryCodeLoginDTO | 

try {
    $api_instance->useRecoveryCode($clientExtId, $userExtId, $recoveryCodeLoginDTO);
} catch (Exception $e) {
    echo 'Exception when calling RecoveryCodeLoginRESTServiceApi->useRecoveryCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RecoveryCodeLoginRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RecoveryCodeLoginRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $recoveryCodeLoginDTO = WWW::OPenAPIClient::Object::RecoveryCodeLoginDTO->new(); # RecoveryCodeLoginDTO | 

eval {
    $api_instance->useRecoveryCode(clientExtId => $clientExtId, userExtId => $userExtId, recoveryCodeLoginDTO => $recoveryCodeLoginDTO);
};
if ($@) {
    warn "Exception when calling RecoveryCodeLoginRESTServiceApi->useRecoveryCode: $@\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.RecoveryCodeLoginRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
recoveryCodeLoginDTO = {"code":"abcd-efgh-1234-5678"} # RecoveryCodeLoginDTO | 

try:
    # Login with recovery code credential
    api_instance.use_recovery_code(clientExtId, userExtId, recoveryCodeLoginDTO)
except ApiException as e:
    print("Exception when calling RecoveryCodeLoginRESTServiceApi->useRecoveryCode: %s\n" % e)
extern crate RecoveryCodeLoginRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let recoveryCodeLoginDTO = {"code":"abcd-efgh-1234-5678"}; // RecoveryCodeLoginDTO

    let mut context = RecoveryCodeLoginRESTServiceApi::Context::default();
    let result = client.useRecoveryCode(clientExtId, userExtId, recoveryCodeLoginDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
recoveryCodeLoginDTO *

Responses


RecoveryCodeRESTService

createRecoveryCodes

createRecoveryCodes
post/core/v1/{clientExtId}/users/{userExtId}/recovery-codes

**Since:** 2.78.0 **Required permission(s):** `AccessControl.CredentialCreate,AccessControl.CredentialModify` or `SelfAdmin` Role Creates a recovery code credential and generates 16 new recovery codes for the user with the given external ID. If the user already had a recovery code credential, this call deletes all the recovery codes and generates new ones.

Usage and SDK Samples

curl -X POST \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/recovery-codes"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RecoveryCodeRESTServiceApi;

import java.io.File;
import java.util.*;

public class RecoveryCodeRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        RecoveryCodeRESTServiceApi apiInstance = new RecoveryCodeRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            apiInstance.createRecoveryCodes(clientExtId, userExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecoveryCodeRESTServiceApi#createRecoveryCodes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user

try {
    final result = await api_instance.createRecoveryCodes(clientExtId, userExtId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createRecoveryCodes: $e\n');
}

import org.openapitools.client.api.RecoveryCodeRESTServiceApi;

public class RecoveryCodeRESTServiceApiExample {
    public static void main(String[] args) {
        RecoveryCodeRESTServiceApi apiInstance = new RecoveryCodeRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            apiInstance.createRecoveryCodes(clientExtId, userExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecoveryCodeRESTServiceApi#createRecoveryCodes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RecoveryCodeRESTServiceApi *apiInstance = [[RecoveryCodeRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)

// Create Recovery Codes
[apiInstance createRecoveryCodesWith:clientExtId
    userExtId:userExtId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.RecoveryCodeRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createRecoveryCodes(clientExtId, userExtId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createRecoveryCodesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new RecoveryCodeRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)

            try {
                // Create Recovery Codes
                apiInstance.createRecoveryCodes(clientExtId, userExtId);
            } catch (Exception e) {
                Debug.Print("Exception when calling RecoveryCodeRESTServiceApi.createRecoveryCodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RecoveryCodeRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user

try {
    $api_instance->createRecoveryCodes($clientExtId, $userExtId);
} catch (Exception $e) {
    echo 'Exception when calling RecoveryCodeRESTServiceApi->createRecoveryCodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RecoveryCodeRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RecoveryCodeRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user

eval {
    $api_instance->createRecoveryCodes(clientExtId => $clientExtId, userExtId => $userExtId);
};
if ($@) {
    warn "Exception when calling RecoveryCodeRESTServiceApi->createRecoveryCodes: $@\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.RecoveryCodeRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)

try:
    # Create Recovery Codes
    api_instance.create_recovery_codes(clientExtId, userExtId)
except ApiException as e:
    print("Exception when calling RecoveryCodeRESTServiceApi->createRecoveryCodes: %s\n" % e)
extern crate RecoveryCodeRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String

    let mut context = RecoveryCodeRESTServiceApi::Context::default();
    let result = client.createRecoveryCodes(clientExtId, userExtId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required

Responses


deleteRecoveryCode

deleteRecoveryCode
delete/core/v1/{clientExtId}/users/{userExtId}/recovery-codes

**Since:** 2.78.0 **Required permission(s):** `AccessControl.CredentialDelete` or `SelfAdmin` Role Deletes the recovery code credential including all the 16 recovery codes of the user with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/recovery-codes"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RecoveryCodeRESTServiceApi;

import java.io.File;
import java.util.*;

public class RecoveryCodeRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        RecoveryCodeRESTServiceApi apiInstance = new RecoveryCodeRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            apiInstance.deleteRecoveryCode(clientExtId, userExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecoveryCodeRESTServiceApi#deleteRecoveryCode");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user

try {
    final result = await api_instance.deleteRecoveryCode(clientExtId, userExtId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteRecoveryCode: $e\n');
}

import org.openapitools.client.api.RecoveryCodeRESTServiceApi;

public class RecoveryCodeRESTServiceApiExample {
    public static void main(String[] args) {
        RecoveryCodeRESTServiceApi apiInstance = new RecoveryCodeRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            apiInstance.deleteRecoveryCode(clientExtId, userExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecoveryCodeRESTServiceApi#deleteRecoveryCode");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RecoveryCodeRESTServiceApi *apiInstance = [[RecoveryCodeRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)

// Delete Recovery Codes
[apiInstance deleteRecoveryCodeWith:clientExtId
    userExtId:userExtId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.RecoveryCodeRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteRecoveryCode(clientExtId, userExtId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteRecoveryCodeExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new RecoveryCodeRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)

            try {
                // Delete Recovery Codes
                apiInstance.deleteRecoveryCode(clientExtId, userExtId);
            } catch (Exception e) {
                Debug.Print("Exception when calling RecoveryCodeRESTServiceApi.deleteRecoveryCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RecoveryCodeRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user

try {
    $api_instance->deleteRecoveryCode($clientExtId, $userExtId);
} catch (Exception $e) {
    echo 'Exception when calling RecoveryCodeRESTServiceApi->deleteRecoveryCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RecoveryCodeRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RecoveryCodeRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user

eval {
    $api_instance->deleteRecoveryCode(clientExtId => $clientExtId, userExtId => $userExtId);
};
if ($@) {
    warn "Exception when calling RecoveryCodeRESTServiceApi->deleteRecoveryCode: $@\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.RecoveryCodeRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)

try:
    # Delete Recovery Codes
    api_instance.delete_recovery_code(clientExtId, userExtId)
except ApiException as e:
    print("Exception when calling RecoveryCodeRESTServiceApi->deleteRecoveryCode: %s\n" % e)
extern crate RecoveryCodeRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String

    let mut context = RecoveryCodeRESTServiceApi::Context::default();
    let result = client.deleteRecoveryCode(clientExtId, userExtId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required

Responses


getRecoveryCodes

getRecoveryCodes
get/core/v1/{clientExtId}/users/{userExtId}/recovery-codes

**Since:** 2.78.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns the recovery code credential including all the 16 recovery codes of the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/recovery-codes"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RecoveryCodeRESTServiceApi;

import java.io.File;
import java.util.*;

public class RecoveryCodeRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        RecoveryCodeRESTServiceApi apiInstance = new RecoveryCodeRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            RecoveryCodeGetDTO result = apiInstance.getRecoveryCodes(clientExtId, userExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecoveryCodeRESTServiceApi#getRecoveryCodes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user

try {
    final result = await api_instance.getRecoveryCodes(clientExtId, userExtId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getRecoveryCodes: $e\n');
}

import org.openapitools.client.api.RecoveryCodeRESTServiceApi;

public class RecoveryCodeRESTServiceApiExample {
    public static void main(String[] args) {
        RecoveryCodeRESTServiceApi apiInstance = new RecoveryCodeRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            RecoveryCodeGetDTO result = apiInstance.getRecoveryCodes(clientExtId, userExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecoveryCodeRESTServiceApi#getRecoveryCodes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RecoveryCodeRESTServiceApi *apiInstance = [[RecoveryCodeRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)

// Get Recovery Codes
[apiInstance getRecoveryCodesWith:clientExtId
    userExtId:userExtId
              completionHandler: ^(RecoveryCodeGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.RecoveryCodeRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRecoveryCodes(clientExtId, userExtId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getRecoveryCodesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new RecoveryCodeRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)

            try {
                // Get Recovery Codes
                RecoveryCodeGetDTO result = apiInstance.getRecoveryCodes(clientExtId, userExtId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RecoveryCodeRESTServiceApi.getRecoveryCodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RecoveryCodeRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user

try {
    $result = $api_instance->getRecoveryCodes($clientExtId, $userExtId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecoveryCodeRESTServiceApi->getRecoveryCodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RecoveryCodeRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RecoveryCodeRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user

eval {
    my $result = $api_instance->getRecoveryCodes(clientExtId => $clientExtId, userExtId => $userExtId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RecoveryCodeRESTServiceApi->getRecoveryCodes: $@\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.RecoveryCodeRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)

try:
    # Get Recovery Codes
    api_response = api_instance.get_recovery_codes(clientExtId, userExtId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RecoveryCodeRESTServiceApi->getRecoveryCodes: %s\n" % e)
extern crate RecoveryCodeRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String

    let mut context = RecoveryCodeRESTServiceApi::Context::default();
    let result = client.getRecoveryCodes(clientExtId, userExtId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required

Responses


updateRecoveryCode

updateRecoveryCode
patch/core/v1/{clientExtId}/users/{userExtId}/recovery-codes

**Since:** 2.78.0 **Required permission(s):** `AccessControl.CredentialView,AccessControl.CredentialModify` or `SelfAdmin` Role Updates the recovery code credential of the user with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/recovery-codes" \
 -d '{
  "stateName" : "ACTIVE",
  "modificationComment" : "modificationComment",
  "version" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RecoveryCodeRESTServiceApi;

import java.io.File;
import java.util.*;

public class RecoveryCodeRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        RecoveryCodeRESTServiceApi apiInstance = new RecoveryCodeRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        RecoveryCodePatchDto recoveryCodePatchDto = {"version":10,"modificationComment":"Inactivated by admin","stateName":"disabled"}; // RecoveryCodePatchDto | 

        try {
            RecoveryCodeGetDTO result = apiInstance.updateRecoveryCode(clientExtId, userExtId, recoveryCodePatchDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecoveryCodeRESTServiceApi#updateRecoveryCode");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final RecoveryCodePatchDto recoveryCodePatchDto = new RecoveryCodePatchDto(); // RecoveryCodePatchDto | 

try {
    final result = await api_instance.updateRecoveryCode(clientExtId, userExtId, recoveryCodePatchDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateRecoveryCode: $e\n');
}

import org.openapitools.client.api.RecoveryCodeRESTServiceApi;

public class RecoveryCodeRESTServiceApiExample {
    public static void main(String[] args) {
        RecoveryCodeRESTServiceApi apiInstance = new RecoveryCodeRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        RecoveryCodePatchDto recoveryCodePatchDto = {"version":10,"modificationComment":"Inactivated by admin","stateName":"disabled"}; // RecoveryCodePatchDto | 

        try {
            RecoveryCodeGetDTO result = apiInstance.updateRecoveryCode(clientExtId, userExtId, recoveryCodePatchDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecoveryCodeRESTServiceApi#updateRecoveryCode");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RecoveryCodeRESTServiceApi *apiInstance = [[RecoveryCodeRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
RecoveryCodePatchDto *recoveryCodePatchDto = {"version":10,"modificationComment":"Inactivated by admin","stateName":"disabled"}; // 

// Update Recovery Codes
[apiInstance updateRecoveryCodeWith:clientExtId
    userExtId:userExtId
    recoveryCodePatchDto:recoveryCodePatchDto
              completionHandler: ^(RecoveryCodeGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.RecoveryCodeRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var recoveryCodePatchDto = {"version":10,"modificationComment":"Inactivated by admin","stateName":"disabled"}; // {RecoveryCodePatchDto} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateRecoveryCode(clientExtId, userExtId, recoveryCodePatchDto, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateRecoveryCodeExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new RecoveryCodeRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var recoveryCodePatchDto = new RecoveryCodePatchDto(); // RecoveryCodePatchDto | 

            try {
                // Update Recovery Codes
                RecoveryCodeGetDTO result = apiInstance.updateRecoveryCode(clientExtId, userExtId, recoveryCodePatchDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RecoveryCodeRESTServiceApi.updateRecoveryCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RecoveryCodeRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$recoveryCodePatchDto = {"version":10,"modificationComment":"Inactivated by admin","stateName":"disabled"}; // RecoveryCodePatchDto | 

try {
    $result = $api_instance->updateRecoveryCode($clientExtId, $userExtId, $recoveryCodePatchDto);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecoveryCodeRESTServiceApi->updateRecoveryCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RecoveryCodeRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RecoveryCodeRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $recoveryCodePatchDto = WWW::OPenAPIClient::Object::RecoveryCodePatchDto->new(); # RecoveryCodePatchDto | 

eval {
    my $result = $api_instance->updateRecoveryCode(clientExtId => $clientExtId, userExtId => $userExtId, recoveryCodePatchDto => $recoveryCodePatchDto);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RecoveryCodeRESTServiceApi->updateRecoveryCode: $@\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.RecoveryCodeRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
recoveryCodePatchDto = {"version":10,"modificationComment":"Inactivated by admin","stateName":"disabled"} # RecoveryCodePatchDto | 

try:
    # Update Recovery Codes
    api_response = api_instance.update_recovery_code(clientExtId, userExtId, recoveryCodePatchDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RecoveryCodeRESTServiceApi->updateRecoveryCode: %s\n" % e)
extern crate RecoveryCodeRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let recoveryCodePatchDto = {"version":10,"modificationComment":"Inactivated by admin","stateName":"disabled"}; // RecoveryCodePatchDto

    let mut context = RecoveryCodeRESTServiceApi::Context::default();
    let result = client.updateRecoveryCode(clientExtId, userExtId, recoveryCodePatchDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
recoveryCodePatchDto *

Responses


RoleRESTService

deleteRoleByExtId

deleteRoleByExtId
delete/core/v1/roles/{extId}

**Since:** 2.74.0 **Required permission(s):** `AccessControl.RoleDelete` Deletes the role with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/roles/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoleRESTServiceApi;

import java.io.File;
import java.util.*;

public class RoleRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        RoleRESTServiceApi apiInstance = new RoleRESTServiceApi();
        String extId = 231; // String | ExtID of the role

        try {
            apiInstance.deleteRoleByExtId(extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleRESTServiceApi#deleteRoleByExtId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the role

try {
    final result = await api_instance.deleteRoleByExtId(extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteRoleByExtId: $e\n');
}

import org.openapitools.client.api.RoleRESTServiceApi;

public class RoleRESTServiceApiExample {
    public static void main(String[] args) {
        RoleRESTServiceApi apiInstance = new RoleRESTServiceApi();
        String extId = 231; // String | ExtID of the role

        try {
            apiInstance.deleteRoleByExtId(extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleRESTServiceApi#deleteRoleByExtId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoleRESTServiceApi *apiInstance = [[RoleRESTServiceApi alloc] init];
String *extId = 231; // ExtID of the role (default to null)

// Delete role
[apiInstance deleteRoleByExtIdWith:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.RoleRESTServiceApi()
var extId = 231; // {String} ExtID of the role

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteRoleByExtId(extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteRoleByExtIdExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new RoleRESTServiceApi();
            var extId = 231;  // String | ExtID of the role (default to null)

            try {
                // Delete role
                apiInstance.deleteRoleByExtId(extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoleRESTServiceApi.deleteRoleByExtId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoleRESTServiceApi();
$extId = 231; // String | ExtID of the role

try {
    $api_instance->deleteRoleByExtId($extId);
} catch (Exception $e) {
    echo 'Exception when calling RoleRESTServiceApi->deleteRoleByExtId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoleRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoleRESTServiceApi->new();
my $extId = 231; # String | ExtID of the role

eval {
    $api_instance->deleteRoleByExtId(extId => $extId);
};
if ($@) {
    warn "Exception when calling RoleRESTServiceApi->deleteRoleByExtId: $@\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.RoleRESTServiceApi()
extId = 231 # String | ExtID of the role (default to null)

try:
    # Delete role
    api_instance.delete_role_by_ext_id(extId)
except ApiException as e:
    print("Exception when calling RoleRESTServiceApi->deleteRoleByExtId: %s\n" % e)
extern crate RoleRESTServiceApi;

pub fn main() {
    let extId = 231; // String

    let mut context = RoleRESTServiceApi::Context::default();
    let result = client.deleteRoleByExtId(extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the role
Required

Responses


getRoleByExtId

getRoleByExtId
get/core/v1/roles/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.RoleView` Returns the role with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/roles/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoleRESTServiceApi;

import java.io.File;
import java.util.*;

public class RoleRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        RoleRESTServiceApi apiInstance = new RoleRESTServiceApi();
        String extId = 231; // String | ExtID of the role

        try {
            RoleGetDTO result = apiInstance.getRoleByExtId(extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleRESTServiceApi#getRoleByExtId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the role

try {
    final result = await api_instance.getRoleByExtId(extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getRoleByExtId: $e\n');
}

import org.openapitools.client.api.RoleRESTServiceApi;

public class RoleRESTServiceApiExample {
    public static void main(String[] args) {
        RoleRESTServiceApi apiInstance = new RoleRESTServiceApi();
        String extId = 231; // String | ExtID of the role

        try {
            RoleGetDTO result = apiInstance.getRoleByExtId(extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleRESTServiceApi#getRoleByExtId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoleRESTServiceApi *apiInstance = [[RoleRESTServiceApi alloc] init];
String *extId = 231; // ExtID of the role (default to null)

// Get role
[apiInstance getRoleByExtIdWith:extId
              completionHandler: ^(RoleGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.RoleRESTServiceApi()
var extId = 231; // {String} ExtID of the role

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRoleByExtId(extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getRoleByExtIdExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new RoleRESTServiceApi();
            var extId = 231;  // String | ExtID of the role (default to null)

            try {
                // Get role
                RoleGetDTO result = apiInstance.getRoleByExtId(extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoleRESTServiceApi.getRoleByExtId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoleRESTServiceApi();
$extId = 231; // String | ExtID of the role

try {
    $result = $api_instance->getRoleByExtId($extId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoleRESTServiceApi->getRoleByExtId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoleRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoleRESTServiceApi->new();
my $extId = 231; # String | ExtID of the role

eval {
    my $result = $api_instance->getRoleByExtId(extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoleRESTServiceApi->getRoleByExtId: $@\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.RoleRESTServiceApi()
extId = 231 # String | ExtID of the role (default to null)

try:
    # Get role
    api_response = api_instance.get_role_by_ext_id(extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleRESTServiceApi->getRoleByExtId: %s\n" % e)
extern crate RoleRESTServiceApi;

pub fn main() {
    let extId = 231; // String

    let mut context = RoleRESTServiceApi::Context::default();
    let result = client.getRoleByExtId(extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the role
Required

Responses


getRoleProperties

getRoleProperties
get/core/v1/roles/{extId}/properties

**Since:** 2.74.0 **Required permission(s):** `AccessControl.RoleView,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView` Returns all properties of the role with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/roles/{extId}/properties"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoleRESTServiceApi;

import java.io.File;
import java.util.*;

public class RoleRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        RoleRESTServiceApi apiInstance = new RoleRESTServiceApi();
        String extId = 232; // String | ExtID of the role

        try {
            map['String', 'String'] result = apiInstance.getRoleProperties(extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleRESTServiceApi#getRoleProperties");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the role

try {
    final result = await api_instance.getRoleProperties(extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getRoleProperties: $e\n');
}

import org.openapitools.client.api.RoleRESTServiceApi;

public class RoleRESTServiceApiExample {
    public static void main(String[] args) {
        RoleRESTServiceApi apiInstance = new RoleRESTServiceApi();
        String extId = 232; // String | ExtID of the role

        try {
            map['String', 'String'] result = apiInstance.getRoleProperties(extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleRESTServiceApi#getRoleProperties");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoleRESTServiceApi *apiInstance = [[RoleRESTServiceApi alloc] init];
String *extId = 232; // ExtID of the role (default to null)

// Get properties
[apiInstance getRolePropertiesWith:extId
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.RoleRESTServiceApi()
var extId = 232; // {String} ExtID of the role

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRoleProperties(extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getRolePropertiesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new RoleRESTServiceApi();
            var extId = 232;  // String | ExtID of the role (default to null)

            try {
                // Get properties
                map['String', 'String'] result = apiInstance.getRoleProperties(extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoleRESTServiceApi.getRoleProperties: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoleRESTServiceApi();
$extId = 232; // String | ExtID of the role

try {
    $result = $api_instance->getRoleProperties($extId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoleRESTServiceApi->getRoleProperties: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoleRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoleRESTServiceApi->new();
my $extId = 232; # String | ExtID of the role

eval {
    my $result = $api_instance->getRoleProperties(extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoleRESTServiceApi->getRoleProperties: $@\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.RoleRESTServiceApi()
extId = 232 # String | ExtID of the role (default to null)

try:
    # Get properties
    api_response = api_instance.get_role_properties(extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleRESTServiceApi->getRoleProperties: %s\n" % e)
extern crate RoleRESTServiceApi;

pub fn main() {
    let extId = 232; // String

    let mut context = RoleRESTServiceApi::Context::default();
    let result = client.getRoleProperties(extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the role
Required

Responses


patchRoleByExtId

patchRoleByExtId
patch/core/v1/roles/{extId}

**Since:** 2.74.0 **Required permission(s):** `AccessControl.RoleView,AccessControl.RoleModify` Updates the role with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/roles/{extId}" \
 -d '{
  "name" : "name",
  "description" : "description",
  "version" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoleRESTServiceApi;

import java.io.File;
import java.util.*;

public class RoleRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        RoleRESTServiceApi apiInstance = new RoleRESTServiceApi();
        String extId = 231; // String | ExtID of the role
        RolePatchDTO rolePatchDTO = {"version":1,"name":"regularRole","description":"regular role of normal users"}; // RolePatchDTO | 

        try {
            RoleGetDTO result = apiInstance.patchRoleByExtId(extId, rolePatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleRESTServiceApi#patchRoleByExtId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the role
final RolePatchDTO rolePatchDTO = new RolePatchDTO(); // RolePatchDTO | 

try {
    final result = await api_instance.patchRoleByExtId(extId, rolePatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchRoleByExtId: $e\n');
}

import org.openapitools.client.api.RoleRESTServiceApi;

public class RoleRESTServiceApiExample {
    public static void main(String[] args) {
        RoleRESTServiceApi apiInstance = new RoleRESTServiceApi();
        String extId = 231; // String | ExtID of the role
        RolePatchDTO rolePatchDTO = {"version":1,"name":"regularRole","description":"regular role of normal users"}; // RolePatchDTO | 

        try {
            RoleGetDTO result = apiInstance.patchRoleByExtId(extId, rolePatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleRESTServiceApi#patchRoleByExtId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoleRESTServiceApi *apiInstance = [[RoleRESTServiceApi alloc] init];
String *extId = 231; // ExtID of the role (default to null)
RolePatchDTO *rolePatchDTO = {"version":1,"name":"regularRole","description":"regular role of normal users"}; // 

// Update role
[apiInstance patchRoleByExtIdWith:extId
    rolePatchDTO:rolePatchDTO
              completionHandler: ^(RoleGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.RoleRESTServiceApi()
var extId = 231; // {String} ExtID of the role
var rolePatchDTO = {"version":1,"name":"regularRole","description":"regular role of normal users"}; // {RolePatchDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchRoleByExtId(extId, rolePatchDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class patchRoleByExtIdExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new RoleRESTServiceApi();
            var extId = 231;  // String | ExtID of the role (default to null)
            var rolePatchDTO = new RolePatchDTO(); // RolePatchDTO | 

            try {
                // Update role
                RoleGetDTO result = apiInstance.patchRoleByExtId(extId, rolePatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoleRESTServiceApi.patchRoleByExtId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoleRESTServiceApi();
$extId = 231; // String | ExtID of the role
$rolePatchDTO = {"version":1,"name":"regularRole","description":"regular role of normal users"}; // RolePatchDTO | 

try {
    $result = $api_instance->patchRoleByExtId($extId, $rolePatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoleRESTServiceApi->patchRoleByExtId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoleRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoleRESTServiceApi->new();
my $extId = 231; # String | ExtID of the role
my $rolePatchDTO = WWW::OPenAPIClient::Object::RolePatchDTO->new(); # RolePatchDTO | 

eval {
    my $result = $api_instance->patchRoleByExtId(extId => $extId, rolePatchDTO => $rolePatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoleRESTServiceApi->patchRoleByExtId: $@\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.RoleRESTServiceApi()
extId = 231 # String | ExtID of the role (default to null)
rolePatchDTO = {"version":1,"name":"regularRole","description":"regular role of normal users"} # RolePatchDTO | 

try:
    # Update role
    api_response = api_instance.patch_role_by_ext_id(extId, rolePatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleRESTServiceApi->patchRoleByExtId: %s\n" % e)
extern crate RoleRESTServiceApi;

pub fn main() {
    let extId = 231; // String
    let rolePatchDTO = {"version":1,"name":"regularRole","description":"regular role of normal users"}; // RolePatchDTO

    let mut context = RoleRESTServiceApi::Context::default();
    let result = client.patchRoleByExtId(extId, rolePatchDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the role
Required
Body parameters
Name Description
rolePatchDTO *

Responses


updateProperties5

updateProperties5
patch/core/v1/roles/{roleExtId}/properties

**Since:** 2.74.0 **Required permission(s):** `AccessControl.RoleView,AccessControl.RoleModify,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView,AccessControl.PropertyValueCreate,AccessControl.PropertyValueDelete,AccessControl.PropertyValueModify` Updates the properties of a role with given external ID of the role.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/roles/{roleExtId}/properties" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoleRESTServiceApi;

import java.io.File;
import java.util.*;

public class RoleRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        RoleRESTServiceApi apiInstance = new RoleRESTServiceApi();
        String roleExtId = 232; // String | ExtID of the role
        map[String, String] requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String] | 

        try {
            map['String', 'String'] result = apiInstance.updateProperties5(roleExtId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleRESTServiceApi#updateProperties5");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String roleExtId = new String(); // String | ExtID of the role
final map[String, String] requestBody = new map[String, String](); // map[String, String] | 

try {
    final result = await api_instance.updateProperties5(roleExtId, requestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateProperties5: $e\n');
}

import org.openapitools.client.api.RoleRESTServiceApi;

public class RoleRESTServiceApiExample {
    public static void main(String[] args) {
        RoleRESTServiceApi apiInstance = new RoleRESTServiceApi();
        String roleExtId = 232; // String | ExtID of the role
        map[String, String] requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String] | 

        try {
            map['String', 'String'] result = apiInstance.updateProperties5(roleExtId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoleRESTServiceApi#updateProperties5");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoleRESTServiceApi *apiInstance = [[RoleRESTServiceApi alloc] init];
String *roleExtId = 232; // ExtID of the role (default to null)
map[String, String] *requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // 

// Update role properties
[apiInstance updateProperties5With:roleExtId
    requestBody:requestBody
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.RoleRESTServiceApi()
var roleExtId = 232; // {String} ExtID of the role
var requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // {map[String, String]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateProperties5(roleExtId, requestBody, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateProperties5Example
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new RoleRESTServiceApi();
            var roleExtId = 232;  // String | ExtID of the role (default to null)
            var requestBody = new map[String, String](); // map[String, String] | 

            try {
                // Update role properties
                map['String', 'String'] result = apiInstance.updateProperties5(roleExtId, requestBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoleRESTServiceApi.updateProperties5: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoleRESTServiceApi();
$roleExtId = 232; // String | ExtID of the role
$requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String] | 

try {
    $result = $api_instance->updateProperties5($roleExtId, $requestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoleRESTServiceApi->updateProperties5: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoleRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoleRESTServiceApi->new();
my $roleExtId = 232; # String | ExtID of the role
my $requestBody = WWW::OPenAPIClient::Object::map[String, String]->new(); # map[String, String] | 

eval {
    my $result = $api_instance->updateProperties5(roleExtId => $roleExtId, requestBody => $requestBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoleRESTServiceApi->updateProperties5: $@\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.RoleRESTServiceApi()
roleExtId = 232 # String | ExtID of the role (default to null)
requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3} # map[String, String] | 

try:
    # Update role properties
    api_response = api_instance.update_properties5(roleExtId, requestBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleRESTServiceApi->updateProperties5: %s\n" % e)
extern crate RoleRESTServiceApi;

pub fn main() {
    let roleExtId = 232; // String
    let requestBody = {propertyKey1=propertyNewValue1, propertyKey3=propertyNewValue3}; // map[String, String]

    let mut context = RoleRESTServiceApi::Context::default();
    let result = client.updateProperties5(roleExtId, requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
roleExtId*
String
ExtID of the role
Required
Body parameters
Name Description
requestBody *

Responses


SAMLFederationRESTService

createSAMLCredentialRestService

createSAMLCredentialRestService
post/core/v1/{clientExtId}/users/{userExtId}/saml-credentials

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialCreate,AccessControl.CredentialChangeState,AccessControl.CredentialView` Creates a SAML Federation credential for the user with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/saml-credentials" \
 -d '{
  "issuerNameId" : "issuerNameId",
  "policyExtId" : "policyExtId",
  "issuerNameIdFormat" : "issuerNameIdFormat",
  "stateName" : "ACTIVE",
  "subjectNameIdFormat" : "subjectNameIdFormat",
  "extId" : "extId",
  "subjectNameId" : "subjectNameId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SAMLFederationRESTServiceApi;

import java.io.File;
import java.util.*;

public class SAMLFederationRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SAMLFederationRESTServiceApi apiInstance = new SAMLFederationRESTServiceApi();
        String clientExtId = clientExtId_example; // String | 
        String userExtId = userExtId_example; // String | 
        SAMLCreateDTO sAMLCreateDTO = {"subjectNameId":"ssdf3","subjectNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","issuerNameId":"cssdf","issuerNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"}; // SAMLCreateDTO | 

        try {
            apiInstance.createSAMLCredentialRestService(clientExtId, userExtId, sAMLCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling SAMLFederationRESTServiceApi#createSAMLCredentialRestService");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | 
final String userExtId = new String(); // String | 
final SAMLCreateDTO sAMLCreateDTO = new SAMLCreateDTO(); // SAMLCreateDTO | 

try {
    final result = await api_instance.createSAMLCredentialRestService(clientExtId, userExtId, sAMLCreateDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createSAMLCredentialRestService: $e\n');
}

import org.openapitools.client.api.SAMLFederationRESTServiceApi;

public class SAMLFederationRESTServiceApiExample {
    public static void main(String[] args) {
        SAMLFederationRESTServiceApi apiInstance = new SAMLFederationRESTServiceApi();
        String clientExtId = clientExtId_example; // String | 
        String userExtId = userExtId_example; // String | 
        SAMLCreateDTO sAMLCreateDTO = {"subjectNameId":"ssdf3","subjectNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","issuerNameId":"cssdf","issuerNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"}; // SAMLCreateDTO | 

        try {
            apiInstance.createSAMLCredentialRestService(clientExtId, userExtId, sAMLCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling SAMLFederationRESTServiceApi#createSAMLCredentialRestService");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SAMLFederationRESTServiceApi *apiInstance = [[SAMLFederationRESTServiceApi alloc] init];
String *clientExtId = clientExtId_example; //  (default to null)
String *userExtId = userExtId_example; //  (default to null)
SAMLCreateDTO *sAMLCreateDTO = {"subjectNameId":"ssdf3","subjectNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","issuerNameId":"cssdf","issuerNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"}; // 

// Create SAML Federation Credential
[apiInstance createSAMLCredentialRestServiceWith:clientExtId
    userExtId:userExtId
    sAMLCreateDTO:sAMLCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SAMLFederationRESTServiceApi()
var clientExtId = clientExtId_example; // {String} 
var userExtId = userExtId_example; // {String} 
var sAMLCreateDTO = {"subjectNameId":"ssdf3","subjectNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","issuerNameId":"cssdf","issuerNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"}; // {SAMLCreateDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createSAMLCredentialRestService(clientExtId, userExtId, sAMLCreateDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createSAMLCredentialRestServiceExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SAMLFederationRESTServiceApi();
            var clientExtId = clientExtId_example;  // String |  (default to null)
            var userExtId = userExtId_example;  // String |  (default to null)
            var sAMLCreateDTO = new SAMLCreateDTO(); // SAMLCreateDTO | 

            try {
                // Create SAML Federation Credential
                apiInstance.createSAMLCredentialRestService(clientExtId, userExtId, sAMLCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling SAMLFederationRESTServiceApi.createSAMLCredentialRestService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SAMLFederationRESTServiceApi();
$clientExtId = clientExtId_example; // String | 
$userExtId = userExtId_example; // String | 
$sAMLCreateDTO = {"subjectNameId":"ssdf3","subjectNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","issuerNameId":"cssdf","issuerNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"}; // SAMLCreateDTO | 

try {
    $api_instance->createSAMLCredentialRestService($clientExtId, $userExtId, $sAMLCreateDTO);
} catch (Exception $e) {
    echo 'Exception when calling SAMLFederationRESTServiceApi->createSAMLCredentialRestService: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SAMLFederationRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SAMLFederationRESTServiceApi->new();
my $clientExtId = clientExtId_example; # String | 
my $userExtId = userExtId_example; # String | 
my $sAMLCreateDTO = WWW::OPenAPIClient::Object::SAMLCreateDTO->new(); # SAMLCreateDTO | 

eval {
    $api_instance->createSAMLCredentialRestService(clientExtId => $clientExtId, userExtId => $userExtId, sAMLCreateDTO => $sAMLCreateDTO);
};
if ($@) {
    warn "Exception when calling SAMLFederationRESTServiceApi->createSAMLCredentialRestService: $@\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.SAMLFederationRESTServiceApi()
clientExtId = clientExtId_example # String |  (default to null)
userExtId = userExtId_example # String |  (default to null)
sAMLCreateDTO = {"subjectNameId":"ssdf3","subjectNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","issuerNameId":"cssdf","issuerNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"} # SAMLCreateDTO | 

try:
    # Create SAML Federation Credential
    api_instance.create_saml_credential_rest_service(clientExtId, userExtId, sAMLCreateDTO)
except ApiException as e:
    print("Exception when calling SAMLFederationRESTServiceApi->createSAMLCredentialRestService: %s\n" % e)
extern crate SAMLFederationRESTServiceApi;

pub fn main() {
    let clientExtId = clientExtId_example; // String
    let userExtId = userExtId_example; // String
    let sAMLCreateDTO = {"subjectNameId":"ssdf3","subjectNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","issuerNameId":"cssdf","issuerNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"}; // SAMLCreateDTO

    let mut context = SAMLFederationRESTServiceApi::Context::default();
    let result = client.createSAMLCredentialRestService(clientExtId, userExtId, sAMLCreateDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
Required
userExtId*
String
Required
Body parameters
Name Description
sAMLCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

deleteSAMLCredential

deleteSAMLCredential
delete/core/v1/{clientExtId}/users/{userExtId}/saml-credentials/{extId}

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialDelete` or `SelfAdmin` Role Deletes the SAML Federation credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/saml-credentials/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SAMLFederationRESTServiceApi;

import java.io.File;
import java.util.*;

public class SAMLFederationRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SAMLFederationRESTServiceApi apiInstance = new SAMLFederationRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            apiInstance.deleteSAMLCredential(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SAMLFederationRESTServiceApi#deleteSAMLCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential

try {
    final result = await api_instance.deleteSAMLCredential(clientExtId, userExtId, extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteSAMLCredential: $e\n');
}

import org.openapitools.client.api.SAMLFederationRESTServiceApi;

public class SAMLFederationRESTServiceApiExample {
    public static void main(String[] args) {
        SAMLFederationRESTServiceApi apiInstance = new SAMLFederationRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            apiInstance.deleteSAMLCredential(clientExtId, userExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SAMLFederationRESTServiceApi#deleteSAMLCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SAMLFederationRESTServiceApi *apiInstance = [[SAMLFederationRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000002; // ExtID of the credential (default to null)

// Delete SAML Federation Credential
[apiInstance deleteSAMLCredentialWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SAMLFederationRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000002; // {String} ExtID of the credential

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteSAMLCredential(clientExtId, userExtId, extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteSAMLCredentialExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SAMLFederationRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000002;  // String | ExtID of the credential (default to null)

            try {
                // Delete SAML Federation Credential
                apiInstance.deleteSAMLCredential(clientExtId, userExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling SAMLFederationRESTServiceApi.deleteSAMLCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SAMLFederationRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000002; // String | ExtID of the credential

try {
    $api_instance->deleteSAMLCredential($clientExtId, $userExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling SAMLFederationRESTServiceApi->deleteSAMLCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SAMLFederationRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SAMLFederationRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000002; # String | ExtID of the credential

eval {
    $api_instance->deleteSAMLCredential(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling SAMLFederationRESTServiceApi->deleteSAMLCredential: $@\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.SAMLFederationRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000002 # String | ExtID of the credential (default to null)

try:
    # Delete SAML Federation Credential
    api_instance.delete_saml_credential(clientExtId, userExtId, extId)
except ApiException as e:
    print("Exception when calling SAMLFederationRESTServiceApi->deleteSAMLCredential: %s\n" % e)
extern crate SAMLFederationRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000002; // String

    let mut context = SAMLFederationRESTServiceApi::Context::default();
    let result = client.deleteSAMLCredential(clientExtId, userExtId, extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required

Responses


getSAMLCredential

getSAMLCredential
get/core/v1/{clientExtId}/users/{userExtId}/saml-credentials/{extId}

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns the SAML Federation credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/saml-credentials/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SAMLFederationRESTServiceApi;

import java.io.File;
import java.util.*;

public class SAMLFederationRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SAMLFederationRESTServiceApi apiInstance = new SAMLFederationRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            SamlFederationGetDTO result = apiInstance.getSAMLCredential(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SAMLFederationRESTServiceApi#getSAMLCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential

try {
    final result = await api_instance.getSAMLCredential(clientExtId, userExtId, extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSAMLCredential: $e\n');
}

import org.openapitools.client.api.SAMLFederationRESTServiceApi;

public class SAMLFederationRESTServiceApiExample {
    public static void main(String[] args) {
        SAMLFederationRESTServiceApi apiInstance = new SAMLFederationRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential

        try {
            SamlFederationGetDTO result = apiInstance.getSAMLCredential(clientExtId, userExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SAMLFederationRESTServiceApi#getSAMLCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SAMLFederationRESTServiceApi *apiInstance = [[SAMLFederationRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000002; // ExtID of the credential (default to null)

// Get SAML Federation Credential
[apiInstance getSAMLCredentialWith:clientExtId
    userExtId:userExtId
    extId:extId
              completionHandler: ^(SamlFederationGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SAMLFederationRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000002; // {String} ExtID of the credential

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSAMLCredential(clientExtId, userExtId, extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSAMLCredentialExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SAMLFederationRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000002;  // String | ExtID of the credential (default to null)

            try {
                // Get SAML Federation Credential
                SamlFederationGetDTO result = apiInstance.getSAMLCredential(clientExtId, userExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SAMLFederationRESTServiceApi.getSAMLCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SAMLFederationRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000002; // String | ExtID of the credential

try {
    $result = $api_instance->getSAMLCredential($clientExtId, $userExtId, $extId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SAMLFederationRESTServiceApi->getSAMLCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SAMLFederationRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SAMLFederationRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000002; # String | ExtID of the credential

eval {
    my $result = $api_instance->getSAMLCredential(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SAMLFederationRESTServiceApi->getSAMLCredential: $@\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.SAMLFederationRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000002 # String | ExtID of the credential (default to null)

try:
    # Get SAML Federation Credential
    api_response = api_instance.get_saml_credential(clientExtId, userExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SAMLFederationRESTServiceApi->getSAMLCredential: %s\n" % e)
extern crate SAMLFederationRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000002; // String

    let mut context = SAMLFederationRESTServiceApi::Context::default();
    let result = client.getSAMLCredential(clientExtId, userExtId, extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required

Responses


getSAMLCredentials

getSAMLCredentials
get/core/v1/{clientExtId}/users/{userExtId}/saml-credentials

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns all the SAML Federation credentials of the user with the given external ID. Results can be filtered by userFriendlyName and stateName.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/saml-credentials?continuationToken=continuationToken_example&limit=100&allParams=Object"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SAMLFederationRESTServiceApi;

import java.io.File;
import java.util.*;

public class SAMLFederationRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SAMLFederationRESTServiceApi apiInstance = new SAMLFederationRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        map[String, String] allParams = Object; // map[String, String] | Additional query parameters to filter the results. Supported parameters are:
- stateName: Filters the results by state name (exact match).
- extId: Filters the results by credential external ID (exact match).
- subjectNameId: Filters the results by subjectNameId (exact match).
- subjectNameIdFormat: Filters the results by subjectNameIdFormat (exact match).
- issuerNameId: Filters the results by issuerNameId (exact match).
- issuerNameIdFormat: Filters the results by issuerNameIdFormat (exact match).
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperForSamlGetDTO result = apiInstance.getSAMLCredentials(clientExtId, userExtId, allParams, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SAMLFederationRESTServiceApi#getSAMLCredentials");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final map[String, String] allParams = new map[String, String](); // map[String, String] | Additional query parameters to filter the results. Supported parameters are:
- stateName: Filters the results by state name (exact match).
- extId: Filters the results by credential external ID (exact match).
- subjectNameId: Filters the results by subjectNameId (exact match).
- subjectNameIdFormat: Filters the results by subjectNameIdFormat (exact match).
- issuerNameId: Filters the results by issuerNameId (exact match).
- issuerNameIdFormat: Filters the results by issuerNameIdFormat (exact match).
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

try {
    final result = await api_instance.getSAMLCredentials(clientExtId, userExtId, allParams, continuationToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSAMLCredentials: $e\n');
}

import org.openapitools.client.api.SAMLFederationRESTServiceApi;

public class SAMLFederationRESTServiceApiExample {
    public static void main(String[] args) {
        SAMLFederationRESTServiceApi apiInstance = new SAMLFederationRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        map[String, String] allParams = Object; // map[String, String] | Additional query parameters to filter the results. Supported parameters are:
- stateName: Filters the results by state name (exact match).
- extId: Filters the results by credential external ID (exact match).
- subjectNameId: Filters the results by subjectNameId (exact match).
- subjectNameIdFormat: Filters the results by subjectNameIdFormat (exact match).
- issuerNameId: Filters the results by issuerNameId (exact match).
- issuerNameIdFormat: Filters the results by issuerNameIdFormat (exact match).
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperForSamlGetDTO result = apiInstance.getSAMLCredentials(clientExtId, userExtId, allParams, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SAMLFederationRESTServiceApi#getSAMLCredentials");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SAMLFederationRESTServiceApi *apiInstance = [[SAMLFederationRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
map[String, String] *allParams = Object; // Additional query parameters to filter the results. Supported parameters are:
- stateName: Filters the results by state name (exact match).
- extId: Filters the results by credential external ID (exact match).
- subjectNameId: Filters the results by subjectNameId (exact match).
- subjectNameIdFormat: Filters the results by subjectNameIdFormat (exact match).
- issuerNameId: Filters the results by issuerNameId (exact match).
- issuerNameIdFormat: Filters the results by issuerNameIdFormat (exact match). (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 100; // Pagination limit (optional) (default to 0)

// Get user SAML Federation credentials
[apiInstance getSAMLCredentialsWith:clientExtId
    userExtId:userExtId
    allParams:allParams
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForSamlGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SAMLFederationRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var allParams = Object; // {map[String, String]} Additional query parameters to filter the results. Supported parameters are:
- stateName: Filters the results by state name (exact match).
- extId: Filters the results by credential external ID (exact match).
- subjectNameId: Filters the results by subjectNameId (exact match).
- subjectNameIdFormat: Filters the results by subjectNameIdFormat (exact match).
- issuerNameId: Filters the results by issuerNameId (exact match).
- issuerNameIdFormat: Filters the results by issuerNameIdFormat (exact match).
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 100 // {Integer} Pagination limit
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSAMLCredentials(clientExtId, userExtId, allParams, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSAMLCredentialsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SAMLFederationRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var allParams = new map[String, String](); // map[String, String] | Additional query parameters to filter the results. Supported parameters are:
- stateName: Filters the results by state name (exact match).
- extId: Filters the results by credential external ID (exact match).
- subjectNameId: Filters the results by subjectNameId (exact match).
- subjectNameIdFormat: Filters the results by subjectNameIdFormat (exact match).
- issuerNameId: Filters the results by issuerNameId (exact match).
- issuerNameIdFormat: Filters the results by issuerNameIdFormat (exact match). (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 100;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get user SAML Federation credentials
                ItemsWrapperForSamlGetDTO result = apiInstance.getSAMLCredentials(clientExtId, userExtId, allParams, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SAMLFederationRESTServiceApi.getSAMLCredentials: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SAMLFederationRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$allParams = Object; // map[String, String] | Additional query parameters to filter the results. Supported parameters are:
- stateName: Filters the results by state name (exact match).
- extId: Filters the results by credential external ID (exact match).
- subjectNameId: Filters the results by subjectNameId (exact match).
- subjectNameIdFormat: Filters the results by subjectNameIdFormat (exact match).
- issuerNameId: Filters the results by issuerNameId (exact match).
- issuerNameIdFormat: Filters the results by issuerNameIdFormat (exact match).
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 100; // Integer | Pagination limit

try {
    $result = $api_instance->getSAMLCredentials($clientExtId, $userExtId, $allParams, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SAMLFederationRESTServiceApi->getSAMLCredentials: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SAMLFederationRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SAMLFederationRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $allParams = Object; # map[String, String] | Additional query parameters to filter the results. Supported parameters are:
- stateName: Filters the results by state name (exact match).
- extId: Filters the results by credential external ID (exact match).
- subjectNameId: Filters the results by subjectNameId (exact match).
- subjectNameIdFormat: Filters the results by subjectNameIdFormat (exact match).
- issuerNameId: Filters the results by issuerNameId (exact match).
- issuerNameIdFormat: Filters the results by issuerNameIdFormat (exact match).
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 100; # Integer | Pagination limit

eval {
    my $result = $api_instance->getSAMLCredentials(clientExtId => $clientExtId, userExtId => $userExtId, allParams => $allParams, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SAMLFederationRESTServiceApi->getSAMLCredentials: $@\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.SAMLFederationRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
allParams = Object # map[String, String] | Additional query parameters to filter the results. Supported parameters are:
- stateName: Filters the results by state name (exact match).
- extId: Filters the results by credential external ID (exact match).
- subjectNameId: Filters the results by subjectNameId (exact match).
- subjectNameIdFormat: Filters the results by subjectNameIdFormat (exact match).
- issuerNameId: Filters the results by issuerNameId (exact match).
- issuerNameIdFormat: Filters the results by issuerNameIdFormat (exact match). (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 100 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get user SAML Federation credentials
    api_response = api_instance.get_saml_credentials(clientExtId, userExtId, allParams, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SAMLFederationRESTServiceApi->getSAMLCredentials: %s\n" % e)
extern crate SAMLFederationRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let allParams = Object; // map[String, String]
    let continuationToken = continuationToken_example; // String
    let limit = 100; // Integer

    let mut context = SAMLFederationRESTServiceApi::Context::default();
    let result = client.getSAMLCredentials(clientExtId, userExtId, allParams, continuationToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit
allParams*
map[String, String]
Additional query parameters to filter the results. Supported parameters are: - stateName: Filters the results by state name (exact match). - extId: Filters the results by credential external ID (exact match). - subjectNameId: Filters the results by subjectNameId (exact match). - subjectNameIdFormat: Filters the results by subjectNameIdFormat (exact match). - issuerNameId: Filters the results by issuerNameId (exact match). - issuerNameIdFormat: Filters the results by issuerNameIdFormat (exact match).
Required

Responses


patchSAMLCredential

patchSAMLCredential
patch/core/v1/{clientExtId}/users/{userExtId}/saml-credentials/{extId}

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialView,AccessControl.CredentialModify` Updates the SAML Federation credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/saml-credentials/{extId}" \
 -d '{
  "issuerNameId" : "issuerNameId",
  "policyExtId" : "policyExtId",
  "issuerNameIdFormat" : "issuerNameIdFormat",
  "stateName" : "stateName",
  "modificationComment" : "modificationComment",
  "subjectNameIdFormat" : "subjectNameIdFormat",
  "extId" : "extId",
  "subjectNameId" : "subjectNameId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SAMLFederationRESTServiceApi;

import java.io.File;
import java.util.*;

public class SAMLFederationRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SAMLFederationRESTServiceApi apiInstance = new SAMLFederationRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential
        SamlFederationPatchDTO samlFederationPatchDTO = {"subjectNameId":"testtesttest","subjectNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","issuerNameId":"testtesttest","issuerNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"}; // SamlFederationPatchDTO | 

        try {
            SamlFederationGetDTO result = apiInstance.patchSAMLCredential(clientExtId, userExtId, extId, samlFederationPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SAMLFederationRESTServiceApi#patchSAMLCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String extId = new String(); // String | ExtID of the credential
final SamlFederationPatchDTO samlFederationPatchDTO = new SamlFederationPatchDTO(); // SamlFederationPatchDTO | 

try {
    final result = await api_instance.patchSAMLCredential(clientExtId, userExtId, extId, samlFederationPatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchSAMLCredential: $e\n');
}

import org.openapitools.client.api.SAMLFederationRESTServiceApi;

public class SAMLFederationRESTServiceApiExample {
    public static void main(String[] args) {
        SAMLFederationRESTServiceApi apiInstance = new SAMLFederationRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String extId = 28000002; // String | ExtID of the credential
        SamlFederationPatchDTO samlFederationPatchDTO = {"subjectNameId":"testtesttest","subjectNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","issuerNameId":"testtesttest","issuerNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"}; // SamlFederationPatchDTO | 

        try {
            SamlFederationGetDTO result = apiInstance.patchSAMLCredential(clientExtId, userExtId, extId, samlFederationPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SAMLFederationRESTServiceApi#patchSAMLCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SAMLFederationRESTServiceApi *apiInstance = [[SAMLFederationRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *extId = 28000002; // ExtID of the credential (default to null)
SamlFederationPatchDTO *samlFederationPatchDTO = {"subjectNameId":"testtesttest","subjectNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","issuerNameId":"testtesttest","issuerNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"}; // 

// Update SAML Federation Credential
[apiInstance patchSAMLCredentialWith:clientExtId
    userExtId:userExtId
    extId:extId
    samlFederationPatchDTO:samlFederationPatchDTO
              completionHandler: ^(SamlFederationGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SAMLFederationRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var extId = 28000002; // {String} ExtID of the credential
var samlFederationPatchDTO = {"subjectNameId":"testtesttest","subjectNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","issuerNameId":"testtesttest","issuerNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"}; // {SamlFederationPatchDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchSAMLCredential(clientExtId, userExtId, extId, samlFederationPatchDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class patchSAMLCredentialExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SAMLFederationRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var extId = 28000002;  // String | ExtID of the credential (default to null)
            var samlFederationPatchDTO = new SamlFederationPatchDTO(); // SamlFederationPatchDTO | 

            try {
                // Update SAML Federation Credential
                SamlFederationGetDTO result = apiInstance.patchSAMLCredential(clientExtId, userExtId, extId, samlFederationPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SAMLFederationRESTServiceApi.patchSAMLCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SAMLFederationRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$extId = 28000002; // String | ExtID of the credential
$samlFederationPatchDTO = {"subjectNameId":"testtesttest","subjectNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","issuerNameId":"testtesttest","issuerNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"}; // SamlFederationPatchDTO | 

try {
    $result = $api_instance->patchSAMLCredential($clientExtId, $userExtId, $extId, $samlFederationPatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SAMLFederationRESTServiceApi->patchSAMLCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SAMLFederationRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SAMLFederationRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $extId = 28000002; # String | ExtID of the credential
my $samlFederationPatchDTO = WWW::OPenAPIClient::Object::SamlFederationPatchDTO->new(); # SamlFederationPatchDTO | 

eval {
    my $result = $api_instance->patchSAMLCredential(clientExtId => $clientExtId, userExtId => $userExtId, extId => $extId, samlFederationPatchDTO => $samlFederationPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SAMLFederationRESTServiceApi->patchSAMLCredential: $@\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.SAMLFederationRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
extId = 28000002 # String | ExtID of the credential (default to null)
samlFederationPatchDTO = {"subjectNameId":"testtesttest","subjectNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","issuerNameId":"testtesttest","issuerNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"} # SamlFederationPatchDTO | 

try:
    # Update SAML Federation Credential
    api_response = api_instance.patch_saml_credential(clientExtId, userExtId, extId, samlFederationPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SAMLFederationRESTServiceApi->patchSAMLCredential: %s\n" % e)
extern crate SAMLFederationRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let extId = 28000002; // String
    let samlFederationPatchDTO = {"subjectNameId":"testtesttest","subjectNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","issuerNameId":"testtesttest","issuerNameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"}; // SamlFederationPatchDTO

    let mut context = SAMLFederationRESTServiceApi::Context::default();
    let result = client.patchSAMLCredential(clientExtId, userExtId, extId, samlFederationPatchDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
extId*
String
ExtID of the credential
Required
Body parameters
Name Description
samlFederationPatchDTO *

Responses


SCIM

bulk

bulk
post/scim/v1/{clientExtId}/Bulk

Bulk operations request.

Usage and SDK Samples

curl -X POST \
 -H "Accept: */*,application/json,application/scim+json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/scim/v1/{clientExtId}/Bulk" \
 -d '{
  "meta" : {
    "resourceType" : "User",
    "created" : "2022-02-20T18:50:02Z",
    "lastModified" : "2022-02-20T18:51:30Z",
    "version" : "v2"
  },
  "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ],
  "failOnErrors" : 1,
  "Operations" : [ {
    "method" : "DELETE",
    "path" : "/Users",
    "data" : {
      "id" : 100
    }
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SCIMApi;

import java.io.File;
import java.util.*;

public class SCIMApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SCIMApi apiInstance = new SCIMApi();
        String clientExtId = 100; // String | Client's external identifier.
        ScimBulkRequest scimBulkRequest = ; // ScimBulkRequest | 

        try {
            ScimBulkResponse result = apiInstance.bulk(clientExtId, scimBulkRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMApi#bulk");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | Client's external identifier.
final ScimBulkRequest scimBulkRequest = new ScimBulkRequest(); // ScimBulkRequest | 

try {
    final result = await api_instance.bulk(clientExtId, scimBulkRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->bulk: $e\n');
}

import org.openapitools.client.api.SCIMApi;

public class SCIMApiExample {
    public static void main(String[] args) {
        SCIMApi apiInstance = new SCIMApi();
        String clientExtId = 100; // String | Client's external identifier.
        ScimBulkRequest scimBulkRequest = ; // ScimBulkRequest | 

        try {
            ScimBulkResponse result = apiInstance.bulk(clientExtId, scimBulkRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMApi#bulk");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SCIMApi *apiInstance = [[SCIMApi alloc] init];
String *clientExtId = 100; // Client's external identifier. (default to null)
ScimBulkRequest *scimBulkRequest = ; // 

[apiInstance bulkWith:clientExtId
    scimBulkRequest:scimBulkRequest
              completionHandler: ^(ScimBulkResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SCIMApi()
var clientExtId = 100; // {String} Client's external identifier.
var scimBulkRequest = ; // {ScimBulkRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.bulk(clientExtId, scimBulkRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class bulkExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SCIMApi();
            var clientExtId = 100;  // String | Client's external identifier. (default to null)
            var scimBulkRequest = new ScimBulkRequest(); // ScimBulkRequest | 

            try {
                ScimBulkResponse result = apiInstance.bulk(clientExtId, scimBulkRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SCIMApi.bulk: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SCIMApi();
$clientExtId = 100; // String | Client's external identifier.
$scimBulkRequest = ; // ScimBulkRequest | 

try {
    $result = $api_instance->bulk($clientExtId, $scimBulkRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SCIMApi->bulk: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SCIMApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SCIMApi->new();
my $clientExtId = 100; # String | Client's external identifier.
my $scimBulkRequest = WWW::OPenAPIClient::Object::ScimBulkRequest->new(); # ScimBulkRequest | 

eval {
    my $result = $api_instance->bulk(clientExtId => $clientExtId, scimBulkRequest => $scimBulkRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SCIMApi->bulk: $@\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.SCIMApi()
clientExtId = 100 # String | Client's external identifier. (default to null)
scimBulkRequest =  # ScimBulkRequest | 

try:
    api_response = api_instance.bulk(clientExtId, scimBulkRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SCIMApi->bulk: %s\n" % e)
extern crate SCIMApi;

pub fn main() {
    let clientExtId = 100; // String
    let scimBulkRequest = ; // ScimBulkRequest

    let mut context = SCIMApi::Context::default();
    let result = client.bulk(clientExtId, scimBulkRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
Client's external identifier.
Required
Body parameters
Name Description
scimBulkRequest *

Responses


createUser

createUser
post/scim/v1/{clientExtId}/Users

Create user based on SCIM representation of user.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json,application/scim+json,*/*" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/scim/v1/{clientExtId}/Users" \
 -d '{
  "preferredLanguage" : "en",
  "addresses" : [ {
    "streetAddress" : "100 Universal City Plaza",
    "locality" : "Hollywood",
    "region" : "CA",
    "postalCode" : "91608",
    "country" : "US"
  } ],
  "displayName" : "Ms. Barbara J Jensen, III.",
  "externalId" : 100,
  "active" : true,
  "userName" : "bootstrap",
  "locale" : "ch",
  "phoneNumbers" : [ {
    "value" : "555-555-5555",
    "type" : "telephone"
  } ],
  "emails" : [ {
    "value" : "[email protected]"
  } ],
  "extensions" : { },
  "meta" : {
    "resourceType" : "User",
    "created" : "2022-02-20T18:50:02Z",
    "lastModified" : "2022-02-20T18:51:30Z",
    "version" : "v2"
  },
  "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ],
  "name" : "Strap",
  "id" : "100-100",
  "urn:nevis:idm:scim:schemas:v1:extension:User" : {
    "templateCollectionName" : "Default",
    "technical" : false,
    "credentials" : [ {
      "extid" : "100",
      "type" : "PASSWORD",
      "active" : true,
      "password" : "secret"
    } ],
    "sex" : "male",
    "houseNumber" : 6,
    "profiles" : [ {
      "active" : true,
      "name" : "profile100",
      "extid" : "100",
      "defaultProfile" : true
    } ],
    "validFrom" : "2021-11-29T17:59:22.123",
    "postOfficeBoxNumber" : 9054,
    "birthDate" : "1974-12-18",
    "dwellingNumber" : 6,
    "street" : "Schwarze-Bären-Straße",
    "postOfficeBoxText" : "Smith's",
    "loginInfo" : {
      "lastLogin" : "2021-11-29T17:16:32:11.123",
      "lastFailure" : "2021-11-29T17:16:26:54.123"
    },
    "remarks" : "Some description.",
    "properties" : {
      "property1" : "123"
    },
    "validTo" : "2021-11-29T18:00:12.123"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SCIMApi;

import java.io.File;
import java.util.*;

public class SCIMApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SCIMApi apiInstance = new SCIMApi();
        String clientExtId = 100; // String | Client's external identifier.
        ScimUser scimUser = ; // ScimUser | 

        try {
            ScimUser result = apiInstance.createUser(clientExtId, scimUser);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMApi#createUser");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | Client's external identifier.
final ScimUser scimUser = new ScimUser(); // ScimUser | 

try {
    final result = await api_instance.createUser(clientExtId, scimUser);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createUser: $e\n');
}

import org.openapitools.client.api.SCIMApi;

public class SCIMApiExample {
    public static void main(String[] args) {
        SCIMApi apiInstance = new SCIMApi();
        String clientExtId = 100; // String | Client's external identifier.
        ScimUser scimUser = ; // ScimUser | 

        try {
            ScimUser result = apiInstance.createUser(clientExtId, scimUser);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMApi#createUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SCIMApi *apiInstance = [[SCIMApi alloc] init];
String *clientExtId = 100; // Client's external identifier. (default to null)
ScimUser *scimUser = ; // 

[apiInstance createUserWith:clientExtId
    scimUser:scimUser
              completionHandler: ^(ScimUser output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SCIMApi()
var clientExtId = 100; // {String} Client's external identifier.
var scimUser = ; // {ScimUser} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createUser(clientExtId, scimUser, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SCIMApi();
            var clientExtId = 100;  // String | Client's external identifier. (default to null)
            var scimUser = new ScimUser(); // ScimUser | 

            try {
                ScimUser result = apiInstance.createUser(clientExtId, scimUser);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SCIMApi.createUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SCIMApi();
$clientExtId = 100; // String | Client's external identifier.
$scimUser = ; // ScimUser | 

try {
    $result = $api_instance->createUser($clientExtId, $scimUser);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SCIMApi->createUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SCIMApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SCIMApi->new();
my $clientExtId = 100; # String | Client's external identifier.
my $scimUser = WWW::OPenAPIClient::Object::ScimUser->new(); # ScimUser | 

eval {
    my $result = $api_instance->createUser(clientExtId => $clientExtId, scimUser => $scimUser);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SCIMApi->createUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SCIMApi()
clientExtId = 100 # String | Client's external identifier. (default to null)
scimUser =  # ScimUser | 

try:
    api_response = api_instance.create_user(clientExtId, scimUser)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SCIMApi->createUser: %s\n" % e)
extern crate SCIMApi;

pub fn main() {
    let clientExtId = 100; // String
    let scimUser = ; // ScimUser

    let mut context = SCIMApi::Context::default();
    let result = client.createUser(clientExtId, scimUser, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
Client's external identifier.
Required
Body parameters
Name Description
scimUser *

Responses


deleteUser

deleteUser
delete/scim/v1/{clientExtId}/Users/{id}

Delete user and all related resources.

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json,application/scim+json,*/*" \
 "http://localhost:8080/nevisidm/api/scim/v1/{clientExtId}/Users/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SCIMApi;

import java.io.File;
import java.util.*;

public class SCIMApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SCIMApi apiInstance = new SCIMApi();
        String clientExtId = 100; // String | Client's external identifier.
        String id = 100; // String | User's internal identifier.

        try {
            ScimBase result = apiInstance.deleteUser(clientExtId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMApi#deleteUser");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | Client's external identifier.
final String id = new String(); // String | User's internal identifier.

try {
    final result = await api_instance.deleteUser(clientExtId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteUser: $e\n');
}

import org.openapitools.client.api.SCIMApi;

public class SCIMApiExample {
    public static void main(String[] args) {
        SCIMApi apiInstance = new SCIMApi();
        String clientExtId = 100; // String | Client's external identifier.
        String id = 100; // String | User's internal identifier.

        try {
            ScimBase result = apiInstance.deleteUser(clientExtId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMApi#deleteUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SCIMApi *apiInstance = [[SCIMApi alloc] init];
String *clientExtId = 100; // Client's external identifier. (default to null)
String *id = 100; // User's internal identifier. (default to null)

[apiInstance deleteUserWith:clientExtId
    id:id
              completionHandler: ^(ScimBase output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SCIMApi()
var clientExtId = 100; // {String} Client's external identifier.
var id = 100; // {String} User's internal identifier.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteUser(clientExtId, id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SCIMApi();
            var clientExtId = 100;  // String | Client's external identifier. (default to null)
            var id = 100;  // String | User's internal identifier. (default to null)

            try {
                ScimBase result = apiInstance.deleteUser(clientExtId, id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SCIMApi.deleteUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SCIMApi();
$clientExtId = 100; // String | Client's external identifier.
$id = 100; // String | User's internal identifier.

try {
    $result = $api_instance->deleteUser($clientExtId, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SCIMApi->deleteUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SCIMApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SCIMApi->new();
my $clientExtId = 100; # String | Client's external identifier.
my $id = 100; # String | User's internal identifier.

eval {
    my $result = $api_instance->deleteUser(clientExtId => $clientExtId, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SCIMApi->deleteUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SCIMApi()
clientExtId = 100 # String | Client's external identifier. (default to null)
id = 100 # String | User's internal identifier. (default to null)

try:
    api_response = api_instance.delete_user(clientExtId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SCIMApi->deleteUser: %s\n" % e)
extern crate SCIMApi;

pub fn main() {
    let clientExtId = 100; // String
    let id = 100; // String

    let mut context = SCIMApi::Context::default();
    let result = client.deleteUser(clientExtId, id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
Client's external identifier.
Required
id*
String
User's internal identifier.
Required

Responses


getUser

getUser
get/scim/v1/{clientExtId}/Users/{id}

Get SCIM representation of requested user.

Usage and SDK Samples

curl -X GET \
 -H "Accept: */*,application/json,application/scim+json" \
 "http://localhost:8080/nevisidm/api/scim/v1/{clientExtId}/Users/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SCIMApi;

import java.io.File;
import java.util.*;

public class SCIMApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SCIMApi apiInstance = new SCIMApi();
        String clientExtId = 100; // String | Client's external identifier.
        String id = 100; // String | User's internal identifier.

        try {
            ScimUser result = apiInstance.getUser(clientExtId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMApi#getUser");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | Client's external identifier.
final String id = new String(); // String | User's internal identifier.

try {
    final result = await api_instance.getUser(clientExtId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUser: $e\n');
}

import org.openapitools.client.api.SCIMApi;

public class SCIMApiExample {
    public static void main(String[] args) {
        SCIMApi apiInstance = new SCIMApi();
        String clientExtId = 100; // String | Client's external identifier.
        String id = 100; // String | User's internal identifier.

        try {
            ScimUser result = apiInstance.getUser(clientExtId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMApi#getUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SCIMApi *apiInstance = [[SCIMApi alloc] init];
String *clientExtId = 100; // Client's external identifier. (default to null)
String *id = 100; // User's internal identifier. (default to null)

[apiInstance getUserWith:clientExtId
    id:id
              completionHandler: ^(ScimUser output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SCIMApi()
var clientExtId = 100; // {String} Client's external identifier.
var id = 100; // {String} User's internal identifier.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUser(clientExtId, id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SCIMApi();
            var clientExtId = 100;  // String | Client's external identifier. (default to null)
            var id = 100;  // String | User's internal identifier. (default to null)

            try {
                ScimUser result = apiInstance.getUser(clientExtId, id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SCIMApi.getUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SCIMApi();
$clientExtId = 100; // String | Client's external identifier.
$id = 100; // String | User's internal identifier.

try {
    $result = $api_instance->getUser($clientExtId, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SCIMApi->getUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SCIMApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SCIMApi->new();
my $clientExtId = 100; # String | Client's external identifier.
my $id = 100; # String | User's internal identifier.

eval {
    my $result = $api_instance->getUser(clientExtId => $clientExtId, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SCIMApi->getUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SCIMApi()
clientExtId = 100 # String | Client's external identifier. (default to null)
id = 100 # String | User's internal identifier. (default to null)

try:
    api_response = api_instance.get_user(clientExtId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SCIMApi->getUser: %s\n" % e)
extern crate SCIMApi;

pub fn main() {
    let clientExtId = 100; // String
    let id = 100; // String

    let mut context = SCIMApi::Context::default();
    let result = client.getUser(clientExtId, id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
Client's external identifier.
Required
id*
String
User's internal identifier.
Required

Responses


listUsers

listUsers
get/scim/v1/{clientExtId}/Users

List of SCIM representation of users belonging to current customer.

Usage and SDK Samples

curl -X GET \
 -H "Accept: */*,application/json" \
 "http://localhost:8080/nevisidm/api/scim/v1/{clientExtId}/Users?startIndex=1&count=10&attributes=userName&excludedAttributes=userName&filter=userName eq "tesla"&sortBy=userName&sortOrder=descending&bulkImportFormat=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SCIMApi;

import java.io.File;
import java.util.*;

public class SCIMApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SCIMApi apiInstance = new SCIMApi();
        String clientExtId = 100; // String | Client's external identifier.
        Integer startIndex = 1; // Integer | Start index for the listing. Default value: 1.
        Integer count = 10; // Integer | Maximum number of elements in the result list. Default value is 10 and maximum set by `application.scim.filter-max-results`.
        array[String] attributes = userName; // array[String] | Comma separated list of attributes must be contained by the result. Empty value means all available attributes are contained by the result.
        array[String] excludedAttributes = userName; // array[String] | Comma separated list of attributes must NOT be contained by the result. Empty value means all available attributes are contained by the result. If attributes present and not empty, this 'excludedAttributes' is ignored.
        String filter = userName eq "tesla"; // String | Filter expression may be used to restrict results to one or more specific resource. Empty filter means all possible resources are selected.
        String sortBy = userName; // String | Name of an attribute (or sub-attribute) for sorting the result. Empty value means as sorting attribute the 'id' is used to.
        String sortOrder = descending; // String | Sort order of selected attribute (in 'sortBy' parameter). Empty value means the default ascending sorting order.
        Boolean bulkImportFormat = true; // Boolean | The output is ScimBulkRequest with create operations instead of ScimListResponse as standard defines. This optional parameter by default false.

        try {
            ScimListResponse result = apiInstance.listUsers(clientExtId, startIndex, count, attributes, excludedAttributes, filter, sortBy, sortOrder, bulkImportFormat);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMApi#listUsers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | Client's external identifier.
final Integer startIndex = new Integer(); // Integer | Start index for the listing. Default value: 1.
final Integer count = new Integer(); // Integer | Maximum number of elements in the result list. Default value is 10 and maximum set by `application.scim.filter-max-results`.
final array[String] attributes = new array[String](); // array[String] | Comma separated list of attributes must be contained by the result. Empty value means all available attributes are contained by the result.
final array[String] excludedAttributes = new array[String](); // array[String] | Comma separated list of attributes must NOT be contained by the result. Empty value means all available attributes are contained by the result. If attributes present and not empty, this 'excludedAttributes' is ignored.
final String filter = new String(); // String | Filter expression may be used to restrict results to one or more specific resource. Empty filter means all possible resources are selected.
final String sortBy = new String(); // String | Name of an attribute (or sub-attribute) for sorting the result. Empty value means as sorting attribute the 'id' is used to.
final String sortOrder = new String(); // String | Sort order of selected attribute (in 'sortBy' parameter). Empty value means the default ascending sorting order.
final Boolean bulkImportFormat = new Boolean(); // Boolean | The output is ScimBulkRequest with create operations instead of ScimListResponse as standard defines. This optional parameter by default false.

try {
    final result = await api_instance.listUsers(clientExtId, startIndex, count, attributes, excludedAttributes, filter, sortBy, sortOrder, bulkImportFormat);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listUsers: $e\n');
}

import org.openapitools.client.api.SCIMApi;

public class SCIMApiExample {
    public static void main(String[] args) {
        SCIMApi apiInstance = new SCIMApi();
        String clientExtId = 100; // String | Client's external identifier.
        Integer startIndex = 1; // Integer | Start index for the listing. Default value: 1.
        Integer count = 10; // Integer | Maximum number of elements in the result list. Default value is 10 and maximum set by `application.scim.filter-max-results`.
        array[String] attributes = userName; // array[String] | Comma separated list of attributes must be contained by the result. Empty value means all available attributes are contained by the result.
        array[String] excludedAttributes = userName; // array[String] | Comma separated list of attributes must NOT be contained by the result. Empty value means all available attributes are contained by the result. If attributes present and not empty, this 'excludedAttributes' is ignored.
        String filter = userName eq "tesla"; // String | Filter expression may be used to restrict results to one or more specific resource. Empty filter means all possible resources are selected.
        String sortBy = userName; // String | Name of an attribute (or sub-attribute) for sorting the result. Empty value means as sorting attribute the 'id' is used to.
        String sortOrder = descending; // String | Sort order of selected attribute (in 'sortBy' parameter). Empty value means the default ascending sorting order.
        Boolean bulkImportFormat = true; // Boolean | The output is ScimBulkRequest with create operations instead of ScimListResponse as standard defines. This optional parameter by default false.

        try {
            ScimListResponse result = apiInstance.listUsers(clientExtId, startIndex, count, attributes, excludedAttributes, filter, sortBy, sortOrder, bulkImportFormat);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMApi#listUsers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SCIMApi *apiInstance = [[SCIMApi alloc] init];
String *clientExtId = 100; // Client's external identifier. (default to null)
Integer *startIndex = 1; // Start index for the listing. Default value: 1. (optional) (default to null)
Integer *count = 10; // Maximum number of elements in the result list. Default value is 10 and maximum set by `application.scim.filter-max-results`. (optional) (default to null)
array[String] *attributes = userName; // Comma separated list of attributes must be contained by the result. Empty value means all available attributes are contained by the result. (optional) (default to null)
array[String] *excludedAttributes = userName; // Comma separated list of attributes must NOT be contained by the result. Empty value means all available attributes are contained by the result. If attributes present and not empty, this 'excludedAttributes' is ignored. (optional) (default to null)
String *filter = userName eq "tesla"; // Filter expression may be used to restrict results to one or more specific resource. Empty filter means all possible resources are selected. (optional) (default to null)
String *sortBy = userName; // Name of an attribute (or sub-attribute) for sorting the result. Empty value means as sorting attribute the 'id' is used to. (optional) (default to null)
String *sortOrder = descending; // Sort order of selected attribute (in 'sortBy' parameter). Empty value means the default ascending sorting order. (optional) (default to null)
Boolean *bulkImportFormat = true; // The output is ScimBulkRequest with create operations instead of ScimListResponse as standard defines. This optional parameter by default false. (optional) (default to null)

[apiInstance listUsersWith:clientExtId
    startIndex:startIndex
    count:count
    attributes:attributes
    excludedAttributes:excludedAttributes
    filter:filter
    sortBy:sortBy
    sortOrder:sortOrder
    bulkImportFormat:bulkImportFormat
              completionHandler: ^(ScimListResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SCIMApi()
var clientExtId = 100; // {String} Client's external identifier.
var opts = {
  'startIndex': 1, // {Integer} Start index for the listing. Default value: 1.
  'count': 10, // {Integer} Maximum number of elements in the result list. Default value is 10 and maximum set by `application.scim.filter-max-results`.
  'attributes': userName, // {array[String]} Comma separated list of attributes must be contained by the result. Empty value means all available attributes are contained by the result.
  'excludedAttributes': userName, // {array[String]} Comma separated list of attributes must NOT be contained by the result. Empty value means all available attributes are contained by the result. If attributes present and not empty, this 'excludedAttributes' is ignored.
  'filter': userName eq "tesla", // {String} Filter expression may be used to restrict results to one or more specific resource. Empty filter means all possible resources are selected.
  'sortBy': userName, // {String} Name of an attribute (or sub-attribute) for sorting the result. Empty value means as sorting attribute the 'id' is used to.
  'sortOrder': descending, // {String} Sort order of selected attribute (in 'sortBy' parameter). Empty value means the default ascending sorting order.
  'bulkImportFormat': true // {Boolean} The output is ScimBulkRequest with create operations instead of ScimListResponse as standard defines. This optional parameter by default false.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listUsers(clientExtId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listUsersExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SCIMApi();
            var clientExtId = 100;  // String | Client's external identifier. (default to null)
            var startIndex = 1;  // Integer | Start index for the listing. Default value: 1. (optional)  (default to null)
            var count = 10;  // Integer | Maximum number of elements in the result list. Default value is 10 and maximum set by `application.scim.filter-max-results`. (optional)  (default to null)
            var attributes = new array[String](); // array[String] | Comma separated list of attributes must be contained by the result. Empty value means all available attributes are contained by the result. (optional)  (default to null)
            var excludedAttributes = new array[String](); // array[String] | Comma separated list of attributes must NOT be contained by the result. Empty value means all available attributes are contained by the result. If attributes present and not empty, this 'excludedAttributes' is ignored. (optional)  (default to null)
            var filter = userName eq "tesla";  // String | Filter expression may be used to restrict results to one or more specific resource. Empty filter means all possible resources are selected. (optional)  (default to null)
            var sortBy = userName;  // String | Name of an attribute (or sub-attribute) for sorting the result. Empty value means as sorting attribute the 'id' is used to. (optional)  (default to null)
            var sortOrder = descending;  // String | Sort order of selected attribute (in 'sortBy' parameter). Empty value means the default ascending sorting order. (optional)  (default to null)
            var bulkImportFormat = true;  // Boolean | The output is ScimBulkRequest with create operations instead of ScimListResponse as standard defines. This optional parameter by default false. (optional)  (default to null)

            try {
                ScimListResponse result = apiInstance.listUsers(clientExtId, startIndex, count, attributes, excludedAttributes, filter, sortBy, sortOrder, bulkImportFormat);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SCIMApi.listUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SCIMApi();
$clientExtId = 100; // String | Client's external identifier.
$startIndex = 1; // Integer | Start index for the listing. Default value: 1.
$count = 10; // Integer | Maximum number of elements in the result list. Default value is 10 and maximum set by `application.scim.filter-max-results`.
$attributes = userName; // array[String] | Comma separated list of attributes must be contained by the result. Empty value means all available attributes are contained by the result.
$excludedAttributes = userName; // array[String] | Comma separated list of attributes must NOT be contained by the result. Empty value means all available attributes are contained by the result. If attributes present and not empty, this 'excludedAttributes' is ignored.
$filter = userName eq "tesla"; // String | Filter expression may be used to restrict results to one or more specific resource. Empty filter means all possible resources are selected.
$sortBy = userName; // String | Name of an attribute (or sub-attribute) for sorting the result. Empty value means as sorting attribute the 'id' is used to.
$sortOrder = descending; // String | Sort order of selected attribute (in 'sortBy' parameter). Empty value means the default ascending sorting order.
$bulkImportFormat = true; // Boolean | The output is ScimBulkRequest with create operations instead of ScimListResponse as standard defines. This optional parameter by default false.

try {
    $result = $api_instance->listUsers($clientExtId, $startIndex, $count, $attributes, $excludedAttributes, $filter, $sortBy, $sortOrder, $bulkImportFormat);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SCIMApi->listUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SCIMApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SCIMApi->new();
my $clientExtId = 100; # String | Client's external identifier.
my $startIndex = 1; # Integer | Start index for the listing. Default value: 1.
my $count = 10; # Integer | Maximum number of elements in the result list. Default value is 10 and maximum set by `application.scim.filter-max-results`.
my $attributes = [userName]; # array[String] | Comma separated list of attributes must be contained by the result. Empty value means all available attributes are contained by the result.
my $excludedAttributes = [userName]; # array[String] | Comma separated list of attributes must NOT be contained by the result. Empty value means all available attributes are contained by the result. If attributes present and not empty, this 'excludedAttributes' is ignored.
my $filter = userName eq "tesla"; # String | Filter expression may be used to restrict results to one or more specific resource. Empty filter means all possible resources are selected.
my $sortBy = userName; # String | Name of an attribute (or sub-attribute) for sorting the result. Empty value means as sorting attribute the 'id' is used to.
my $sortOrder = descending; # String | Sort order of selected attribute (in 'sortBy' parameter). Empty value means the default ascending sorting order.
my $bulkImportFormat = true; # Boolean | The output is ScimBulkRequest with create operations instead of ScimListResponse as standard defines. This optional parameter by default false.

eval {
    my $result = $api_instance->listUsers(clientExtId => $clientExtId, startIndex => $startIndex, count => $count, attributes => $attributes, excludedAttributes => $excludedAttributes, filter => $filter, sortBy => $sortBy, sortOrder => $sortOrder, bulkImportFormat => $bulkImportFormat);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SCIMApi->listUsers: $@\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.SCIMApi()
clientExtId = 100 # String | Client's external identifier. (default to null)
startIndex = 1 # Integer | Start index for the listing. Default value: 1. (optional) (default to null)
count = 10 # Integer | Maximum number of elements in the result list. Default value is 10 and maximum set by `application.scim.filter-max-results`. (optional) (default to null)
attributes = userName # array[String] | Comma separated list of attributes must be contained by the result. Empty value means all available attributes are contained by the result. (optional) (default to null)
excludedAttributes = userName # array[String] | Comma separated list of attributes must NOT be contained by the result. Empty value means all available attributes are contained by the result. If attributes present and not empty, this 'excludedAttributes' is ignored. (optional) (default to null)
filter = userName eq "tesla" # String | Filter expression may be used to restrict results to one or more specific resource. Empty filter means all possible resources are selected. (optional) (default to null)
sortBy = userName # String | Name of an attribute (or sub-attribute) for sorting the result. Empty value means as sorting attribute the 'id' is used to. (optional) (default to null)
sortOrder = descending # String | Sort order of selected attribute (in 'sortBy' parameter). Empty value means the default ascending sorting order. (optional) (default to null)
bulkImportFormat = true # Boolean | The output is ScimBulkRequest with create operations instead of ScimListResponse as standard defines. This optional parameter by default false. (optional) (default to null)

try:
    api_response = api_instance.list_users(clientExtId, startIndex=startIndex, count=count, attributes=attributes, excludedAttributes=excludedAttributes, filter=filter, sortBy=sortBy, sortOrder=sortOrder, bulkImportFormat=bulkImportFormat)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SCIMApi->listUsers: %s\n" % e)
extern crate SCIMApi;

pub fn main() {
    let clientExtId = 100; // String
    let startIndex = 1; // Integer
    let count = 10; // Integer
    let attributes = userName; // array[String]
    let excludedAttributes = userName; // array[String]
    let filter = userName eq "tesla"; // String
    let sortBy = userName; // String
    let sortOrder = descending; // String
    let bulkImportFormat = true; // Boolean

    let mut context = SCIMApi::Context::default();
    let result = client.listUsers(clientExtId, startIndex, count, attributes, excludedAttributes, filter, sortBy, sortOrder, bulkImportFormat, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
Client's external identifier.
Required
Query parameters
Name Description
startIndex
Integer
Start index for the listing. Default value: 1.
count
Integer
Maximum number of elements in the result list. Default value is 10 and maximum set by `application.scim.filter-max-results`.
attributes
array[String]
Comma separated list of attributes must be contained by the result. Empty value means all available attributes are contained by the result.
excludedAttributes
array[String]
Comma separated list of attributes must NOT be contained by the result. Empty value means all available attributes are contained by the result. If attributes present and not empty, this 'excludedAttributes' is ignored.
filter
String
Filter expression may be used to restrict results to one or more specific resource. Empty filter means all possible resources are selected.
sortBy
String
Name of an attribute (or sub-attribute) for sorting the result. Empty value means as sorting attribute the 'id' is used to.
sortOrder
String
Sort order of selected attribute (in 'sortBy' parameter). Empty value means the default ascending sorting order.
bulkImportFormat
Boolean
The output is ScimBulkRequest with create operations instead of ScimListResponse as standard defines. This optional parameter by default false.

Responses


patchUser

patchUser
patch/scim/v1/{clientExtId}/Users/{id}

Patch SCIM representation of requested user.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: */*,application/json,application/scim+json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/scim/v1/{clientExtId}/Users/{id}" \
 -d '{
  "performGet" : true,
  "operations" : "bootstrap",
  "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SCIMApi;

import java.io.File;
import java.util.*;

public class SCIMApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SCIMApi apiInstance = new SCIMApi();
        String clientExtId = 100; // String | Client's external identifier.
        String id = 100; // String | User's internal identifier.
        ScimPatch scimPatch = ; // ScimPatch | 

        try {
            ScimUser result = apiInstance.patchUser(clientExtId, id, scimPatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMApi#patchUser");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | Client's external identifier.
final String id = new String(); // String | User's internal identifier.
final ScimPatch scimPatch = new ScimPatch(); // ScimPatch | 

try {
    final result = await api_instance.patchUser(clientExtId, id, scimPatch);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchUser: $e\n');
}

import org.openapitools.client.api.SCIMApi;

public class SCIMApiExample {
    public static void main(String[] args) {
        SCIMApi apiInstance = new SCIMApi();
        String clientExtId = 100; // String | Client's external identifier.
        String id = 100; // String | User's internal identifier.
        ScimPatch scimPatch = ; // ScimPatch | 

        try {
            ScimUser result = apiInstance.patchUser(clientExtId, id, scimPatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMApi#patchUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SCIMApi *apiInstance = [[SCIMApi alloc] init];
String *clientExtId = 100; // Client's external identifier. (default to null)
String *id = 100; // User's internal identifier. (default to null)
ScimPatch *scimPatch = ; // 

[apiInstance patchUserWith:clientExtId
    id:id
    scimPatch:scimPatch
              completionHandler: ^(ScimUser output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SCIMApi()
var clientExtId = 100; // {String} Client's external identifier.
var id = 100; // {String} User's internal identifier.
var scimPatch = ; // {ScimPatch} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchUser(clientExtId, id, scimPatch, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class patchUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SCIMApi();
            var clientExtId = 100;  // String | Client's external identifier. (default to null)
            var id = 100;  // String | User's internal identifier. (default to null)
            var scimPatch = new ScimPatch(); // ScimPatch | 

            try {
                ScimUser result = apiInstance.patchUser(clientExtId, id, scimPatch);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SCIMApi.patchUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SCIMApi();
$clientExtId = 100; // String | Client's external identifier.
$id = 100; // String | User's internal identifier.
$scimPatch = ; // ScimPatch | 

try {
    $result = $api_instance->patchUser($clientExtId, $id, $scimPatch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SCIMApi->patchUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SCIMApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SCIMApi->new();
my $clientExtId = 100; # String | Client's external identifier.
my $id = 100; # String | User's internal identifier.
my $scimPatch = WWW::OPenAPIClient::Object::ScimPatch->new(); # ScimPatch | 

eval {
    my $result = $api_instance->patchUser(clientExtId => $clientExtId, id => $id, scimPatch => $scimPatch);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SCIMApi->patchUser: $@\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.SCIMApi()
clientExtId = 100 # String | Client's external identifier. (default to null)
id = 100 # String | User's internal identifier. (default to null)
scimPatch =  # ScimPatch | 

try:
    api_response = api_instance.patch_user(clientExtId, id, scimPatch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SCIMApi->patchUser: %s\n" % e)
extern crate SCIMApi;

pub fn main() {
    let clientExtId = 100; // String
    let id = 100; // String
    let scimPatch = ; // ScimPatch

    let mut context = SCIMApi::Context::default();
    let result = client.patchUser(clientExtId, id, scimPatch, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
Client's external identifier.
Required
id*
String
User's internal identifier.
Required
Body parameters
Name Description
scimPatch *

Responses


searchUsers

searchUsers
post/scim/v1/{clientExtId}/Users/.search

POST version of user list endpoint.

Usage and SDK Samples

curl -X POST \
 -H "Accept: */*,application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/scim/v1/{clientExtId}/Users/.search" \
 -d '{
  "filter" : "name.familyName EQ 'Tesla' AND name.givenName EQ 'Nikola'",
  "startIndex" : 1,
  "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ],
  "sortOrder" : "ascending",
  "count" : 10,
  "bulkImportFormat" : true,
  "attributes" : "userName",
  "sortBy" : "userName",
  "excludedAttributes" : "userName"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SCIMApi;

import java.io.File;
import java.util.*;

public class SCIMApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SCIMApi apiInstance = new SCIMApi();
        String clientExtId = 100; // String | Client's external identifier.
        ScimSearchRequest scimSearchRequest = ; // ScimSearchRequest | 

        try {
            ScimListResponse result = apiInstance.searchUsers(clientExtId, scimSearchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMApi#searchUsers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | Client's external identifier.
final ScimSearchRequest scimSearchRequest = new ScimSearchRequest(); // ScimSearchRequest | 

try {
    final result = await api_instance.searchUsers(clientExtId, scimSearchRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchUsers: $e\n');
}

import org.openapitools.client.api.SCIMApi;

public class SCIMApiExample {
    public static void main(String[] args) {
        SCIMApi apiInstance = new SCIMApi();
        String clientExtId = 100; // String | Client's external identifier.
        ScimSearchRequest scimSearchRequest = ; // ScimSearchRequest | 

        try {
            ScimListResponse result = apiInstance.searchUsers(clientExtId, scimSearchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMApi#searchUsers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SCIMApi *apiInstance = [[SCIMApi alloc] init];
String *clientExtId = 100; // Client's external identifier. (default to null)
ScimSearchRequest *scimSearchRequest = ; // 

[apiInstance searchUsersWith:clientExtId
    scimSearchRequest:scimSearchRequest
              completionHandler: ^(ScimListResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SCIMApi()
var clientExtId = 100; // {String} Client's external identifier.
var scimSearchRequest = ; // {ScimSearchRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchUsers(clientExtId, scimSearchRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchUsersExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SCIMApi();
            var clientExtId = 100;  // String | Client's external identifier. (default to null)
            var scimSearchRequest = new ScimSearchRequest(); // ScimSearchRequest | 

            try {
                ScimListResponse result = apiInstance.searchUsers(clientExtId, scimSearchRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SCIMApi.searchUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SCIMApi();
$clientExtId = 100; // String | Client's external identifier.
$scimSearchRequest = ; // ScimSearchRequest | 

try {
    $result = $api_instance->searchUsers($clientExtId, $scimSearchRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SCIMApi->searchUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SCIMApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SCIMApi->new();
my $clientExtId = 100; # String | Client's external identifier.
my $scimSearchRequest = WWW::OPenAPIClient::Object::ScimSearchRequest->new(); # ScimSearchRequest | 

eval {
    my $result = $api_instance->searchUsers(clientExtId => $clientExtId, scimSearchRequest => $scimSearchRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SCIMApi->searchUsers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SCIMApi()
clientExtId = 100 # String | Client's external identifier. (default to null)
scimSearchRequest =  # ScimSearchRequest | 

try:
    api_response = api_instance.search_users(clientExtId, scimSearchRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SCIMApi->searchUsers: %s\n" % e)
extern crate SCIMApi;

pub fn main() {
    let clientExtId = 100; // String
    let scimSearchRequest = ; // ScimSearchRequest

    let mut context = SCIMApi::Context::default();
    let result = client.searchUsers(clientExtId, scimSearchRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
Client's external identifier.
Required
Body parameters
Name Description
scimSearchRequest *

Query request attributes.

Responses


SCIMMetaRestService

getSchema

getSchema
get/scim/v1/Schemas/{id}

Get a SCIM supported schema definition.

Usage and SDK Samples

curl -X GET \
 -H "Accept: */*,application/json,application/scim+json" \
 "http://localhost:8080/nevisidm/api/scim/v1/Schemas/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SCIMMetaRestServiceApi;

import java.io.File;
import java.util.*;

public class SCIMMetaRestServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SCIMMetaRestServiceApi apiInstance = new SCIMMetaRestServiceApi();
        String id = urn:ietf:params:scim:schemas:core:2.0:User; // String | Schema's internal identifier.

        try {
            ScimSchema result = apiInstance.getSchema(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMMetaRestServiceApi#getSchema");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | Schema's internal identifier.

try {
    final result = await api_instance.getSchema(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSchema: $e\n');
}

import org.openapitools.client.api.SCIMMetaRestServiceApi;

public class SCIMMetaRestServiceApiExample {
    public static void main(String[] args) {
        SCIMMetaRestServiceApi apiInstance = new SCIMMetaRestServiceApi();
        String id = urn:ietf:params:scim:schemas:core:2.0:User; // String | Schema's internal identifier.

        try {
            ScimSchema result = apiInstance.getSchema(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMMetaRestServiceApi#getSchema");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SCIMMetaRestServiceApi *apiInstance = [[SCIMMetaRestServiceApi alloc] init];
String *id = urn:ietf:params:scim:schemas:core:2.0:User; // Schema's internal identifier. (default to null)

[apiInstance getSchemaWith:id
              completionHandler: ^(ScimSchema output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SCIMMetaRestServiceApi()
var id = urn:ietf:params:scim:schemas:core:2.0:User; // {String} Schema's internal identifier.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSchema(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSchemaExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SCIMMetaRestServiceApi();
            var id = urn:ietf:params:scim:schemas:core:2.0:User;  // String | Schema's internal identifier. (default to null)

            try {
                ScimSchema result = apiInstance.getSchema(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SCIMMetaRestServiceApi.getSchema: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SCIMMetaRestServiceApi();
$id = urn:ietf:params:scim:schemas:core:2.0:User; // String | Schema's internal identifier.

try {
    $result = $api_instance->getSchema($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SCIMMetaRestServiceApi->getSchema: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SCIMMetaRestServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SCIMMetaRestServiceApi->new();
my $id = urn:ietf:params:scim:schemas:core:2.0:User; # String | Schema's internal identifier.

eval {
    my $result = $api_instance->getSchema(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SCIMMetaRestServiceApi->getSchema: $@\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.SCIMMetaRestServiceApi()
id = urn:ietf:params:scim:schemas:core:2.0:User # String | Schema's internal identifier. (default to null)

try:
    api_response = api_instance.get_schema(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SCIMMetaRestServiceApi->getSchema: %s\n" % e)
extern crate SCIMMetaRestServiceApi;

pub fn main() {
    let id = urn:ietf:params:scim:schemas:core:2.0:User; // String

    let mut context = SCIMMetaRestServiceApi::Context::default();
    let result = client.getSchema(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
Schema's internal identifier.
Required

Responses


getServiceProviders

getServiceProviders
get/scim/v1/ServiceProviderConfig

Get a SCIM's standard service providers definition.

Usage and SDK Samples

curl -X GET \
 -H "Accept: */*,application/json,application/scim+json" \
 "http://localhost:8080/nevisidm/api/scim/v1/ServiceProviderConfig"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SCIMMetaRestServiceApi;

import java.io.File;
import java.util.*;

public class SCIMMetaRestServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SCIMMetaRestServiceApi apiInstance = new SCIMMetaRestServiceApi();

        try {
            ScimServiceProviderConfig result = apiInstance.getServiceProviders();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMMetaRestServiceApi#getServiceProviders");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getServiceProviders();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getServiceProviders: $e\n');
}

import org.openapitools.client.api.SCIMMetaRestServiceApi;

public class SCIMMetaRestServiceApiExample {
    public static void main(String[] args) {
        SCIMMetaRestServiceApi apiInstance = new SCIMMetaRestServiceApi();

        try {
            ScimServiceProviderConfig result = apiInstance.getServiceProviders();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMMetaRestServiceApi#getServiceProviders");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SCIMMetaRestServiceApi *apiInstance = [[SCIMMetaRestServiceApi alloc] init];

[apiInstance getServiceProvidersWithCompletionHandler: 
              ^(ScimServiceProviderConfig output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SCIMMetaRestServiceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getServiceProviders(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getServiceProvidersExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SCIMMetaRestServiceApi();

            try {
                ScimServiceProviderConfig result = apiInstance.getServiceProviders();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SCIMMetaRestServiceApi.getServiceProviders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SCIMMetaRestServiceApi();

try {
    $result = $api_instance->getServiceProviders();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SCIMMetaRestServiceApi->getServiceProviders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SCIMMetaRestServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SCIMMetaRestServiceApi->new();

eval {
    my $result = $api_instance->getServiceProviders();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SCIMMetaRestServiceApi->getServiceProviders: $@\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.SCIMMetaRestServiceApi()

try:
    api_response = api_instance.get_service_providers()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SCIMMetaRestServiceApi->getServiceProviders: %s\n" % e)
extern crate SCIMMetaRestServiceApi;

pub fn main() {

    let mut context = SCIMMetaRestServiceApi::Context::default();
    let result = client.getServiceProviders(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getStandardResource

getStandardResource
get/scim/v1/ResourceTypes/{id}

Get a supported SCIM standard resource definition.

Usage and SDK Samples

curl -X GET \
 -H "Accept: */*,application/json,application/scim+json" \
 "http://localhost:8080/nevisidm/api/scim/v1/ResourceTypes/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SCIMMetaRestServiceApi;

import java.io.File;
import java.util.*;

public class SCIMMetaRestServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SCIMMetaRestServiceApi apiInstance = new SCIMMetaRestServiceApi();
        String id = 100; // String | Client's external identifier.

        try {
            ScimResourceType result = apiInstance.getStandardResource(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMMetaRestServiceApi#getStandardResource");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | Client's external identifier.

try {
    final result = await api_instance.getStandardResource(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getStandardResource: $e\n');
}

import org.openapitools.client.api.SCIMMetaRestServiceApi;

public class SCIMMetaRestServiceApiExample {
    public static void main(String[] args) {
        SCIMMetaRestServiceApi apiInstance = new SCIMMetaRestServiceApi();
        String id = 100; // String | Client's external identifier.

        try {
            ScimResourceType result = apiInstance.getStandardResource(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMMetaRestServiceApi#getStandardResource");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SCIMMetaRestServiceApi *apiInstance = [[SCIMMetaRestServiceApi alloc] init];
String *id = 100; // Client's external identifier. (default to null)

[apiInstance getStandardResourceWith:id
              completionHandler: ^(ScimResourceType output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SCIMMetaRestServiceApi()
var id = 100; // {String} Client's external identifier.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStandardResource(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getStandardResourceExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SCIMMetaRestServiceApi();
            var id = 100;  // String | Client's external identifier. (default to null)

            try {
                ScimResourceType result = apiInstance.getStandardResource(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SCIMMetaRestServiceApi.getStandardResource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SCIMMetaRestServiceApi();
$id = 100; // String | Client's external identifier.

try {
    $result = $api_instance->getStandardResource($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SCIMMetaRestServiceApi->getStandardResource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SCIMMetaRestServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SCIMMetaRestServiceApi->new();
my $id = 100; # String | Client's external identifier.

eval {
    my $result = $api_instance->getStandardResource(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SCIMMetaRestServiceApi->getStandardResource: $@\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.SCIMMetaRestServiceApi()
id = 100 # String | Client's external identifier. (default to null)

try:
    api_response = api_instance.get_standard_resource(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SCIMMetaRestServiceApi->getStandardResource: %s\n" % e)
extern crate SCIMMetaRestServiceApi;

pub fn main() {
    let id = 100; // String

    let mut context = SCIMMetaRestServiceApi::Context::default();
    let result = client.getStandardResource(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
Client's external identifier.
Required

Responses


listSchemas

listSchemas
get/scim/v1/Schemas

List of SCIM supported schemas.

Usage and SDK Samples

curl -X GET \
 -H "Accept: */*,application/json,application/scim+json" \
 "http://localhost:8080/nevisidm/api/scim/v1/Schemas?startIndex=1&count=10"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SCIMMetaRestServiceApi;

import java.io.File;
import java.util.*;

public class SCIMMetaRestServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SCIMMetaRestServiceApi apiInstance = new SCIMMetaRestServiceApi();
        Integer count = 10; // Integer | Maximum number of elements in the result list. Default value: 10.
        Integer startIndex = 1; // Integer | Start index for the listing. Default value: 1.

        try {
            ScimListResponse result = apiInstance.listSchemas(count, startIndex);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMMetaRestServiceApi#listSchemas");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer count = new Integer(); // Integer | Maximum number of elements in the result list. Default value: 10.
final Integer startIndex = new Integer(); // Integer | Start index for the listing. Default value: 1.

try {
    final result = await api_instance.listSchemas(count, startIndex);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listSchemas: $e\n');
}

import org.openapitools.client.api.SCIMMetaRestServiceApi;

public class SCIMMetaRestServiceApiExample {
    public static void main(String[] args) {
        SCIMMetaRestServiceApi apiInstance = new SCIMMetaRestServiceApi();
        Integer count = 10; // Integer | Maximum number of elements in the result list. Default value: 10.
        Integer startIndex = 1; // Integer | Start index for the listing. Default value: 1.

        try {
            ScimListResponse result = apiInstance.listSchemas(count, startIndex);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMMetaRestServiceApi#listSchemas");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SCIMMetaRestServiceApi *apiInstance = [[SCIMMetaRestServiceApi alloc] init];
Integer *count = 10; // Maximum number of elements in the result list. Default value: 10. (default to null)
Integer *startIndex = 1; // Start index for the listing. Default value: 1. (optional) (default to null)

[apiInstance listSchemasWith:count
    startIndex:startIndex
              completionHandler: ^(ScimListResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SCIMMetaRestServiceApi()
var count = 10; // {Integer} Maximum number of elements in the result list. Default value: 10.
var opts = {
  'startIndex': 1 // {Integer} Start index for the listing. Default value: 1.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listSchemas(count, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listSchemasExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SCIMMetaRestServiceApi();
            var count = 10;  // Integer | Maximum number of elements in the result list. Default value: 10. (default to null)
            var startIndex = 1;  // Integer | Start index for the listing. Default value: 1. (optional)  (default to null)

            try {
                ScimListResponse result = apiInstance.listSchemas(count, startIndex);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SCIMMetaRestServiceApi.listSchemas: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SCIMMetaRestServiceApi();
$count = 10; // Integer | Maximum number of elements in the result list. Default value: 10.
$startIndex = 1; // Integer | Start index for the listing. Default value: 1.

try {
    $result = $api_instance->listSchemas($count, $startIndex);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SCIMMetaRestServiceApi->listSchemas: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SCIMMetaRestServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SCIMMetaRestServiceApi->new();
my $count = 10; # Integer | Maximum number of elements in the result list. Default value: 10.
my $startIndex = 1; # Integer | Start index for the listing. Default value: 1.

eval {
    my $result = $api_instance->listSchemas(count => $count, startIndex => $startIndex);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SCIMMetaRestServiceApi->listSchemas: $@\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.SCIMMetaRestServiceApi()
count = 10 # Integer | Maximum number of elements in the result list. Default value: 10. (default to null)
startIndex = 1 # Integer | Start index for the listing. Default value: 1. (optional) (default to null)

try:
    api_response = api_instance.list_schemas(count, startIndex=startIndex)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SCIMMetaRestServiceApi->listSchemas: %s\n" % e)
extern crate SCIMMetaRestServiceApi;

pub fn main() {
    let count = 10; // Integer
    let startIndex = 1; // Integer

    let mut context = SCIMMetaRestServiceApi::Context::default();
    let result = client.listSchemas(count, startIndex, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
startIndex
Integer
Start index for the listing. Default value: 1.
count*
Integer
Maximum number of elements in the result list. Default value: 10.
Required

Responses


listStandardResources

listStandardResources
get/scim/v1/ResourceTypes

Get all supported SCIM standard resource definition.

Usage and SDK Samples

curl -X GET \
 -H "Accept: */*,application/json,application/scim+json" \
 "http://localhost:8080/nevisidm/api/scim/v1/ResourceTypes?startIndex=1&count=10"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SCIMMetaRestServiceApi;

import java.io.File;
import java.util.*;

public class SCIMMetaRestServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SCIMMetaRestServiceApi apiInstance = new SCIMMetaRestServiceApi();
        Integer startIndex = 1; // Integer | Start index for the listing. Default value: 1.
        Integer count = 10; // Integer | Maximum number of elements in the result list. Default value: 10.

        try {
            ScimListResponse result = apiInstance.listStandardResources(startIndex, count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMMetaRestServiceApi#listStandardResources");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer startIndex = new Integer(); // Integer | Start index for the listing. Default value: 1.
final Integer count = new Integer(); // Integer | Maximum number of elements in the result list. Default value: 10.

try {
    final result = await api_instance.listStandardResources(startIndex, count);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listStandardResources: $e\n');
}

import org.openapitools.client.api.SCIMMetaRestServiceApi;

public class SCIMMetaRestServiceApiExample {
    public static void main(String[] args) {
        SCIMMetaRestServiceApi apiInstance = new SCIMMetaRestServiceApi();
        Integer startIndex = 1; // Integer | Start index for the listing. Default value: 1.
        Integer count = 10; // Integer | Maximum number of elements in the result list. Default value: 10.

        try {
            ScimListResponse result = apiInstance.listStandardResources(startIndex, count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SCIMMetaRestServiceApi#listStandardResources");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SCIMMetaRestServiceApi *apiInstance = [[SCIMMetaRestServiceApi alloc] init];
Integer *startIndex = 1; // Start index for the listing. Default value: 1. (optional) (default to null)
Integer *count = 10; // Maximum number of elements in the result list. Default value: 10. (optional) (default to null)

[apiInstance listStandardResourcesWith:startIndex
    count:count
              completionHandler: ^(ScimListResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SCIMMetaRestServiceApi()
var opts = {
  'startIndex': 1, // {Integer} Start index for the listing. Default value: 1.
  'count': 10 // {Integer} Maximum number of elements in the result list. Default value: 10.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listStandardResources(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listStandardResourcesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SCIMMetaRestServiceApi();
            var startIndex = 1;  // Integer | Start index for the listing. Default value: 1. (optional)  (default to null)
            var count = 10;  // Integer | Maximum number of elements in the result list. Default value: 10. (optional)  (default to null)

            try {
                ScimListResponse result = apiInstance.listStandardResources(startIndex, count);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SCIMMetaRestServiceApi.listStandardResources: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SCIMMetaRestServiceApi();
$startIndex = 1; // Integer | Start index for the listing. Default value: 1.
$count = 10; // Integer | Maximum number of elements in the result list. Default value: 10.

try {
    $result = $api_instance->listStandardResources($startIndex, $count);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SCIMMetaRestServiceApi->listStandardResources: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SCIMMetaRestServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SCIMMetaRestServiceApi->new();
my $startIndex = 1; # Integer | Start index for the listing. Default value: 1.
my $count = 10; # Integer | Maximum number of elements in the result list. Default value: 10.

eval {
    my $result = $api_instance->listStandardResources(startIndex => $startIndex, count => $count);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SCIMMetaRestServiceApi->listStandardResources: $@\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.SCIMMetaRestServiceApi()
startIndex = 1 # Integer | Start index for the listing. Default value: 1. (optional) (default to null)
count = 10 # Integer | Maximum number of elements in the result list. Default value: 10. (optional) (default to null)

try:
    api_response = api_instance.list_standard_resources(startIndex=startIndex, count=count)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SCIMMetaRestServiceApi->listStandardResources: %s\n" % e)
extern crate SCIMMetaRestServiceApi;

pub fn main() {
    let startIndex = 1; // Integer
    let count = 10; // Integer

    let mut context = SCIMMetaRestServiceApi::Context::default();
    let result = client.listStandardResources(startIndex, count, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
startIndex
Integer
Start index for the listing. Default value: 1.
count
Integer
Maximum number of elements in the result list. Default value: 10.

Responses


SafewordRESTService

createSafeword

createSafeword
post/core/v1/{clientExtId}/users/{userExtId}/safeword

**Since:** 2.79.0 **Required permission(s):** `AccessControl.CredentialCreate` Creates a Safeword credential for the user with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/safeword" \
 -d '{
  "stateName" : "INITIAL",
  "extId" : "extId",
  "username" : "username"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SafewordRESTServiceApi;

import java.io.File;
import java.util.*;

public class SafewordRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SafewordRESTServiceApi apiInstance = new SafewordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        SafewordCreateDTO safewordCreateDTO = {"extId":"safewordExtId","username":"username","stateName":"active"}; // SafewordCreateDTO | 

        try {
            apiInstance.createSafeword(clientExtId, userExtId, safewordCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling SafewordRESTServiceApi#createSafeword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final SafewordCreateDTO safewordCreateDTO = new SafewordCreateDTO(); // SafewordCreateDTO | 

try {
    final result = await api_instance.createSafeword(clientExtId, userExtId, safewordCreateDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createSafeword: $e\n');
}

import org.openapitools.client.api.SafewordRESTServiceApi;

public class SafewordRESTServiceApiExample {
    public static void main(String[] args) {
        SafewordRESTServiceApi apiInstance = new SafewordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        SafewordCreateDTO safewordCreateDTO = {"extId":"safewordExtId","username":"username","stateName":"active"}; // SafewordCreateDTO | 

        try {
            apiInstance.createSafeword(clientExtId, userExtId, safewordCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling SafewordRESTServiceApi#createSafeword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SafewordRESTServiceApi *apiInstance = [[SafewordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
SafewordCreateDTO *safewordCreateDTO = {"extId":"safewordExtId","username":"username","stateName":"active"}; // 

// Create Safeword
[apiInstance createSafewordWith:clientExtId
    userExtId:userExtId
    safewordCreateDTO:safewordCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SafewordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var safewordCreateDTO = {"extId":"safewordExtId","username":"username","stateName":"active"}; // {SafewordCreateDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createSafeword(clientExtId, userExtId, safewordCreateDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createSafewordExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SafewordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var safewordCreateDTO = new SafewordCreateDTO(); // SafewordCreateDTO | 

            try {
                // Create Safeword
                apiInstance.createSafeword(clientExtId, userExtId, safewordCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling SafewordRESTServiceApi.createSafeword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SafewordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$safewordCreateDTO = {"extId":"safewordExtId","username":"username","stateName":"active"}; // SafewordCreateDTO | 

try {
    $api_instance->createSafeword($clientExtId, $userExtId, $safewordCreateDTO);
} catch (Exception $e) {
    echo 'Exception when calling SafewordRESTServiceApi->createSafeword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SafewordRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SafewordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $safewordCreateDTO = WWW::OPenAPIClient::Object::SafewordCreateDTO->new(); # SafewordCreateDTO | 

eval {
    $api_instance->createSafeword(clientExtId => $clientExtId, userExtId => $userExtId, safewordCreateDTO => $safewordCreateDTO);
};
if ($@) {
    warn "Exception when calling SafewordRESTServiceApi->createSafeword: $@\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.SafewordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
safewordCreateDTO = {"extId":"safewordExtId","username":"username","stateName":"active"} # SafewordCreateDTO | 

try:
    # Create Safeword
    api_instance.create_safeword(clientExtId, userExtId, safewordCreateDTO)
except ApiException as e:
    print("Exception when calling SafewordRESTServiceApi->createSafeword: %s\n" % e)
extern crate SafewordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let safewordCreateDTO = {"extId":"safewordExtId","username":"username","stateName":"active"}; // SafewordCreateDTO

    let mut context = SafewordRESTServiceApi::Context::default();
    let result = client.createSafeword(clientExtId, userExtId, safewordCreateDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
safewordCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

deleteSafeword

deleteSafeword
delete/core/v1/{clientExtId}/users/{userExtId}/safeword

**Since:** 2.79.0 **Required permission(s):** `AccessControl.CredentialDelete` or `SelfAdmin` Role Deletes the safeword credential of the user specified with the userExtId.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/safeword"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SafewordRESTServiceApi;

import java.io.File;
import java.util.*;

public class SafewordRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SafewordRESTServiceApi apiInstance = new SafewordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            apiInstance.deleteSafeword(clientExtId, userExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SafewordRESTServiceApi#deleteSafeword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user

try {
    final result = await api_instance.deleteSafeword(clientExtId, userExtId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteSafeword: $e\n');
}

import org.openapitools.client.api.SafewordRESTServiceApi;

public class SafewordRESTServiceApiExample {
    public static void main(String[] args) {
        SafewordRESTServiceApi apiInstance = new SafewordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            apiInstance.deleteSafeword(clientExtId, userExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SafewordRESTServiceApi#deleteSafeword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SafewordRESTServiceApi *apiInstance = [[SafewordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)

// Delete safeword credential
[apiInstance deleteSafewordWith:clientExtId
    userExtId:userExtId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SafewordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteSafeword(clientExtId, userExtId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteSafewordExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SafewordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)

            try {
                // Delete safeword credential
                apiInstance.deleteSafeword(clientExtId, userExtId);
            } catch (Exception e) {
                Debug.Print("Exception when calling SafewordRESTServiceApi.deleteSafeword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SafewordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user

try {
    $api_instance->deleteSafeword($clientExtId, $userExtId);
} catch (Exception $e) {
    echo 'Exception when calling SafewordRESTServiceApi->deleteSafeword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SafewordRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SafewordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user

eval {
    $api_instance->deleteSafeword(clientExtId => $clientExtId, userExtId => $userExtId);
};
if ($@) {
    warn "Exception when calling SafewordRESTServiceApi->deleteSafeword: $@\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.SafewordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)

try:
    # Delete safeword credential
    api_instance.delete_safeword(clientExtId, userExtId)
except ApiException as e:
    print("Exception when calling SafewordRESTServiceApi->deleteSafeword: %s\n" % e)
extern crate SafewordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String

    let mut context = SafewordRESTServiceApi::Context::default();
    let result = client.deleteSafeword(clientExtId, userExtId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required

Responses


getSafeWordCredential

getSafeWordCredential
get/core/v1/{clientExtId}/users/{userExtId}/safeword

**Since:** 2.79.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns the Safeword credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/safeword"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SafewordRESTServiceApi;

import java.io.File;
import java.util.*;

public class SafewordRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SafewordRESTServiceApi apiInstance = new SafewordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            SafewordGetDTO result = apiInstance.getSafeWordCredential(clientExtId, userExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SafewordRESTServiceApi#getSafeWordCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user

try {
    final result = await api_instance.getSafeWordCredential(clientExtId, userExtId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSafeWordCredential: $e\n');
}

import org.openapitools.client.api.SafewordRESTServiceApi;

public class SafewordRESTServiceApiExample {
    public static void main(String[] args) {
        SafewordRESTServiceApi apiInstance = new SafewordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            SafewordGetDTO result = apiInstance.getSafeWordCredential(clientExtId, userExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SafewordRESTServiceApi#getSafeWordCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SafewordRESTServiceApi *apiInstance = [[SafewordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)

// Get Safeword credential
[apiInstance getSafeWordCredentialWith:clientExtId
    userExtId:userExtId
              completionHandler: ^(SafewordGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SafewordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSafeWordCredential(clientExtId, userExtId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSafeWordCredentialExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SafewordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)

            try {
                // Get Safeword credential
                SafewordGetDTO result = apiInstance.getSafeWordCredential(clientExtId, userExtId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SafewordRESTServiceApi.getSafeWordCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SafewordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user

try {
    $result = $api_instance->getSafeWordCredential($clientExtId, $userExtId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SafewordRESTServiceApi->getSafeWordCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SafewordRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SafewordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user

eval {
    my $result = $api_instance->getSafeWordCredential(clientExtId => $clientExtId, userExtId => $userExtId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SafewordRESTServiceApi->getSafeWordCredential: $@\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.SafewordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)

try:
    # Get Safeword credential
    api_response = api_instance.get_safe_word_credential(clientExtId, userExtId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SafewordRESTServiceApi->getSafeWordCredential: %s\n" % e)
extern crate SafewordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String

    let mut context = SafewordRESTServiceApi::Context::default();
    let result = client.getSafeWordCredential(clientExtId, userExtId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required

Responses


updateSafewordCredential

updateSafewordCredential
patch/core/v1/{clientExtId}/users/{userExtId}/safeword

**Since:** 2.79.0 **Required permission(s):** `AccessControl.CredentialModify,AccessControl.CredentialView` Updates the Safeword credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/safeword" \
 -d '{
  "stateName" : "INITIAL",
  "modificationComment" : "modificationComment",
  "version" : 0,
  "username" : "username"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SafewordRESTServiceApi;

import java.io.File;
import java.util.*;

public class SafewordRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SafewordRESTServiceApi apiInstance = new SafewordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        SafewordPatchDto safewordPatchDto = {"username":"safeword-patch-01","stateName":"active","modificationComment":"safeword-patch-01 comment","version":2}; // SafewordPatchDto | 

        try {
            SafewordGetDTO result = apiInstance.updateSafewordCredential(clientExtId, userExtId, safewordPatchDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SafewordRESTServiceApi#updateSafewordCredential");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final SafewordPatchDto safewordPatchDto = new SafewordPatchDto(); // SafewordPatchDto | 

try {
    final result = await api_instance.updateSafewordCredential(clientExtId, userExtId, safewordPatchDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateSafewordCredential: $e\n');
}

import org.openapitools.client.api.SafewordRESTServiceApi;

public class SafewordRESTServiceApiExample {
    public static void main(String[] args) {
        SafewordRESTServiceApi apiInstance = new SafewordRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        SafewordPatchDto safewordPatchDto = {"username":"safeword-patch-01","stateName":"active","modificationComment":"safeword-patch-01 comment","version":2}; // SafewordPatchDto | 

        try {
            SafewordGetDTO result = apiInstance.updateSafewordCredential(clientExtId, userExtId, safewordPatchDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SafewordRESTServiceApi#updateSafewordCredential");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SafewordRESTServiceApi *apiInstance = [[SafewordRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
SafewordPatchDto *safewordPatchDto = {"username":"safeword-patch-01","stateName":"active","modificationComment":"safeword-patch-01 comment","version":2}; // 

// Update Safeword Credential
[apiInstance updateSafewordCredentialWith:clientExtId
    userExtId:userExtId
    safewordPatchDto:safewordPatchDto
              completionHandler: ^(SafewordGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SafewordRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var safewordPatchDto = {"username":"safeword-patch-01","stateName":"active","modificationComment":"safeword-patch-01 comment","version":2}; // {SafewordPatchDto} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateSafewordCredential(clientExtId, userExtId, safewordPatchDto, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateSafewordCredentialExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SafewordRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var safewordPatchDto = new SafewordPatchDto(); // SafewordPatchDto | 

            try {
                // Update Safeword Credential
                SafewordGetDTO result = apiInstance.updateSafewordCredential(clientExtId, userExtId, safewordPatchDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SafewordRESTServiceApi.updateSafewordCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SafewordRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$safewordPatchDto = {"username":"safeword-patch-01","stateName":"active","modificationComment":"safeword-patch-01 comment","version":2}; // SafewordPatchDto | 

try {
    $result = $api_instance->updateSafewordCredential($clientExtId, $userExtId, $safewordPatchDto);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SafewordRESTServiceApi->updateSafewordCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SafewordRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SafewordRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $safewordPatchDto = WWW::OPenAPIClient::Object::SafewordPatchDto->new(); # SafewordPatchDto | 

eval {
    my $result = $api_instance->updateSafewordCredential(clientExtId => $clientExtId, userExtId => $userExtId, safewordPatchDto => $safewordPatchDto);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SafewordRESTServiceApi->updateSafewordCredential: $@\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.SafewordRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
safewordPatchDto = {"username":"safeword-patch-01","stateName":"active","modificationComment":"safeword-patch-01 comment","version":2} # SafewordPatchDto | 

try:
    # Update Safeword Credential
    api_response = api_instance.update_safeword_credential(clientExtId, userExtId, safewordPatchDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SafewordRESTServiceApi->updateSafewordCredential: %s\n" % e)
extern crate SafewordRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let safewordPatchDto = {"username":"safeword-patch-01","stateName":"active","modificationComment":"safeword-patch-01 comment","version":2}; // SafewordPatchDto

    let mut context = SafewordRESTServiceApi::Context::default();
    let result = client.updateSafewordCredential(clientExtId, userExtId, safewordPatchDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
safewordPatchDto *

Responses


SecurIDRESTService

createSecurId

createSecurId
post/core/v1/{clientExtId}/users/{userExtId}/securid

**Since:** 2.75.1 **Required permission(s):** `AccessControl.CredentialCreate` Creates a SecurID credential for the user with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/securid" \
 -d '{
  "stateName" : "INITIAL",
  "extId" : "extId",
  "username" : "username"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurIDRESTServiceApi;

import java.io.File;
import java.util.*;

public class SecurIDRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SecurIDRESTServiceApi apiInstance = new SecurIDRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        SecurIdCreateDTO securIdCreateDTO = {"extId":"securIdExtId","username":"securid_username","stateName":"active"}; // SecurIdCreateDTO | 

        try {
            apiInstance.createSecurId(clientExtId, userExtId, securIdCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurIDRESTServiceApi#createSecurId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final SecurIdCreateDTO securIdCreateDTO = new SecurIdCreateDTO(); // SecurIdCreateDTO | 

try {
    final result = await api_instance.createSecurId(clientExtId, userExtId, securIdCreateDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createSecurId: $e\n');
}

import org.openapitools.client.api.SecurIDRESTServiceApi;

public class SecurIDRESTServiceApiExample {
    public static void main(String[] args) {
        SecurIDRESTServiceApi apiInstance = new SecurIDRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        SecurIdCreateDTO securIdCreateDTO = {"extId":"securIdExtId","username":"securid_username","stateName":"active"}; // SecurIdCreateDTO | 

        try {
            apiInstance.createSecurId(clientExtId, userExtId, securIdCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurIDRESTServiceApi#createSecurId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurIDRESTServiceApi *apiInstance = [[SecurIDRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
SecurIdCreateDTO *securIdCreateDTO = {"extId":"securIdExtId","username":"securid_username","stateName":"active"}; // 

// Create SecurID
[apiInstance createSecurIdWith:clientExtId
    userExtId:userExtId
    securIdCreateDTO:securIdCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SecurIDRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var securIdCreateDTO = {"extId":"securIdExtId","username":"securid_username","stateName":"active"}; // {SecurIdCreateDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createSecurId(clientExtId, userExtId, securIdCreateDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createSecurIdExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SecurIDRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var securIdCreateDTO = new SecurIdCreateDTO(); // SecurIdCreateDTO | 

            try {
                // Create SecurID
                apiInstance.createSecurId(clientExtId, userExtId, securIdCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurIDRESTServiceApi.createSecurId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurIDRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$securIdCreateDTO = {"extId":"securIdExtId","username":"securid_username","stateName":"active"}; // SecurIdCreateDTO | 

try {
    $api_instance->createSecurId($clientExtId, $userExtId, $securIdCreateDTO);
} catch (Exception $e) {
    echo 'Exception when calling SecurIDRESTServiceApi->createSecurId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurIDRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurIDRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $securIdCreateDTO = WWW::OPenAPIClient::Object::SecurIdCreateDTO->new(); # SecurIdCreateDTO | 

eval {
    $api_instance->createSecurId(clientExtId => $clientExtId, userExtId => $userExtId, securIdCreateDTO => $securIdCreateDTO);
};
if ($@) {
    warn "Exception when calling SecurIDRESTServiceApi->createSecurId: $@\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.SecurIDRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
securIdCreateDTO = {"extId":"securIdExtId","username":"securid_username","stateName":"active"} # SecurIdCreateDTO | 

try:
    # Create SecurID
    api_instance.create_secur_id(clientExtId, userExtId, securIdCreateDTO)
except ApiException as e:
    print("Exception when calling SecurIDRESTServiceApi->createSecurId: %s\n" % e)
extern crate SecurIDRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let securIdCreateDTO = {"extId":"securIdExtId","username":"securid_username","stateName":"active"}; // SecurIdCreateDTO

    let mut context = SecurIDRESTServiceApi::Context::default();
    let result = client.createSecurId(clientExtId, userExtId, securIdCreateDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
securIdCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

deleteSecurId

deleteSecurId
delete/core/v1/{clientExtId}/users/{userExtId}/securid

**Since:** 2.79.0 **Required permission(s):** `AccessControl.CredentialDelete` or `SelfAdmin` Role Deletes the SecurID credential associated to the user with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/securid"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurIDRESTServiceApi;

import java.io.File;
import java.util.*;

public class SecurIDRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SecurIDRESTServiceApi apiInstance = new SecurIDRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            apiInstance.deleteSecurId(clientExtId, userExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurIDRESTServiceApi#deleteSecurId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user

try {
    final result = await api_instance.deleteSecurId(clientExtId, userExtId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteSecurId: $e\n');
}

import org.openapitools.client.api.SecurIDRESTServiceApi;

public class SecurIDRESTServiceApiExample {
    public static void main(String[] args) {
        SecurIDRESTServiceApi apiInstance = new SecurIDRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            apiInstance.deleteSecurId(clientExtId, userExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurIDRESTServiceApi#deleteSecurId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurIDRESTServiceApi *apiInstance = [[SecurIDRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)

// Delete SecurID Credential
[apiInstance deleteSecurIdWith:clientExtId
    userExtId:userExtId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SecurIDRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteSecurId(clientExtId, userExtId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteSecurIdExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SecurIDRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)

            try {
                // Delete SecurID Credential
                apiInstance.deleteSecurId(clientExtId, userExtId);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurIDRESTServiceApi.deleteSecurId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurIDRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user

try {
    $api_instance->deleteSecurId($clientExtId, $userExtId);
} catch (Exception $e) {
    echo 'Exception when calling SecurIDRESTServiceApi->deleteSecurId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurIDRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurIDRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user

eval {
    $api_instance->deleteSecurId(clientExtId => $clientExtId, userExtId => $userExtId);
};
if ($@) {
    warn "Exception when calling SecurIDRESTServiceApi->deleteSecurId: $@\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.SecurIDRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)

try:
    # Delete SecurID Credential
    api_instance.delete_secur_id(clientExtId, userExtId)
except ApiException as e:
    print("Exception when calling SecurIDRESTServiceApi->deleteSecurId: %s\n" % e)
extern crate SecurIDRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String

    let mut context = SecurIDRESTServiceApi::Context::default();
    let result = client.deleteSecurId(clientExtId, userExtId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required

Responses


getSecurId

getSecurId
get/core/v1/{clientExtId}/users/{userExtId}/securid

**Since:** 2.75.1 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns the SecurID credential belonging to the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/securid"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurIDRESTServiceApi;

import java.io.File;
import java.util.*;

public class SecurIDRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SecurIDRESTServiceApi apiInstance = new SecurIDRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            SecurIdGetDTO result = apiInstance.getSecurId(clientExtId, userExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurIDRESTServiceApi#getSecurId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user

try {
    final result = await api_instance.getSecurId(clientExtId, userExtId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSecurId: $e\n');
}

import org.openapitools.client.api.SecurIDRESTServiceApi;

public class SecurIDRESTServiceApiExample {
    public static void main(String[] args) {
        SecurIDRESTServiceApi apiInstance = new SecurIDRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            SecurIdGetDTO result = apiInstance.getSecurId(clientExtId, userExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurIDRESTServiceApi#getSecurId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurIDRESTServiceApi *apiInstance = [[SecurIDRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)

// Get SecurID Credential
[apiInstance getSecurIdWith:clientExtId
    userExtId:userExtId
              completionHandler: ^(SecurIdGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SecurIDRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSecurId(clientExtId, userExtId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSecurIdExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SecurIDRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)

            try {
                // Get SecurID Credential
                SecurIdGetDTO result = apiInstance.getSecurId(clientExtId, userExtId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurIDRESTServiceApi.getSecurId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurIDRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user

try {
    $result = $api_instance->getSecurId($clientExtId, $userExtId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurIDRESTServiceApi->getSecurId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurIDRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurIDRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user

eval {
    my $result = $api_instance->getSecurId(clientExtId => $clientExtId, userExtId => $userExtId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurIDRESTServiceApi->getSecurId: $@\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.SecurIDRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)

try:
    # Get SecurID Credential
    api_response = api_instance.get_secur_id(clientExtId, userExtId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurIDRESTServiceApi->getSecurId: %s\n" % e)
extern crate SecurIDRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String

    let mut context = SecurIDRESTServiceApi::Context::default();
    let result = client.getSecurId(clientExtId, userExtId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required

Responses


updateSecurId

updateSecurId
patch/core/v1/{clientExtId}/users/{userExtId}/securid

**Since:** 2.77.0 **Required permission(s):** `AccessControl.CredentialModify,AccessControl.CredentialView` Updates the SecurID credential with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/securid" \
 -d '{
  "stateName" : "INITIAL",
  "modificationComment" : "modificationComment",
  "version" : 0,
  "username" : "username"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurIDRESTServiceApi;

import java.io.File;
import java.util.*;

public class SecurIDRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SecurIDRESTServiceApi apiInstance = new SecurIDRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        SecurIdPatchDTO securIdPatchDTO = {"username":"securid_username","stateName":"active","modificationComment":"securid-patch-01 comment","version":1}; // SecurIdPatchDTO | 

        try {
            SecurIdGetDTO result = apiInstance.updateSecurId(clientExtId, userExtId, securIdPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurIDRESTServiceApi#updateSecurId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final SecurIdPatchDTO securIdPatchDTO = new SecurIdPatchDTO(); // SecurIdPatchDTO | 

try {
    final result = await api_instance.updateSecurId(clientExtId, userExtId, securIdPatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateSecurId: $e\n');
}

import org.openapitools.client.api.SecurIDRESTServiceApi;

public class SecurIDRESTServiceApiExample {
    public static void main(String[] args) {
        SecurIDRESTServiceApi apiInstance = new SecurIDRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        SecurIdPatchDTO securIdPatchDTO = {"username":"securid_username","stateName":"active","modificationComment":"securid-patch-01 comment","version":1}; // SecurIdPatchDTO | 

        try {
            SecurIdGetDTO result = apiInstance.updateSecurId(clientExtId, userExtId, securIdPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurIDRESTServiceApi#updateSecurId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurIDRESTServiceApi *apiInstance = [[SecurIDRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
SecurIdPatchDTO *securIdPatchDTO = {"username":"securid_username","stateName":"active","modificationComment":"securid-patch-01 comment","version":1}; // 

// Update SecurID Credential
[apiInstance updateSecurIdWith:clientExtId
    userExtId:userExtId
    securIdPatchDTO:securIdPatchDTO
              completionHandler: ^(SecurIdGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SecurIDRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var securIdPatchDTO = {"username":"securid_username","stateName":"active","modificationComment":"securid-patch-01 comment","version":1}; // {SecurIdPatchDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateSecurId(clientExtId, userExtId, securIdPatchDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateSecurIdExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SecurIDRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var securIdPatchDTO = new SecurIdPatchDTO(); // SecurIdPatchDTO | 

            try {
                // Update SecurID Credential
                SecurIdGetDTO result = apiInstance.updateSecurId(clientExtId, userExtId, securIdPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurIDRESTServiceApi.updateSecurId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurIDRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$securIdPatchDTO = {"username":"securid_username","stateName":"active","modificationComment":"securid-patch-01 comment","version":1}; // SecurIdPatchDTO | 

try {
    $result = $api_instance->updateSecurId($clientExtId, $userExtId, $securIdPatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurIDRESTServiceApi->updateSecurId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurIDRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurIDRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $securIdPatchDTO = WWW::OPenAPIClient::Object::SecurIdPatchDTO->new(); # SecurIdPatchDTO | 

eval {
    my $result = $api_instance->updateSecurId(clientExtId => $clientExtId, userExtId => $userExtId, securIdPatchDTO => $securIdPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurIDRESTServiceApi->updateSecurId: $@\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.SecurIDRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
securIdPatchDTO = {"username":"securid_username","stateName":"active","modificationComment":"securid-patch-01 comment","version":1} # SecurIdPatchDTO | 

try:
    # Update SecurID Credential
    api_response = api_instance.update_secur_id(clientExtId, userExtId, securIdPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurIDRESTServiceApi->updateSecurId: %s\n" % e)
extern crate SecurIDRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let securIdPatchDTO = {"username":"securid_username","stateName":"active","modificationComment":"securid-patch-01 comment","version":1}; // SecurIdPatchDTO

    let mut context = SecurIDRESTServiceApi::Context::default();
    let result = client.updateSecurId(clientExtId, userExtId, securIdPatchDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
securIdPatchDTO *

Responses


SystemValueRESTService

getCountries

getCountries
get/core/v1/system/countries

**Since:** 2.79.0 Returns the available countries.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/system/countries"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemValueRESTServiceApi;

import java.io.File;
import java.util.*;

public class SystemValueRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SystemValueRESTServiceApi apiInstance = new SystemValueRESTServiceApi();

        try {
            ItemsWrapperForString result = apiInstance.getCountries();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemValueRESTServiceApi#getCountries");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getCountries();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCountries: $e\n');
}

import org.openapitools.client.api.SystemValueRESTServiceApi;

public class SystemValueRESTServiceApiExample {
    public static void main(String[] args) {
        SystemValueRESTServiceApi apiInstance = new SystemValueRESTServiceApi();

        try {
            ItemsWrapperForString result = apiInstance.getCountries();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemValueRESTServiceApi#getCountries");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SystemValueRESTServiceApi *apiInstance = [[SystemValueRESTServiceApi alloc] init];

// Get countries
[apiInstance getCountriesWithCompletionHandler: 
              ^(ItemsWrapperForString output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SystemValueRESTServiceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCountries(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCountriesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SystemValueRESTServiceApi();

            try {
                // Get countries
                ItemsWrapperForString result = apiInstance.getCountries();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemValueRESTServiceApi.getCountries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemValueRESTServiceApi();

try {
    $result = $api_instance->getCountries();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemValueRESTServiceApi->getCountries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemValueRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemValueRESTServiceApi->new();

eval {
    my $result = $api_instance->getCountries();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemValueRESTServiceApi->getCountries: $@\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.SystemValueRESTServiceApi()

try:
    # Get countries
    api_response = api_instance.get_countries()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemValueRESTServiceApi->getCountries: %s\n" % e)
extern crate SystemValueRESTServiceApi;

pub fn main() {

    let mut context = SystemValueRESTServiceApi::Context::default();
    let result = client.getCountries(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getCredStateChangeReasons

getCredStateChangeReasons
get/core/v1/system/credential-state-change-reasons

**Since:** 2.79.0 Returns the available reasons to change a credential state.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/system/credential-state-change-reasons"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemValueRESTServiceApi;

import java.io.File;
import java.util.*;

public class SystemValueRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SystemValueRESTServiceApi apiInstance = new SystemValueRESTServiceApi();

        try {
            ItemsWrapperForString result = apiInstance.getCredStateChangeReasons();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemValueRESTServiceApi#getCredStateChangeReasons");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getCredStateChangeReasons();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCredStateChangeReasons: $e\n');
}

import org.openapitools.client.api.SystemValueRESTServiceApi;

public class SystemValueRESTServiceApiExample {
    public static void main(String[] args) {
        SystemValueRESTServiceApi apiInstance = new SystemValueRESTServiceApi();

        try {
            ItemsWrapperForString result = apiInstance.getCredStateChangeReasons();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemValueRESTServiceApi#getCredStateChangeReasons");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SystemValueRESTServiceApi *apiInstance = [[SystemValueRESTServiceApi alloc] init];

// Get credential state change reasons
[apiInstance getCredStateChangeReasonsWithCompletionHandler: 
              ^(ItemsWrapperForString output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SystemValueRESTServiceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCredStateChangeReasons(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCredStateChangeReasonsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SystemValueRESTServiceApi();

            try {
                // Get credential state change reasons
                ItemsWrapperForString result = apiInstance.getCredStateChangeReasons();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemValueRESTServiceApi.getCredStateChangeReasons: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemValueRESTServiceApi();

try {
    $result = $api_instance->getCredStateChangeReasons();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemValueRESTServiceApi->getCredStateChangeReasons: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemValueRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemValueRESTServiceApi->new();

eval {
    my $result = $api_instance->getCredStateChangeReasons();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemValueRESTServiceApi->getCredStateChangeReasons: $@\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.SystemValueRESTServiceApi()

try:
    # Get credential state change reasons
    api_response = api_instance.get_cred_state_change_reasons()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemValueRESTServiceApi->getCredStateChangeReasons: %s\n" % e)
extern crate SystemValueRESTServiceApi;

pub fn main() {

    let mut context = SystemValueRESTServiceApi::Context::default();
    let result = client.getCredStateChangeReasons(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getCredentialStates

getCredentialStates
get/core/v1/system/credential-states

**Since:** 2.79.0 Returns the available credential states.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/system/credential-states"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemValueRESTServiceApi;

import java.io.File;
import java.util.*;

public class SystemValueRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SystemValueRESTServiceApi apiInstance = new SystemValueRESTServiceApi();

        try {
            ItemsWrapperForString result = apiInstance.getCredentialStates();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemValueRESTServiceApi#getCredentialStates");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getCredentialStates();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCredentialStates: $e\n');
}

import org.openapitools.client.api.SystemValueRESTServiceApi;

public class SystemValueRESTServiceApiExample {
    public static void main(String[] args) {
        SystemValueRESTServiceApi apiInstance = new SystemValueRESTServiceApi();

        try {
            ItemsWrapperForString result = apiInstance.getCredentialStates();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemValueRESTServiceApi#getCredentialStates");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SystemValueRESTServiceApi *apiInstance = [[SystemValueRESTServiceApi alloc] init];

// Get credential states
[apiInstance getCredentialStatesWithCompletionHandler: 
              ^(ItemsWrapperForString output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SystemValueRESTServiceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCredentialStates(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCredentialStatesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SystemValueRESTServiceApi();

            try {
                // Get credential states
                ItemsWrapperForString result = apiInstance.getCredentialStates();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemValueRESTServiceApi.getCredentialStates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemValueRESTServiceApi();

try {
    $result = $api_instance->getCredentialStates();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemValueRESTServiceApi->getCredentialStates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemValueRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemValueRESTServiceApi->new();

eval {
    my $result = $api_instance->getCredentialStates();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemValueRESTServiceApi->getCredentialStates: $@\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.SystemValueRESTServiceApi()

try:
    # Get credential states
    api_response = api_instance.get_credential_states()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemValueRESTServiceApi->getCredentialStates: %s\n" % e)
extern crate SystemValueRESTServiceApi;

pub fn main() {

    let mut context = SystemValueRESTServiceApi::Context::default();
    let result = client.getCredentialStates(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getIdmTimezone

getIdmTimezone
get/core/v1/system/timezone

**Since:** 7.2505.2, 8.2505.5 Returns the Time Zone Id in which IDM is running.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/system/timezone"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemValueRESTServiceApi;

import java.io.File;
import java.util.*;

public class SystemValueRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SystemValueRESTServiceApi apiInstance = new SystemValueRESTServiceApi();

        try {
            TimeZoneGetDTO result = apiInstance.getIdmTimezone();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemValueRESTServiceApi#getIdmTimezone");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getIdmTimezone();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getIdmTimezone: $e\n');
}

import org.openapitools.client.api.SystemValueRESTServiceApi;

public class SystemValueRESTServiceApiExample {
    public static void main(String[] args) {
        SystemValueRESTServiceApi apiInstance = new SystemValueRESTServiceApi();

        try {
            TimeZoneGetDTO result = apiInstance.getIdmTimezone();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemValueRESTServiceApi#getIdmTimezone");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SystemValueRESTServiceApi *apiInstance = [[SystemValueRESTServiceApi alloc] init];

// Get System Time Zone
[apiInstance getIdmTimezoneWithCompletionHandler: 
              ^(TimeZoneGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SystemValueRESTServiceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getIdmTimezone(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getIdmTimezoneExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SystemValueRESTServiceApi();

            try {
                // Get System Time Zone
                TimeZoneGetDTO result = apiInstance.getIdmTimezone();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemValueRESTServiceApi.getIdmTimezone: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemValueRESTServiceApi();

try {
    $result = $api_instance->getIdmTimezone();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemValueRESTServiceApi->getIdmTimezone: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemValueRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemValueRESTServiceApi->new();

eval {
    my $result = $api_instance->getIdmTimezone();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemValueRESTServiceApi->getIdmTimezone: $@\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.SystemValueRESTServiceApi()

try:
    # Get System Time Zone
    api_response = api_instance.get_idm_timezone()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemValueRESTServiceApi->getIdmTimezone: %s\n" % e)
extern crate SystemValueRESTServiceApi;

pub fn main() {

    let mut context = SystemValueRESTServiceApi::Context::default();
    let result = client.getIdmTimezone(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getLanguages

getLanguages
get/core/v1/system/languages

**Since:** 2.79.0 Returns the available languages.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/system/languages"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemValueRESTServiceApi;

import java.io.File;
import java.util.*;

public class SystemValueRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SystemValueRESTServiceApi apiInstance = new SystemValueRESTServiceApi();

        try {
            ItemsWrapperForString result = apiInstance.getLanguages();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemValueRESTServiceApi#getLanguages");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getLanguages();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getLanguages: $e\n');
}

import org.openapitools.client.api.SystemValueRESTServiceApi;

public class SystemValueRESTServiceApiExample {
    public static void main(String[] args) {
        SystemValueRESTServiceApi apiInstance = new SystemValueRESTServiceApi();

        try {
            ItemsWrapperForString result = apiInstance.getLanguages();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemValueRESTServiceApi#getLanguages");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SystemValueRESTServiceApi *apiInstance = [[SystemValueRESTServiceApi alloc] init];

// Get languages
[apiInstance getLanguagesWithCompletionHandler: 
              ^(ItemsWrapperForString output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SystemValueRESTServiceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLanguages(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getLanguagesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SystemValueRESTServiceApi();

            try {
                // Get languages
                ItemsWrapperForString result = apiInstance.getLanguages();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemValueRESTServiceApi.getLanguages: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemValueRESTServiceApi();

try {
    $result = $api_instance->getLanguages();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemValueRESTServiceApi->getLanguages: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemValueRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemValueRESTServiceApi->new();

eval {
    my $result = $api_instance->getLanguages();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemValueRESTServiceApi->getLanguages: $@\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.SystemValueRESTServiceApi()

try:
    # Get languages
    api_response = api_instance.get_languages()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemValueRESTServiceApi->getLanguages: %s\n" % e)
extern crate SystemValueRESTServiceApi;

pub fn main() {

    let mut context = SystemValueRESTServiceApi::Context::default();
    let result = client.getLanguages(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getPolicyTypes

getPolicyTypes
get/core/v1/system/policy-types

**Since:** 2.79.0 Returns the available policy types. (LoginPolicy type is deprecated since 2.75.12. Instead, set this parameter in the Client policy.)

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/system/policy-types"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemValueRESTServiceApi;

import java.io.File;
import java.util.*;

public class SystemValueRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SystemValueRESTServiceApi apiInstance = new SystemValueRESTServiceApi();

        try {
            ItemsWrapperForString result = apiInstance.getPolicyTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemValueRESTServiceApi#getPolicyTypes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getPolicyTypes();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPolicyTypes: $e\n');
}

import org.openapitools.client.api.SystemValueRESTServiceApi;

public class SystemValueRESTServiceApiExample {
    public static void main(String[] args) {
        SystemValueRESTServiceApi apiInstance = new SystemValueRESTServiceApi();

        try {
            ItemsWrapperForString result = apiInstance.getPolicyTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemValueRESTServiceApi#getPolicyTypes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SystemValueRESTServiceApi *apiInstance = [[SystemValueRESTServiceApi alloc] init];

// Get policy types
[apiInstance getPolicyTypesWithCompletionHandler: 
              ^(ItemsWrapperForString output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SystemValueRESTServiceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPolicyTypes(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getPolicyTypesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SystemValueRESTServiceApi();

            try {
                // Get policy types
                ItemsWrapperForString result = apiInstance.getPolicyTypes();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemValueRESTServiceApi.getPolicyTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemValueRESTServiceApi();

try {
    $result = $api_instance->getPolicyTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemValueRESTServiceApi->getPolicyTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemValueRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemValueRESTServiceApi->new();

eval {
    my $result = $api_instance->getPolicyTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemValueRESTServiceApi->getPolicyTypes: $@\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.SystemValueRESTServiceApi()

try:
    # Get policy types
    api_response = api_instance.get_policy_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemValueRESTServiceApi->getPolicyTypes: %s\n" % e)
extern crate SystemValueRESTServiceApi;

pub fn main() {

    let mut context = SystemValueRESTServiceApi::Context::default();
    let result = client.getPolicyTypes(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getProfileStates

getProfileStates
get/core/v1/system/profile-states

**Since:** 2.79.0 Returns the available profile states.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/system/profile-states"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemValueRESTServiceApi;

import java.io.File;
import java.util.*;

public class SystemValueRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SystemValueRESTServiceApi apiInstance = new SystemValueRESTServiceApi();

        try {
            ItemsWrapperForString result = apiInstance.getProfileStates();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemValueRESTServiceApi#getProfileStates");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getProfileStates();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getProfileStates: $e\n');
}

import org.openapitools.client.api.SystemValueRESTServiceApi;

public class SystemValueRESTServiceApiExample {
    public static void main(String[] args) {
        SystemValueRESTServiceApi apiInstance = new SystemValueRESTServiceApi();

        try {
            ItemsWrapperForString result = apiInstance.getProfileStates();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemValueRESTServiceApi#getProfileStates");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SystemValueRESTServiceApi *apiInstance = [[SystemValueRESTServiceApi alloc] init];

// Get profile states
[apiInstance getProfileStatesWithCompletionHandler: 
              ^(ItemsWrapperForString output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SystemValueRESTServiceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProfileStates(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getProfileStatesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SystemValueRESTServiceApi();

            try {
                // Get profile states
                ItemsWrapperForString result = apiInstance.getProfileStates();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemValueRESTServiceApi.getProfileStates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemValueRESTServiceApi();

try {
    $result = $api_instance->getProfileStates();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemValueRESTServiceApi->getProfileStates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemValueRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemValueRESTServiceApi->new();

eval {
    my $result = $api_instance->getProfileStates();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemValueRESTServiceApi->getProfileStates: $@\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.SystemValueRESTServiceApi()

try:
    # Get profile states
    api_response = api_instance.get_profile_states()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemValueRESTServiceApi->getProfileStates: %s\n" % e)
extern crate SystemValueRESTServiceApi;

pub fn main() {

    let mut context = SystemValueRESTServiceApi::Context::default();
    let result = client.getProfileStates(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getUserStates

getUserStates
get/core/v1/system/user-states

**Since:** 2.79.0 Returns the available user states.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/system/user-states"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemValueRESTServiceApi;

import java.io.File;
import java.util.*;

public class SystemValueRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SystemValueRESTServiceApi apiInstance = new SystemValueRESTServiceApi();

        try {
            ItemsWrapperForString result = apiInstance.getUserStates();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemValueRESTServiceApi#getUserStates");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getUserStates();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUserStates: $e\n');
}

import org.openapitools.client.api.SystemValueRESTServiceApi;

public class SystemValueRESTServiceApiExample {
    public static void main(String[] args) {
        SystemValueRESTServiceApi apiInstance = new SystemValueRESTServiceApi();

        try {
            ItemsWrapperForString result = apiInstance.getUserStates();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemValueRESTServiceApi#getUserStates");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SystemValueRESTServiceApi *apiInstance = [[SystemValueRESTServiceApi alloc] init];

// Get user states
[apiInstance getUserStatesWithCompletionHandler: 
              ^(ItemsWrapperForString output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.SystemValueRESTServiceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserStates(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserStatesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new SystemValueRESTServiceApi();

            try {
                // Get user states
                ItemsWrapperForString result = apiInstance.getUserStates();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemValueRESTServiceApi.getUserStates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemValueRESTServiceApi();

try {
    $result = $api_instance->getUserStates();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemValueRESTServiceApi->getUserStates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemValueRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemValueRESTServiceApi->new();

eval {
    my $result = $api_instance->getUserStates();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemValueRESTServiceApi->getUserStates: $@\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.SystemValueRESTServiceApi()

try:
    # Get user states
    api_response = api_instance.get_user_states()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemValueRESTServiceApi->getUserStates: %s\n" % e)
extern crate SystemValueRESTServiceApi;

pub fn main() {

    let mut context = SystemValueRESTServiceApi::Context::default();
    let result = client.getUserStates(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


TermsRESTService

assignTerms

assignTerms
put/core/v1/terms/{termsExtId}/applications/{applicationExtId}

**Since:** 2.75.1 **Required permission(s):** `AccessControl.TermsModify` Assigns an application to the terms object.

Usage and SDK Samples

curl -X PUT \
 "http://localhost:8080/nevisidm/api/core/v1/terms/{termsExtId}/applications/{applicationExtId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TermsRESTServiceApi;

import java.io.File;
import java.util.*;

public class TermsRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TermsRESTServiceApi apiInstance = new TermsRESTServiceApi();
        String termsExtId = terms-001; // String | ExtID of the terms object
        String applicationExtId = app-001; // String | ExtID of the application

        try {
            apiInstance.assignTerms(termsExtId, applicationExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TermsRESTServiceApi#assignTerms");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String termsExtId = new String(); // String | ExtID of the terms object
final String applicationExtId = new String(); // String | ExtID of the application

try {
    final result = await api_instance.assignTerms(termsExtId, applicationExtId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->assignTerms: $e\n');
}

import org.openapitools.client.api.TermsRESTServiceApi;

public class TermsRESTServiceApiExample {
    public static void main(String[] args) {
        TermsRESTServiceApi apiInstance = new TermsRESTServiceApi();
        String termsExtId = terms-001; // String | ExtID of the terms object
        String applicationExtId = app-001; // String | ExtID of the application

        try {
            apiInstance.assignTerms(termsExtId, applicationExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TermsRESTServiceApi#assignTerms");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TermsRESTServiceApi *apiInstance = [[TermsRESTServiceApi alloc] init];
String *termsExtId = terms-001; // ExtID of the terms object (default to null)
String *applicationExtId = app-001; // ExtID of the application (default to null)

// Assign application to terms
[apiInstance assignTermsWith:termsExtId
    applicationExtId:applicationExtId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.TermsRESTServiceApi()
var termsExtId = terms-001; // {String} ExtID of the terms object
var applicationExtId = app-001; // {String} ExtID of the application

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.assignTerms(termsExtId, applicationExtId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class assignTermsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TermsRESTServiceApi();
            var termsExtId = terms-001;  // String | ExtID of the terms object (default to null)
            var applicationExtId = app-001;  // String | ExtID of the application (default to null)

            try {
                // Assign application to terms
                apiInstance.assignTerms(termsExtId, applicationExtId);
            } catch (Exception e) {
                Debug.Print("Exception when calling TermsRESTServiceApi.assignTerms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TermsRESTServiceApi();
$termsExtId = terms-001; // String | ExtID of the terms object
$applicationExtId = app-001; // String | ExtID of the application

try {
    $api_instance->assignTerms($termsExtId, $applicationExtId);
} catch (Exception $e) {
    echo 'Exception when calling TermsRESTServiceApi->assignTerms: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TermsRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TermsRESTServiceApi->new();
my $termsExtId = terms-001; # String | ExtID of the terms object
my $applicationExtId = app-001; # String | ExtID of the application

eval {
    $api_instance->assignTerms(termsExtId => $termsExtId, applicationExtId => $applicationExtId);
};
if ($@) {
    warn "Exception when calling TermsRESTServiceApi->assignTerms: $@\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.TermsRESTServiceApi()
termsExtId = terms-001 # String | ExtID of the terms object (default to null)
applicationExtId = app-001 # String | ExtID of the application (default to null)

try:
    # Assign application to terms
    api_instance.assign_terms(termsExtId, applicationExtId)
except ApiException as e:
    print("Exception when calling TermsRESTServiceApi->assignTerms: %s\n" % e)
extern crate TermsRESTServiceApi;

pub fn main() {
    let termsExtId = terms-001; // String
    let applicationExtId = app-001; // String

    let mut context = TermsRESTServiceApi::Context::default();
    let result = client.assignTerms(termsExtId, applicationExtId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
termsExtId*
String
ExtID of the terms object
Required
applicationExtId*
String
ExtID of the application
Required

Responses


createTerms

createTerms
post/core/v1/terms

**Since:** 2.75.1 **Required permission(s):** `AccessControl.TermsCreate` Creates a new terms object with the given external ID and name.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/terms" \
 -d '{
  "urls" : {
    "key" : "urls"
  },
  "termsVersion" : "termsVersion",
  "name" : "name",
  "active" : true,
  "extId" : "extId",
  "silentAcceptance" : true
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TermsRESTServiceApi;

import java.io.File;
import java.util.*;

public class TermsRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TermsRESTServiceApi apiInstance = new TermsRESTServiceApi();
        TermsCreateDTO termsCreateDTO = {"extId":"1001","name":"termsName","silentAcceptance":true,"active":true,"termsVersion":"termsVersion","urls":{"de":"https://www.sampleUrl.terms","fr":"https://www.sampleUrl2.terms"}}; // TermsCreateDTO | 

        try {
            apiInstance.createTerms(termsCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling TermsRESTServiceApi#createTerms");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final TermsCreateDTO termsCreateDTO = new TermsCreateDTO(); // TermsCreateDTO | 

try {
    final result = await api_instance.createTerms(termsCreateDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createTerms: $e\n');
}

import org.openapitools.client.api.TermsRESTServiceApi;

public class TermsRESTServiceApiExample {
    public static void main(String[] args) {
        TermsRESTServiceApi apiInstance = new TermsRESTServiceApi();
        TermsCreateDTO termsCreateDTO = {"extId":"1001","name":"termsName","silentAcceptance":true,"active":true,"termsVersion":"termsVersion","urls":{"de":"https://www.sampleUrl.terms","fr":"https://www.sampleUrl2.terms"}}; // TermsCreateDTO | 

        try {
            apiInstance.createTerms(termsCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling TermsRESTServiceApi#createTerms");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TermsRESTServiceApi *apiInstance = [[TermsRESTServiceApi alloc] init];
TermsCreateDTO *termsCreateDTO = {"extId":"1001","name":"termsName","silentAcceptance":true,"active":true,"termsVersion":"termsVersion","urls":{"de":"https://www.sampleUrl.terms","fr":"https://www.sampleUrl2.terms"}}; // 

// Create terms
[apiInstance createTermsWith:termsCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.TermsRESTServiceApi()
var termsCreateDTO = {"extId":"1001","name":"termsName","silentAcceptance":true,"active":true,"termsVersion":"termsVersion","urls":{"de":"https://www.sampleUrl.terms","fr":"https://www.sampleUrl2.terms"}}; // {TermsCreateDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createTerms(termsCreateDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createTermsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TermsRESTServiceApi();
            var termsCreateDTO = new TermsCreateDTO(); // TermsCreateDTO | 

            try {
                // Create terms
                apiInstance.createTerms(termsCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling TermsRESTServiceApi.createTerms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TermsRESTServiceApi();
$termsCreateDTO = {"extId":"1001","name":"termsName","silentAcceptance":true,"active":true,"termsVersion":"termsVersion","urls":{"de":"https://www.sampleUrl.terms","fr":"https://www.sampleUrl2.terms"}}; // TermsCreateDTO | 

try {
    $api_instance->createTerms($termsCreateDTO);
} catch (Exception $e) {
    echo 'Exception when calling TermsRESTServiceApi->createTerms: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TermsRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TermsRESTServiceApi->new();
my $termsCreateDTO = WWW::OPenAPIClient::Object::TermsCreateDTO->new(); # TermsCreateDTO | 

eval {
    $api_instance->createTerms(termsCreateDTO => $termsCreateDTO);
};
if ($@) {
    warn "Exception when calling TermsRESTServiceApi->createTerms: $@\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.TermsRESTServiceApi()
termsCreateDTO = {"extId":"1001","name":"termsName","silentAcceptance":true,"active":true,"termsVersion":"termsVersion","urls":{"de":"https://www.sampleUrl.terms","fr":"https://www.sampleUrl2.terms"}} # TermsCreateDTO | 

try:
    # Create terms
    api_instance.create_terms(termsCreateDTO)
except ApiException as e:
    print("Exception when calling TermsRESTServiceApi->createTerms: %s\n" % e)
extern crate TermsRESTServiceApi;

pub fn main() {
    let termsCreateDTO = {"extId":"1001","name":"termsName","silentAcceptance":true,"active":true,"termsVersion":"termsVersion","urls":{"de":"https://www.sampleUrl.terms","fr":"https://www.sampleUrl2.terms"}}; // TermsCreateDTO

    let mut context = TermsRESTServiceApi::Context::default();
    let result = client.createTerms(termsCreateDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
termsCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

deleteTerms

deleteTerms
delete/core/v1/terms/{extId}

**Since:** 2.75.1 **Required permission(s):** `AccessControl.TermsDelete` Deletes the terms object with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/terms/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TermsRESTServiceApi;

import java.io.File;
import java.util.*;

public class TermsRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TermsRESTServiceApi apiInstance = new TermsRESTServiceApi();
        String extId = terms-001; // String | ExtID of the terms object

        try {
            apiInstance.deleteTerms(extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TermsRESTServiceApi#deleteTerms");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the terms object

try {
    final result = await api_instance.deleteTerms(extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteTerms: $e\n');
}

import org.openapitools.client.api.TermsRESTServiceApi;

public class TermsRESTServiceApiExample {
    public static void main(String[] args) {
        TermsRESTServiceApi apiInstance = new TermsRESTServiceApi();
        String extId = terms-001; // String | ExtID of the terms object

        try {
            apiInstance.deleteTerms(extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TermsRESTServiceApi#deleteTerms");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TermsRESTServiceApi *apiInstance = [[TermsRESTServiceApi alloc] init];
String *extId = terms-001; // ExtID of the terms object (default to null)

// Delete terms
[apiInstance deleteTermsWith:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.TermsRESTServiceApi()
var extId = terms-001; // {String} ExtID of the terms object

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTerms(extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteTermsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TermsRESTServiceApi();
            var extId = terms-001;  // String | ExtID of the terms object (default to null)

            try {
                // Delete terms
                apiInstance.deleteTerms(extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling TermsRESTServiceApi.deleteTerms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TermsRESTServiceApi();
$extId = terms-001; // String | ExtID of the terms object

try {
    $api_instance->deleteTerms($extId);
} catch (Exception $e) {
    echo 'Exception when calling TermsRESTServiceApi->deleteTerms: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TermsRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TermsRESTServiceApi->new();
my $extId = terms-001; # String | ExtID of the terms object

eval {
    $api_instance->deleteTerms(extId => $extId);
};
if ($@) {
    warn "Exception when calling TermsRESTServiceApi->deleteTerms: $@\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.TermsRESTServiceApi()
extId = terms-001 # String | ExtID of the terms object (default to null)

try:
    # Delete terms
    api_instance.delete_terms(extId)
except ApiException as e:
    print("Exception when calling TermsRESTServiceApi->deleteTerms: %s\n" % e)
extern crate TermsRESTServiceApi;

pub fn main() {
    let extId = terms-001; // String

    let mut context = TermsRESTServiceApi::Context::default();
    let result = client.deleteTerms(extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the terms object
Required

Responses


getTerms

getTerms
get/core/v1/terms/{extId}

**Since:** 2.75.1 **Required permission(s):** `AccessControl.TermsView` Returns the terms object with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/terms/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TermsRESTServiceApi;

import java.io.File;
import java.util.*;

public class TermsRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TermsRESTServiceApi apiInstance = new TermsRESTServiceApi();
        String extId = terms-001; // String | ExtID of the terms object

        try {
            TermsGetDTO result = apiInstance.getTerms(extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TermsRESTServiceApi#getTerms");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the terms object

try {
    final result = await api_instance.getTerms(extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTerms: $e\n');
}

import org.openapitools.client.api.TermsRESTServiceApi;

public class TermsRESTServiceApiExample {
    public static void main(String[] args) {
        TermsRESTServiceApi apiInstance = new TermsRESTServiceApi();
        String extId = terms-001; // String | ExtID of the terms object

        try {
            TermsGetDTO result = apiInstance.getTerms(extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TermsRESTServiceApi#getTerms");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TermsRESTServiceApi *apiInstance = [[TermsRESTServiceApi alloc] init];
String *extId = terms-001; // ExtID of the terms object (default to null)

// Get terms
[apiInstance getTermsWith:extId
              completionHandler: ^(TermsGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.TermsRESTServiceApi()
var extId = terms-001; // {String} ExtID of the terms object

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTerms(extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getTermsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TermsRESTServiceApi();
            var extId = terms-001;  // String | ExtID of the terms object (default to null)

            try {
                // Get terms
                TermsGetDTO result = apiInstance.getTerms(extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TermsRESTServiceApi.getTerms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TermsRESTServiceApi();
$extId = terms-001; // String | ExtID of the terms object

try {
    $result = $api_instance->getTerms($extId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TermsRESTServiceApi->getTerms: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TermsRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TermsRESTServiceApi->new();
my $extId = terms-001; # String | ExtID of the terms object

eval {
    my $result = $api_instance->getTerms(extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TermsRESTServiceApi->getTerms: $@\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.TermsRESTServiceApi()
extId = terms-001 # String | ExtID of the terms object (default to null)

try:
    # Get terms
    api_response = api_instance.get_terms(extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TermsRESTServiceApi->getTerms: %s\n" % e)
extern crate TermsRESTServiceApi;

pub fn main() {
    let extId = terms-001; // String

    let mut context = TermsRESTServiceApi::Context::default();
    let result = client.getTerms(extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the terms object
Required

Responses


getTermsList

getTermsList
get/core/v1/terms

**Since:** 2.75.1 **Required permission(s):** `AccessControl.TermsView` Returns all terms objects.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/terms?continuationToken=continuationToken_example&limit=100"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TermsRESTServiceApi;

import java.io.File;
import java.util.*;

public class TermsRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TermsRESTServiceApi apiInstance = new TermsRESTServiceApi();
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperForTermGetDTO result = apiInstance.getTermsList(continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TermsRESTServiceApi#getTermsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

try {
    final result = await api_instance.getTermsList(continuationToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTermsList: $e\n');
}

import org.openapitools.client.api.TermsRESTServiceApi;

public class TermsRESTServiceApiExample {
    public static void main(String[] args) {
        TermsRESTServiceApi apiInstance = new TermsRESTServiceApi();
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperForTermGetDTO result = apiInstance.getTermsList(continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TermsRESTServiceApi#getTermsList");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TermsRESTServiceApi *apiInstance = [[TermsRESTServiceApi alloc] init];
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 100; // Pagination limit (optional) (default to 0)

// List all terms
[apiInstance getTermsListWith:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForTermGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.TermsRESTServiceApi()
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 100 // {Integer} Pagination limit
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTermsList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getTermsListExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TermsRESTServiceApi();
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 100;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // List all terms
                ItemsWrapperForTermGetDTO result = apiInstance.getTermsList(continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TermsRESTServiceApi.getTermsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TermsRESTServiceApi();
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 100; // Integer | Pagination limit

try {
    $result = $api_instance->getTermsList($continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TermsRESTServiceApi->getTermsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TermsRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TermsRESTServiceApi->new();
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 100; # Integer | Pagination limit

eval {
    my $result = $api_instance->getTermsList(continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TermsRESTServiceApi->getTermsList: $@\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.TermsRESTServiceApi()
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 100 # Integer | Pagination limit (optional) (default to 0)

try:
    # List all terms
    api_response = api_instance.get_terms_list(continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TermsRESTServiceApi->getTermsList: %s\n" % e)
extern crate TermsRESTServiceApi;

pub fn main() {
    let continuationToken = continuationToken_example; // String
    let limit = 100; // Integer

    let mut context = TermsRESTServiceApi::Context::default();
    let result = client.getTermsList(continuationToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


patchTerms

patchTerms
patch/core/v1/terms/{extId}

**Since:** 2.75.1 **Required permission(s):** `AccessControl.TermsView,AccessControl.TermsModify` Updates the terms object with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/terms/{extId}" \
 -d '{
  "urls" : {
    "key" : "urls"
  },
  "termsVersion" : "termsVersion",
  "name" : "name",
  "active" : true,
  "version" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TermsRESTServiceApi;

import java.io.File;
import java.util.*;

public class TermsRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TermsRESTServiceApi apiInstance = new TermsRESTServiceApi();
        String extId = terms-001; // String | ExtID of the terms object
        TermsPatchDTO termsPatchDTO = {"name":"termsName","active":true,"termsVersion":"termsVersion","version":1,"urls":{"de":"https://www.sampleUrl.terms","fr":"https://www.sampleUrl2.terms"}}; // TermsPatchDTO | 

        try {
            TermsGetDTO result = apiInstance.patchTerms(extId, termsPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TermsRESTServiceApi#patchTerms");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String extId = new String(); // String | ExtID of the terms object
final TermsPatchDTO termsPatchDTO = new TermsPatchDTO(); // TermsPatchDTO | 

try {
    final result = await api_instance.patchTerms(extId, termsPatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchTerms: $e\n');
}

import org.openapitools.client.api.TermsRESTServiceApi;

public class TermsRESTServiceApiExample {
    public static void main(String[] args) {
        TermsRESTServiceApi apiInstance = new TermsRESTServiceApi();
        String extId = terms-001; // String | ExtID of the terms object
        TermsPatchDTO termsPatchDTO = {"name":"termsName","active":true,"termsVersion":"termsVersion","version":1,"urls":{"de":"https://www.sampleUrl.terms","fr":"https://www.sampleUrl2.terms"}}; // TermsPatchDTO | 

        try {
            TermsGetDTO result = apiInstance.patchTerms(extId, termsPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TermsRESTServiceApi#patchTerms");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TermsRESTServiceApi *apiInstance = [[TermsRESTServiceApi alloc] init];
String *extId = terms-001; // ExtID of the terms object (default to null)
TermsPatchDTO *termsPatchDTO = {"name":"termsName","active":true,"termsVersion":"termsVersion","version":1,"urls":{"de":"https://www.sampleUrl.terms","fr":"https://www.sampleUrl2.terms"}}; // 

// Patch terms
[apiInstance patchTermsWith:extId
    termsPatchDTO:termsPatchDTO
              completionHandler: ^(TermsGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.TermsRESTServiceApi()
var extId = terms-001; // {String} ExtID of the terms object
var termsPatchDTO = {"name":"termsName","active":true,"termsVersion":"termsVersion","version":1,"urls":{"de":"https://www.sampleUrl.terms","fr":"https://www.sampleUrl2.terms"}}; // {TermsPatchDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchTerms(extId, termsPatchDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class patchTermsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TermsRESTServiceApi();
            var extId = terms-001;  // String | ExtID of the terms object (default to null)
            var termsPatchDTO = new TermsPatchDTO(); // TermsPatchDTO | 

            try {
                // Patch terms
                TermsGetDTO result = apiInstance.patchTerms(extId, termsPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TermsRESTServiceApi.patchTerms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TermsRESTServiceApi();
$extId = terms-001; // String | ExtID of the terms object
$termsPatchDTO = {"name":"termsName","active":true,"termsVersion":"termsVersion","version":1,"urls":{"de":"https://www.sampleUrl.terms","fr":"https://www.sampleUrl2.terms"}}; // TermsPatchDTO | 

try {
    $result = $api_instance->patchTerms($extId, $termsPatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TermsRESTServiceApi->patchTerms: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TermsRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TermsRESTServiceApi->new();
my $extId = terms-001; # String | ExtID of the terms object
my $termsPatchDTO = WWW::OPenAPIClient::Object::TermsPatchDTO->new(); # TermsPatchDTO | 

eval {
    my $result = $api_instance->patchTerms(extId => $extId, termsPatchDTO => $termsPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TermsRESTServiceApi->patchTerms: $@\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.TermsRESTServiceApi()
extId = terms-001 # String | ExtID of the terms object (default to null)
termsPatchDTO = {"name":"termsName","active":true,"termsVersion":"termsVersion","version":1,"urls":{"de":"https://www.sampleUrl.terms","fr":"https://www.sampleUrl2.terms"}} # TermsPatchDTO | 

try:
    # Patch terms
    api_response = api_instance.patch_terms(extId, termsPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TermsRESTServiceApi->patchTerms: %s\n" % e)
extern crate TermsRESTServiceApi;

pub fn main() {
    let extId = terms-001; // String
    let termsPatchDTO = {"name":"termsName","active":true,"termsVersion":"termsVersion","version":1,"urls":{"de":"https://www.sampleUrl.terms","fr":"https://www.sampleUrl2.terms"}}; // TermsPatchDTO

    let mut context = TermsRESTServiceApi::Context::default();
    let result = client.patchTerms(extId, termsPatchDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
extId*
String
ExtID of the terms object
Required
Body parameters
Name Description
termsPatchDTO *

Responses


unassignTerms

unassignTerms
delete/core/v1/terms/{termsExtId}/applications/{applicationExtId}

**Since:** 2.75.1 **Required permission(s):** `AccessControl.TermsModify` Unassigns an application from the terms object.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/terms/{termsExtId}/applications/{applicationExtId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TermsRESTServiceApi;

import java.io.File;
import java.util.*;

public class TermsRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TermsRESTServiceApi apiInstance = new TermsRESTServiceApi();
        String termsExtId = terms-001; // String | ExtID of the terms object
        String applicationExtId = app-001; // String | ExtID of the application

        try {
            apiInstance.unassignTerms(termsExtId, applicationExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TermsRESTServiceApi#unassignTerms");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String termsExtId = new String(); // String | ExtID of the terms object
final String applicationExtId = new String(); // String | ExtID of the application

try {
    final result = await api_instance.unassignTerms(termsExtId, applicationExtId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->unassignTerms: $e\n');
}

import org.openapitools.client.api.TermsRESTServiceApi;

public class TermsRESTServiceApiExample {
    public static void main(String[] args) {
        TermsRESTServiceApi apiInstance = new TermsRESTServiceApi();
        String termsExtId = terms-001; // String | ExtID of the terms object
        String applicationExtId = app-001; // String | ExtID of the application

        try {
            apiInstance.unassignTerms(termsExtId, applicationExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TermsRESTServiceApi#unassignTerms");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TermsRESTServiceApi *apiInstance = [[TermsRESTServiceApi alloc] init];
String *termsExtId = terms-001; // ExtID of the terms object (default to null)
String *applicationExtId = app-001; // ExtID of the application (default to null)

// Unassign application from terms
[apiInstance unassignTermsWith:termsExtId
    applicationExtId:applicationExtId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.TermsRESTServiceApi()
var termsExtId = terms-001; // {String} ExtID of the terms object
var applicationExtId = app-001; // {String} ExtID of the application

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.unassignTerms(termsExtId, applicationExtId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class unassignTermsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TermsRESTServiceApi();
            var termsExtId = terms-001;  // String | ExtID of the terms object (default to null)
            var applicationExtId = app-001;  // String | ExtID of the application (default to null)

            try {
                // Unassign application from terms
                apiInstance.unassignTerms(termsExtId, applicationExtId);
            } catch (Exception e) {
                Debug.Print("Exception when calling TermsRESTServiceApi.unassignTerms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TermsRESTServiceApi();
$termsExtId = terms-001; // String | ExtID of the terms object
$applicationExtId = app-001; // String | ExtID of the application

try {
    $api_instance->unassignTerms($termsExtId, $applicationExtId);
} catch (Exception $e) {
    echo 'Exception when calling TermsRESTServiceApi->unassignTerms: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TermsRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TermsRESTServiceApi->new();
my $termsExtId = terms-001; # String | ExtID of the terms object
my $applicationExtId = app-001; # String | ExtID of the application

eval {
    $api_instance->unassignTerms(termsExtId => $termsExtId, applicationExtId => $applicationExtId);
};
if ($@) {
    warn "Exception when calling TermsRESTServiceApi->unassignTerms: $@\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.TermsRESTServiceApi()
termsExtId = terms-001 # String | ExtID of the terms object (default to null)
applicationExtId = app-001 # String | ExtID of the application (default to null)

try:
    # Unassign application from terms
    api_instance.unassign_terms(termsExtId, applicationExtId)
except ApiException as e:
    print("Exception when calling TermsRESTServiceApi->unassignTerms: %s\n" % e)
extern crate TermsRESTServiceApi;

pub fn main() {
    let termsExtId = terms-001; // String
    let applicationExtId = app-001; // String

    let mut context = TermsRESTServiceApi::Context::default();
    let result = client.unassignTerms(termsExtId, applicationExtId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
termsExtId*
String
ExtID of the terms object
Required
applicationExtId*
String
ExtID of the application
Required

Responses


TicketRESTService

createTicket

createTicket
post/core/v1/{clientExtId}/users/{userExtId}/ticket

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialCreate` Creates a new Ticket for the user with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/ticket" \
 -d '{
  "policyExtId" : "policyExtId",
  "identification" : "identification",
  "stateName" : "active",
  "context" : "context",
  "extId" : "extId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TicketRESTServiceApi;

import java.io.File;
import java.util.*;

public class TicketRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TicketRESTServiceApi apiInstance = new TicketRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        TicketCreateDTO ticketCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active"}; // TicketCreateDTO | 

        try {
            TicketGetDTO result = apiInstance.createTicket(clientExtId, userExtId, ticketCreateDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketRESTServiceApi#createTicket");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final TicketCreateDTO ticketCreateDTO = new TicketCreateDTO(); // TicketCreateDTO | 

try {
    final result = await api_instance.createTicket(clientExtId, userExtId, ticketCreateDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createTicket: $e\n');
}

import org.openapitools.client.api.TicketRESTServiceApi;

public class TicketRESTServiceApiExample {
    public static void main(String[] args) {
        TicketRESTServiceApi apiInstance = new TicketRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        TicketCreateDTO ticketCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active"}; // TicketCreateDTO | 

        try {
            TicketGetDTO result = apiInstance.createTicket(clientExtId, userExtId, ticketCreateDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketRESTServiceApi#createTicket");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TicketRESTServiceApi *apiInstance = [[TicketRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
TicketCreateDTO *ticketCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active"}; // 

// Create a Ticket
[apiInstance createTicketWith:clientExtId
    userExtId:userExtId
    ticketCreateDTO:ticketCreateDTO
              completionHandler: ^(TicketGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.TicketRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var ticketCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active"}; // {TicketCreateDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTicket(clientExtId, userExtId, ticketCreateDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createTicketExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TicketRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var ticketCreateDTO = new TicketCreateDTO(); // TicketCreateDTO | 

            try {
                // Create a Ticket
                TicketGetDTO result = apiInstance.createTicket(clientExtId, userExtId, ticketCreateDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TicketRESTServiceApi.createTicket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TicketRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$ticketCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active"}; // TicketCreateDTO | 

try {
    $result = $api_instance->createTicket($clientExtId, $userExtId, $ticketCreateDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketRESTServiceApi->createTicket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TicketRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TicketRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $ticketCreateDTO = WWW::OPenAPIClient::Object::TicketCreateDTO->new(); # TicketCreateDTO | 

eval {
    my $result = $api_instance->createTicket(clientExtId => $clientExtId, userExtId => $userExtId, ticketCreateDTO => $ticketCreateDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TicketRESTServiceApi->createTicket: $@\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.TicketRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
ticketCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active"} # TicketCreateDTO | 

try:
    # Create a Ticket
    api_response = api_instance.create_ticket(clientExtId, userExtId, ticketCreateDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TicketRESTServiceApi->createTicket: %s\n" % e)
extern crate TicketRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let ticketCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active"}; // TicketCreateDTO

    let mut context = TicketRESTServiceApi::Context::default();
    let result = client.createTicket(clientExtId, userExtId, ticketCreateDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
ticketCreateDTO *

Responses


deleteTicket

deleteTicket
delete/core/v1/{clientExtId}/users/{userExtId}/ticket

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialDelete,AccessControl.CredentialView` Deletes the ticket of the user with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/ticket"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TicketRESTServiceApi;

import java.io.File;
import java.util.*;

public class TicketRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TicketRESTServiceApi apiInstance = new TicketRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            apiInstance.deleteTicket(clientExtId, userExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketRESTServiceApi#deleteTicket");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user

try {
    final result = await api_instance.deleteTicket(clientExtId, userExtId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteTicket: $e\n');
}

import org.openapitools.client.api.TicketRESTServiceApi;

public class TicketRESTServiceApiExample {
    public static void main(String[] args) {
        TicketRESTServiceApi apiInstance = new TicketRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            apiInstance.deleteTicket(clientExtId, userExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketRESTServiceApi#deleteTicket");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TicketRESTServiceApi *apiInstance = [[TicketRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)

// Delete Ticket
[apiInstance deleteTicketWith:clientExtId
    userExtId:userExtId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.TicketRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTicket(clientExtId, userExtId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteTicketExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TicketRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)

            try {
                // Delete Ticket
                apiInstance.deleteTicket(clientExtId, userExtId);
            } catch (Exception e) {
                Debug.Print("Exception when calling TicketRESTServiceApi.deleteTicket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TicketRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user

try {
    $api_instance->deleteTicket($clientExtId, $userExtId);
} catch (Exception $e) {
    echo 'Exception when calling TicketRESTServiceApi->deleteTicket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TicketRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TicketRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user

eval {
    $api_instance->deleteTicket(clientExtId => $clientExtId, userExtId => $userExtId);
};
if ($@) {
    warn "Exception when calling TicketRESTServiceApi->deleteTicket: $@\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.TicketRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)

try:
    # Delete Ticket
    api_instance.delete_ticket(clientExtId, userExtId)
except ApiException as e:
    print("Exception when calling TicketRESTServiceApi->deleteTicket: %s\n" % e)
extern crate TicketRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String

    let mut context = TicketRESTServiceApi::Context::default();
    let result = client.deleteTicket(clientExtId, userExtId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required

Responses


getTicket

getTicket
get/core/v1/{clientExtId}/users/{userExtId}/ticket

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns the Ticket credential of the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/ticket"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TicketRESTServiceApi;

import java.io.File;
import java.util.*;

public class TicketRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TicketRESTServiceApi apiInstance = new TicketRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            TicketGetDTO result = apiInstance.getTicket(clientExtId, userExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketRESTServiceApi#getTicket");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user

try {
    final result = await api_instance.getTicket(clientExtId, userExtId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTicket: $e\n');
}

import org.openapitools.client.api.TicketRESTServiceApi;

public class TicketRESTServiceApiExample {
    public static void main(String[] args) {
        TicketRESTServiceApi apiInstance = new TicketRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            TicketGetDTO result = apiInstance.getTicket(clientExtId, userExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketRESTServiceApi#getTicket");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TicketRESTServiceApi *apiInstance = [[TicketRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)

// Get user Ticket credential
[apiInstance getTicketWith:clientExtId
    userExtId:userExtId
              completionHandler: ^(TicketGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.TicketRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTicket(clientExtId, userExtId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getTicketExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TicketRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)

            try {
                // Get user Ticket credential
                TicketGetDTO result = apiInstance.getTicket(clientExtId, userExtId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TicketRESTServiceApi.getTicket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TicketRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user

try {
    $result = $api_instance->getTicket($clientExtId, $userExtId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketRESTServiceApi->getTicket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TicketRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TicketRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user

eval {
    my $result = $api_instance->getTicket(clientExtId => $clientExtId, userExtId => $userExtId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TicketRESTServiceApi->getTicket: $@\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.TicketRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)

try:
    # Get user Ticket credential
    api_response = api_instance.get_ticket(clientExtId, userExtId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TicketRESTServiceApi->getTicket: %s\n" % e)
extern crate TicketRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String

    let mut context = TicketRESTServiceApi::Context::default();
    let result = client.getTicket(clientExtId, userExtId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required

Responses


regenerateTicket

regenerateTicket
post/core/v1/{clientExtId}/users/{userExtId}/ticket/reset

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialModify,AccessControl.CredentialView` Regenerates and returns the ticket with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/ticket/reset"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TicketRESTServiceApi;

import java.io.File;
import java.util.*;

public class TicketRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TicketRESTServiceApi apiInstance = new TicketRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            TicketGetDTO result = apiInstance.regenerateTicket(clientExtId, userExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketRESTServiceApi#regenerateTicket");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user

try {
    final result = await api_instance.regenerateTicket(clientExtId, userExtId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->regenerateTicket: $e\n');
}

import org.openapitools.client.api.TicketRESTServiceApi;

public class TicketRESTServiceApiExample {
    public static void main(String[] args) {
        TicketRESTServiceApi apiInstance = new TicketRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            TicketGetDTO result = apiInstance.regenerateTicket(clientExtId, userExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketRESTServiceApi#regenerateTicket");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TicketRESTServiceApi *apiInstance = [[TicketRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)

// Regenerate Ticket
[apiInstance regenerateTicketWith:clientExtId
    userExtId:userExtId
              completionHandler: ^(TicketGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.TicketRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.regenerateTicket(clientExtId, userExtId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class regenerateTicketExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TicketRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)

            try {
                // Regenerate Ticket
                TicketGetDTO result = apiInstance.regenerateTicket(clientExtId, userExtId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TicketRESTServiceApi.regenerateTicket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TicketRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user

try {
    $result = $api_instance->regenerateTicket($clientExtId, $userExtId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketRESTServiceApi->regenerateTicket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TicketRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TicketRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user

eval {
    my $result = $api_instance->regenerateTicket(clientExtId => $clientExtId, userExtId => $userExtId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TicketRESTServiceApi->regenerateTicket: $@\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.TicketRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)

try:
    # Regenerate Ticket
    api_response = api_instance.regenerate_ticket(clientExtId, userExtId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TicketRESTServiceApi->regenerateTicket: %s\n" % e)
extern crate TicketRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String

    let mut context = TicketRESTServiceApi::Context::default();
    let result = client.regenerateTicket(clientExtId, userExtId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required

Responses


updateTicket

updateTicket
patch/core/v1/{clientExtId}/users/{userExtId}/ticket

**Since:** 8.2511.0 **Required permission(s):** `AccessControl.CredentialModify,AccessControl.CredentialView` Updates and returns the ticket with the given external ID, belonging to the user with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/ticket" \
 -d '{
  "policyExtId" : "policyExtId",
  "identification" : "identification",
  "stateName" : "initial",
  "modificationComment" : "modificationComment",
  "validity" : {
    "from" : "2023-01-01T00:00:00Z",
    "to" : "2033-12-31T23:59:59Z"
  },
  "version" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TicketRESTServiceApi;

import java.io.File;
import java.util.*;

public class TicketRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TicketRESTServiceApi apiInstance = new TicketRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        TicketPatchDTO ticketPatchDTO = {"stateName":"active","modificationComment":"changed-by-admin","policyExtId":"102","version":2}; // TicketPatchDTO | 

        try {
            TicketGetDTO result = apiInstance.updateTicket(clientExtId, userExtId, ticketPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketRESTServiceApi#updateTicket");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final TicketPatchDTO ticketPatchDTO = new TicketPatchDTO(); // TicketPatchDTO | 

try {
    final result = await api_instance.updateTicket(clientExtId, userExtId, ticketPatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateTicket: $e\n');
}

import org.openapitools.client.api.TicketRESTServiceApi;

public class TicketRESTServiceApiExample {
    public static void main(String[] args) {
        TicketRESTServiceApi apiInstance = new TicketRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        TicketPatchDTO ticketPatchDTO = {"stateName":"active","modificationComment":"changed-by-admin","policyExtId":"102","version":2}; // TicketPatchDTO | 

        try {
            TicketGetDTO result = apiInstance.updateTicket(clientExtId, userExtId, ticketPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketRESTServiceApi#updateTicket");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TicketRESTServiceApi *apiInstance = [[TicketRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
TicketPatchDTO *ticketPatchDTO = {"stateName":"active","modificationComment":"changed-by-admin","policyExtId":"102","version":2}; // 

// Update Ticket
[apiInstance updateTicketWith:clientExtId
    userExtId:userExtId
    ticketPatchDTO:ticketPatchDTO
              completionHandler: ^(TicketGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.TicketRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var ticketPatchDTO = {"stateName":"active","modificationComment":"changed-by-admin","policyExtId":"102","version":2}; // {TicketPatchDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateTicket(clientExtId, userExtId, ticketPatchDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateTicketExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TicketRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var ticketPatchDTO = new TicketPatchDTO(); // TicketPatchDTO | 

            try {
                // Update Ticket
                TicketGetDTO result = apiInstance.updateTicket(clientExtId, userExtId, ticketPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TicketRESTServiceApi.updateTicket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TicketRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$ticketPatchDTO = {"stateName":"active","modificationComment":"changed-by-admin","policyExtId":"102","version":2}; // TicketPatchDTO | 

try {
    $result = $api_instance->updateTicket($clientExtId, $userExtId, $ticketPatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketRESTServiceApi->updateTicket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TicketRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TicketRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $ticketPatchDTO = WWW::OPenAPIClient::Object::TicketPatchDTO->new(); # TicketPatchDTO | 

eval {
    my $result = $api_instance->updateTicket(clientExtId => $clientExtId, userExtId => $userExtId, ticketPatchDTO => $ticketPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TicketRESTServiceApi->updateTicket: $@\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.TicketRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
ticketPatchDTO = {"stateName":"active","modificationComment":"changed-by-admin","policyExtId":"102","version":2} # TicketPatchDTO | 

try:
    # Update Ticket
    api_response = api_instance.update_ticket(clientExtId, userExtId, ticketPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TicketRESTServiceApi->updateTicket: %s\n" % e)
extern crate TicketRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let ticketPatchDTO = {"stateName":"active","modificationComment":"changed-by-admin","policyExtId":"102","version":2}; // TicketPatchDTO

    let mut context = TicketRESTServiceApi::Context::default();
    let result = client.updateTicket(clientExtId, userExtId, ticketPatchDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
ticketPatchDTO *

Responses


URLTicketRESTService

createUrlTicket

createUrlTicket
post/core/v1/{clientExtId}/users/{userExtId}/url-ticket

**Since:** 2.80.0 **Required permission(s):** `AccessControl.CredentialCreate` Creates a new URL ticket for the user with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/url-ticket" \
 -d '{
  "policyExtId" : "policyExtId",
  "identification" : "identification",
  "stateName" : "INITIAL",
  "urlPrefix" : "urlPrefix",
  "extId" : "extId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.URLTicketRESTServiceApi;

import java.io.File;
import java.util.*;

public class URLTicketRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        URLTicketRESTServiceApi apiInstance = new URLTicketRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        UrlTicketCreateDTO urlTicketCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active","url-prefix":"http://test.test.test/?q="}; // UrlTicketCreateDTO | 

        try {
            UrlTicketGetDTO result = apiInstance.createUrlTicket(clientExtId, userExtId, urlTicketCreateDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling URLTicketRESTServiceApi#createUrlTicket");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final UrlTicketCreateDTO urlTicketCreateDTO = new UrlTicketCreateDTO(); // UrlTicketCreateDTO | 

try {
    final result = await api_instance.createUrlTicket(clientExtId, userExtId, urlTicketCreateDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createUrlTicket: $e\n');
}

import org.openapitools.client.api.URLTicketRESTServiceApi;

public class URLTicketRESTServiceApiExample {
    public static void main(String[] args) {
        URLTicketRESTServiceApi apiInstance = new URLTicketRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        UrlTicketCreateDTO urlTicketCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active","url-prefix":"http://test.test.test/?q="}; // UrlTicketCreateDTO | 

        try {
            UrlTicketGetDTO result = apiInstance.createUrlTicket(clientExtId, userExtId, urlTicketCreateDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling URLTicketRESTServiceApi#createUrlTicket");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
URLTicketRESTServiceApi *apiInstance = [[URLTicketRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
UrlTicketCreateDTO *urlTicketCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active","url-prefix":"http://test.test.test/?q="}; // 

// Create a URL ticket
[apiInstance createUrlTicketWith:clientExtId
    userExtId:userExtId
    urlTicketCreateDTO:urlTicketCreateDTO
              completionHandler: ^(UrlTicketGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.URLTicketRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var urlTicketCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active","url-prefix":"http://test.test.test/?q="}; // {UrlTicketCreateDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createUrlTicket(clientExtId, userExtId, urlTicketCreateDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createUrlTicketExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new URLTicketRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var urlTicketCreateDTO = new UrlTicketCreateDTO(); // UrlTicketCreateDTO | 

            try {
                // Create a URL ticket
                UrlTicketGetDTO result = apiInstance.createUrlTicket(clientExtId, userExtId, urlTicketCreateDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling URLTicketRESTServiceApi.createUrlTicket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\URLTicketRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$urlTicketCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active","url-prefix":"http://test.test.test/?q="}; // UrlTicketCreateDTO | 

try {
    $result = $api_instance->createUrlTicket($clientExtId, $userExtId, $urlTicketCreateDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling URLTicketRESTServiceApi->createUrlTicket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::URLTicketRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::URLTicketRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $urlTicketCreateDTO = WWW::OPenAPIClient::Object::UrlTicketCreateDTO->new(); # UrlTicketCreateDTO | 

eval {
    my $result = $api_instance->createUrlTicket(clientExtId => $clientExtId, userExtId => $userExtId, urlTicketCreateDTO => $urlTicketCreateDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling URLTicketRESTServiceApi->createUrlTicket: $@\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.URLTicketRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
urlTicketCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active","url-prefix":"http://test.test.test/?q="} # UrlTicketCreateDTO | 

try:
    # Create a URL ticket
    api_response = api_instance.create_url_ticket(clientExtId, userExtId, urlTicketCreateDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling URLTicketRESTServiceApi->createUrlTicket: %s\n" % e)
extern crate URLTicketRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let urlTicketCreateDTO = {"extId":"4500","policyExtId":"6789","identification":"someIdentification","stateName":"active","url-prefix":"http://test.test.test/?q="}; // UrlTicketCreateDTO

    let mut context = URLTicketRESTServiceApi::Context::default();
    let result = client.createUrlTicket(clientExtId, userExtId, urlTicketCreateDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
urlTicketCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

deleteUrlTicket

deleteUrlTicket
delete/core/v1/{clientExtId}/users/{userExtId}/url-ticket

**Since:** 2.85.0 **Required permission(s):** `AccessControl.CredentialDelete` Deletes the URL ticket of the user with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/url-ticket"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.URLTicketRESTServiceApi;

import java.io.File;
import java.util.*;

public class URLTicketRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        URLTicketRESTServiceApi apiInstance = new URLTicketRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            apiInstance.deleteUrlTicket(clientExtId, userExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling URLTicketRESTServiceApi#deleteUrlTicket");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user

try {
    final result = await api_instance.deleteUrlTicket(clientExtId, userExtId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteUrlTicket: $e\n');
}

import org.openapitools.client.api.URLTicketRESTServiceApi;

public class URLTicketRESTServiceApiExample {
    public static void main(String[] args) {
        URLTicketRESTServiceApi apiInstance = new URLTicketRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user

        try {
            apiInstance.deleteUrlTicket(clientExtId, userExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling URLTicketRESTServiceApi#deleteUrlTicket");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
URLTicketRESTServiceApi *apiInstance = [[URLTicketRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)

// Delete URL Ticket
[apiInstance deleteUrlTicketWith:clientExtId
    userExtId:userExtId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.URLTicketRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUrlTicket(clientExtId, userExtId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteUrlTicketExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new URLTicketRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)

            try {
                // Delete URL Ticket
                apiInstance.deleteUrlTicket(clientExtId, userExtId);
            } catch (Exception e) {
                Debug.Print("Exception when calling URLTicketRESTServiceApi.deleteUrlTicket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\URLTicketRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user

try {
    $api_instance->deleteUrlTicket($clientExtId, $userExtId);
} catch (Exception $e) {
    echo 'Exception when calling URLTicketRESTServiceApi->deleteUrlTicket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::URLTicketRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::URLTicketRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user

eval {
    $api_instance->deleteUrlTicket(clientExtId => $clientExtId, userExtId => $userExtId);
};
if ($@) {
    warn "Exception when calling URLTicketRESTServiceApi->deleteUrlTicket: $@\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.URLTicketRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)

try:
    # Delete URL Ticket
    api_instance.delete_url_ticket(clientExtId, userExtId)
except ApiException as e:
    print("Exception when calling URLTicketRESTServiceApi->deleteUrlTicket: %s\n" % e)
extern crate URLTicketRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String

    let mut context = URLTicketRESTServiceApi::Context::default();
    let result = client.deleteUrlTicket(clientExtId, userExtId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required

Responses


regenerateUrlTicket

regenerateUrlTicket
get/core/v1/{clientExtId}/users/{userExtId}/url-ticket

**Since:** 2.80.0 **Required permission(s):** `AccessControl.CredentialView,AccessControl.CredentialViewPlainValue` Regenerates and returns the URL ticket with the given external ID, belonging to the user with the given external ID. (URL Tickets stored hashed so we have to generate new value to return)

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/url-ticket?url-prefix=urlPrefix_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.URLTicketRESTServiceApi;

import java.io.File;
import java.util.*;

public class URLTicketRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        URLTicketRESTServiceApi apiInstance = new URLTicketRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String urlPrefix = urlPrefix_example; // String | URL prefix to overwrite the ticket's prefix

        try {
            UrlTicketGetDTO result = apiInstance.regenerateUrlTicket(clientExtId, userExtId, urlPrefix);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling URLTicketRESTServiceApi#regenerateUrlTicket");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String urlPrefix = new String(); // String | URL prefix to overwrite the ticket's prefix

try {
    final result = await api_instance.regenerateUrlTicket(clientExtId, userExtId, urlPrefix);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->regenerateUrlTicket: $e\n');
}

import org.openapitools.client.api.URLTicketRESTServiceApi;

public class URLTicketRESTServiceApiExample {
    public static void main(String[] args) {
        URLTicketRESTServiceApi apiInstance = new URLTicketRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1234; // String | ExtID of the user
        String urlPrefix = urlPrefix_example; // String | URL prefix to overwrite the ticket's prefix

        try {
            UrlTicketGetDTO result = apiInstance.regenerateUrlTicket(clientExtId, userExtId, urlPrefix);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling URLTicketRESTServiceApi#regenerateUrlTicket");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
URLTicketRESTServiceApi *apiInstance = [[URLTicketRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1234; // ExtID of the user (default to null)
String *urlPrefix = urlPrefix_example; // URL prefix to overwrite the ticket's prefix (optional) (default to null)

// Regenerate URL ticket
[apiInstance regenerateUrlTicketWith:clientExtId
    userExtId:userExtId
    urlPrefix:urlPrefix
              completionHandler: ^(UrlTicketGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.URLTicketRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1234; // {String} ExtID of the user
var opts = {
  'urlPrefix': urlPrefix_example // {String} URL prefix to overwrite the ticket's prefix
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.regenerateUrlTicket(clientExtId, userExtId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class regenerateUrlTicketExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new URLTicketRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1234;  // String | ExtID of the user (default to null)
            var urlPrefix = urlPrefix_example;  // String | URL prefix to overwrite the ticket's prefix (optional)  (default to null)

            try {
                // Regenerate URL ticket
                UrlTicketGetDTO result = apiInstance.regenerateUrlTicket(clientExtId, userExtId, urlPrefix);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling URLTicketRESTServiceApi.regenerateUrlTicket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\URLTicketRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1234; // String | ExtID of the user
$urlPrefix = urlPrefix_example; // String | URL prefix to overwrite the ticket's prefix

try {
    $result = $api_instance->regenerateUrlTicket($clientExtId, $userExtId, $urlPrefix);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling URLTicketRESTServiceApi->regenerateUrlTicket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::URLTicketRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::URLTicketRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1234; # String | ExtID of the user
my $urlPrefix = urlPrefix_example; # String | URL prefix to overwrite the ticket's prefix

eval {
    my $result = $api_instance->regenerateUrlTicket(clientExtId => $clientExtId, userExtId => $userExtId, urlPrefix => $urlPrefix);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling URLTicketRESTServiceApi->regenerateUrlTicket: $@\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.URLTicketRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1234 # String | ExtID of the user (default to null)
urlPrefix = urlPrefix_example # String | URL prefix to overwrite the ticket's prefix (optional) (default to null)

try:
    # Regenerate URL ticket
    api_response = api_instance.regenerate_url_ticket(clientExtId, userExtId, urlPrefix=urlPrefix)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling URLTicketRESTServiceApi->regenerateUrlTicket: %s\n" % e)
extern crate URLTicketRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1234; // String
    let urlPrefix = urlPrefix_example; // String

    let mut context = URLTicketRESTServiceApi::Context::default();
    let result = client.regenerateUrlTicket(clientExtId, userExtId, urlPrefix, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Query parameters
Name Description
url-prefix
String
URL prefix to overwrite the ticket's prefix

Responses


UnitRESTService

createUnit

createUnit
post/core/v1/{clientExtId}/units

**Since:** 2.73.0 **Required permission(s):** `AccessControl.UnitCreate,AccessControl.UnitCreateTopUnit` Creates a new unit for the client with the given external ID. @since:2.73 Required permissions: AccessControl.UnitCreate, AccessControl.UnitCreateTopUnit (if no parent unit parentUnitExtId is provided)

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/units" \
 -d '{
  "profileless" : true,
  "modificationComment" : "modificationComment",
  "displayName" : {
    "key" : "displayName"
  },
  "name" : "name",
  "description" : "description",
  "location" : "location",
  "extId" : "extId",
  "state" : "state",
  "validity" : {
    "from" : "2023-01-01T00:00:00Z",
    "to" : "2033-12-31T23:59:59Z"
  },
  "parentUnitExtId" : "parentUnitExtId",
  "abbreviation" : {
    "key" : "abbreviation"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnitRESTServiceApi;

import java.io.File;
import java.util.*;

public class UnitRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnitRESTServiceApi apiInstance = new UnitRESTServiceApi();
        String clientExtId = clientExtId_example; // String | 
        UnitCreateDTO unitCreateDTO = {"extId":"1000","parentUnitExtId":"100","name":"MyUnit1","location":"something","description":"something","displayName":{"EN":"MyUnit1_EN","DE":"MyUnit1_DE","FR":"MyUnit1_FR","IT":"MyUnit1_IT"},"abbreviation":{"EN":"MU1_EN","DE":"MU1_DE","FR":"MU1_FR","IT":"MU1_IT"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"profileless":false,"modificationComment":"blabla"}; // UnitCreateDTO | 

        try {
            apiInstance.createUnit(clientExtId, unitCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnitRESTServiceApi#createUnit");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | 
final UnitCreateDTO unitCreateDTO = new UnitCreateDTO(); // UnitCreateDTO | 

try {
    final result = await api_instance.createUnit(clientExtId, unitCreateDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createUnit: $e\n');
}

import org.openapitools.client.api.UnitRESTServiceApi;

public class UnitRESTServiceApiExample {
    public static void main(String[] args) {
        UnitRESTServiceApi apiInstance = new UnitRESTServiceApi();
        String clientExtId = clientExtId_example; // String | 
        UnitCreateDTO unitCreateDTO = {"extId":"1000","parentUnitExtId":"100","name":"MyUnit1","location":"something","description":"something","displayName":{"EN":"MyUnit1_EN","DE":"MyUnit1_DE","FR":"MyUnit1_FR","IT":"MyUnit1_IT"},"abbreviation":{"EN":"MU1_EN","DE":"MU1_DE","FR":"MU1_FR","IT":"MU1_IT"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"profileless":false,"modificationComment":"blabla"}; // UnitCreateDTO | 

        try {
            apiInstance.createUnit(clientExtId, unitCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnitRESTServiceApi#createUnit");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnitRESTServiceApi *apiInstance = [[UnitRESTServiceApi alloc] init];
String *clientExtId = clientExtId_example; //  (default to null)
UnitCreateDTO *unitCreateDTO = {"extId":"1000","parentUnitExtId":"100","name":"MyUnit1","location":"something","description":"something","displayName":{"EN":"MyUnit1_EN","DE":"MyUnit1_DE","FR":"MyUnit1_FR","IT":"MyUnit1_IT"},"abbreviation":{"EN":"MU1_EN","DE":"MU1_DE","FR":"MU1_FR","IT":"MU1_IT"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"profileless":false,"modificationComment":"blabla"}; // 

// Create unit
[apiInstance createUnitWith:clientExtId
    unitCreateDTO:unitCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UnitRESTServiceApi()
var clientExtId = clientExtId_example; // {String} 
var unitCreateDTO = {"extId":"1000","parentUnitExtId":"100","name":"MyUnit1","location":"something","description":"something","displayName":{"EN":"MyUnit1_EN","DE":"MyUnit1_DE","FR":"MyUnit1_FR","IT":"MyUnit1_IT"},"abbreviation":{"EN":"MU1_EN","DE":"MU1_DE","FR":"MU1_FR","IT":"MU1_IT"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"profileless":false,"modificationComment":"blabla"}; // {UnitCreateDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createUnit(clientExtId, unitCreateDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createUnitExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UnitRESTServiceApi();
            var clientExtId = clientExtId_example;  // String |  (default to null)
            var unitCreateDTO = new UnitCreateDTO(); // UnitCreateDTO | 

            try {
                // Create unit
                apiInstance.createUnit(clientExtId, unitCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnitRESTServiceApi.createUnit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnitRESTServiceApi();
$clientExtId = clientExtId_example; // String | 
$unitCreateDTO = {"extId":"1000","parentUnitExtId":"100","name":"MyUnit1","location":"something","description":"something","displayName":{"EN":"MyUnit1_EN","DE":"MyUnit1_DE","FR":"MyUnit1_FR","IT":"MyUnit1_IT"},"abbreviation":{"EN":"MU1_EN","DE":"MU1_DE","FR":"MU1_FR","IT":"MU1_IT"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"profileless":false,"modificationComment":"blabla"}; // UnitCreateDTO | 

try {
    $api_instance->createUnit($clientExtId, $unitCreateDTO);
} catch (Exception $e) {
    echo 'Exception when calling UnitRESTServiceApi->createUnit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnitRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnitRESTServiceApi->new();
my $clientExtId = clientExtId_example; # String | 
my $unitCreateDTO = WWW::OPenAPIClient::Object::UnitCreateDTO->new(); # UnitCreateDTO | 

eval {
    $api_instance->createUnit(clientExtId => $clientExtId, unitCreateDTO => $unitCreateDTO);
};
if ($@) {
    warn "Exception when calling UnitRESTServiceApi->createUnit: $@\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.UnitRESTServiceApi()
clientExtId = clientExtId_example # String |  (default to null)
unitCreateDTO = {"extId":"1000","parentUnitExtId":"100","name":"MyUnit1","location":"something","description":"something","displayName":{"EN":"MyUnit1_EN","DE":"MyUnit1_DE","FR":"MyUnit1_FR","IT":"MyUnit1_IT"},"abbreviation":{"EN":"MU1_EN","DE":"MU1_DE","FR":"MU1_FR","IT":"MU1_IT"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"profileless":false,"modificationComment":"blabla"} # UnitCreateDTO | 

try:
    # Create unit
    api_instance.create_unit(clientExtId, unitCreateDTO)
except ApiException as e:
    print("Exception when calling UnitRESTServiceApi->createUnit: %s\n" % e)
extern crate UnitRESTServiceApi;

pub fn main() {
    let clientExtId = clientExtId_example; // String
    let unitCreateDTO = {"extId":"1000","parentUnitExtId":"100","name":"MyUnit1","location":"something","description":"something","displayName":{"EN":"MyUnit1_EN","DE":"MyUnit1_DE","FR":"MyUnit1_FR","IT":"MyUnit1_IT"},"abbreviation":{"EN":"MU1_EN","DE":"MU1_DE","FR":"MU1_FR","IT":"MU1_IT"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"profileless":false,"modificationComment":"blabla"}; // UnitCreateDTO

    let mut context = UnitRESTServiceApi::Context::default();
    let result = client.createUnit(clientExtId, unitCreateDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
Required
Body parameters
Name Description
unitCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

deleteUnit

deleteUnit
delete/core/v1/{clientExtId}/units/{extId}

**Since:** 2.73.0 **Required permission(s):** `AccessControl.UnitDelete` Deletes the unit with the given external ID, which belongs to the client with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/units/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnitRESTServiceApi;

import java.io.File;
import java.util.*;

public class UnitRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnitRESTServiceApi apiInstance = new UnitRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the unit

        try {
            apiInstance.deleteUnit(clientExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnitRESTServiceApi#deleteUnit");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the unit

try {
    final result = await api_instance.deleteUnit(clientExtId, extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteUnit: $e\n');
}

import org.openapitools.client.api.UnitRESTServiceApi;

public class UnitRESTServiceApiExample {
    public static void main(String[] args) {
        UnitRESTServiceApi apiInstance = new UnitRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the unit

        try {
            apiInstance.deleteUnit(clientExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnitRESTServiceApi#deleteUnit");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnitRESTServiceApi *apiInstance = [[UnitRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1000; // ExtID of the unit (default to null)

// Delete unit
[apiInstance deleteUnitWith:clientExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UnitRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1000; // {String} ExtID of the unit

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUnit(clientExtId, extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteUnitExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UnitRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1000;  // String | ExtID of the unit (default to null)

            try {
                // Delete unit
                apiInstance.deleteUnit(clientExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnitRESTServiceApi.deleteUnit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnitRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1000; // String | ExtID of the unit

try {
    $api_instance->deleteUnit($clientExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling UnitRESTServiceApi->deleteUnit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnitRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnitRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1000; # String | ExtID of the unit

eval {
    $api_instance->deleteUnit(clientExtId => $clientExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling UnitRESTServiceApi->deleteUnit: $@\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.UnitRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1000 # String | ExtID of the unit (default to null)

try:
    # Delete unit
    api_instance.delete_unit(clientExtId, extId)
except ApiException as e:
    print("Exception when calling UnitRESTServiceApi->deleteUnit: %s\n" % e)
extern crate UnitRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1000; // String

    let mut context = UnitRESTServiceApi::Context::default();
    let result = client.deleteUnit(clientExtId, extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the unit
Required

Responses


getProperties1

getProperties1
get/core/v1/{clientExtId}/units/{extId}/properties

**Since:** 2.79.0 **Required permission(s):** `AccessControl.UnitView,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView` Returns all properties of the unit with the given external ID, as an object of key-value pairs.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/units/{extId}/properties"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnitRESTServiceApi;

import java.io.File;
import java.util.*;

public class UnitRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnitRESTServiceApi apiInstance = new UnitRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the unit

        try {
            map['String', 'String'] result = apiInstance.getProperties1(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnitRESTServiceApi#getProperties1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the unit

try {
    final result = await api_instance.getProperties1(clientExtId, extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getProperties1: $e\n');
}

import org.openapitools.client.api.UnitRESTServiceApi;

public class UnitRESTServiceApiExample {
    public static void main(String[] args) {
        UnitRESTServiceApi apiInstance = new UnitRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the unit

        try {
            map['String', 'String'] result = apiInstance.getProperties1(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnitRESTServiceApi#getProperties1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnitRESTServiceApi *apiInstance = [[UnitRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1000; // ExtID of the unit (default to null)

// Get unit properties
[apiInstance getProperties1With:clientExtId
    extId:extId
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UnitRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1000; // {String} ExtID of the unit

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProperties1(clientExtId, extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getProperties1Example
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UnitRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1000;  // String | ExtID of the unit (default to null)

            try {
                // Get unit properties
                map['String', 'String'] result = apiInstance.getProperties1(clientExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnitRESTServiceApi.getProperties1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnitRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1000; // String | ExtID of the unit

try {
    $result = $api_instance->getProperties1($clientExtId, $extId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UnitRESTServiceApi->getProperties1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnitRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnitRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1000; # String | ExtID of the unit

eval {
    my $result = $api_instance->getProperties1(clientExtId => $clientExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UnitRESTServiceApi->getProperties1: $@\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.UnitRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1000 # String | ExtID of the unit (default to null)

try:
    # Get unit properties
    api_response = api_instance.get_properties1(clientExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnitRESTServiceApi->getProperties1: %s\n" % e)
extern crate UnitRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1000; // String

    let mut context = UnitRESTServiceApi::Context::default();
    let result = client.getProperties1(clientExtId, extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the unit
Required

Responses


getUnit

getUnit
get/core/v1/{clientExtId}/units/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.UnitView` Returns the unit with the given external ID, which belongs to the client with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/units/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnitRESTServiceApi;

import java.io.File;
import java.util.*;

public class UnitRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnitRESTServiceApi apiInstance = new UnitRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the unit

        try {
            UnitGetDTO result = apiInstance.getUnit(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnitRESTServiceApi#getUnit");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the unit

try {
    final result = await api_instance.getUnit(clientExtId, extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUnit: $e\n');
}

import org.openapitools.client.api.UnitRESTServiceApi;

public class UnitRESTServiceApiExample {
    public static void main(String[] args) {
        UnitRESTServiceApi apiInstance = new UnitRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the unit

        try {
            UnitGetDTO result = apiInstance.getUnit(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnitRESTServiceApi#getUnit");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnitRESTServiceApi *apiInstance = [[UnitRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1000; // ExtID of the unit (default to null)

// Get unit
[apiInstance getUnitWith:clientExtId
    extId:extId
              completionHandler: ^(UnitGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UnitRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1000; // {String} ExtID of the unit

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUnit(clientExtId, extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUnitExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UnitRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1000;  // String | ExtID of the unit (default to null)

            try {
                // Get unit
                UnitGetDTO result = apiInstance.getUnit(clientExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnitRESTServiceApi.getUnit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnitRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1000; // String | ExtID of the unit

try {
    $result = $api_instance->getUnit($clientExtId, $extId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UnitRESTServiceApi->getUnit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnitRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnitRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1000; # String | ExtID of the unit

eval {
    my $result = $api_instance->getUnit(clientExtId => $clientExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UnitRESTServiceApi->getUnit: $@\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.UnitRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1000 # String | ExtID of the unit (default to null)

try:
    # Get unit
    api_response = api_instance.get_unit(clientExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnitRESTServiceApi->getUnit: %s\n" % e)
extern crate UnitRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1000; // String

    let mut context = UnitRESTServiceApi::Context::default();
    let result = client.getUnit(clientExtId, extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the unit
Required

Responses


getUnitSubUnits

getUnitSubUnits
get/core/v1/{clientExtId}/units/{extId}/children

**Since:** 2.79.0 **Required permission(s):** `AccessControl.UnitView` Returns all children of the unit with the given external ID. @since:2.79 Required permissions: AccessControl.UnitView

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/units/{extId}/children?continuationToken=1524579740000_1002&limit=100"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnitRESTServiceApi;

import java.io.File;
import java.util.*;

public class UnitRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnitRESTServiceApi apiInstance = new UnitRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the unit
        String continuationToken = 1524579740000_1002; // String | Pagination continuation token
        Integer limit = 100; // Integer | Maximum number of results

        try {
            ItemsWrapperForUnitGetDTO result = apiInstance.getUnitSubUnits(clientExtId, extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnitRESTServiceApi#getUnitSubUnits");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the unit
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Maximum number of results

try {
    final result = await api_instance.getUnitSubUnits(clientExtId, extId, continuationToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUnitSubUnits: $e\n');
}

import org.openapitools.client.api.UnitRESTServiceApi;

public class UnitRESTServiceApiExample {
    public static void main(String[] args) {
        UnitRESTServiceApi apiInstance = new UnitRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the unit
        String continuationToken = 1524579740000_1002; // String | Pagination continuation token
        Integer limit = 100; // Integer | Maximum number of results

        try {
            ItemsWrapperForUnitGetDTO result = apiInstance.getUnitSubUnits(clientExtId, extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnitRESTServiceApi#getUnitSubUnits");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnitRESTServiceApi *apiInstance = [[UnitRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1000; // ExtID of the unit (default to null)
String *continuationToken = 1524579740000_1002; // Pagination continuation token (optional) (default to )
Integer *limit = 100; // Maximum number of results (optional) (default to 0)

// Get children units
[apiInstance getUnitSubUnitsWith:clientExtId
    extId:extId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForUnitGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UnitRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1000; // {String} ExtID of the unit
var opts = {
  'continuationToken': 1524579740000_1002, // {String} Pagination continuation token
  'limit': 100 // {Integer} Maximum number of results
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUnitSubUnits(clientExtId, extId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUnitSubUnitsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UnitRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1000;  // String | ExtID of the unit (default to null)
            var continuationToken = 1524579740000_1002;  // String | Pagination continuation token (optional)  (default to )
            var limit = 100;  // Integer | Maximum number of results (optional)  (default to 0)

            try {
                // Get children units
                ItemsWrapperForUnitGetDTO result = apiInstance.getUnitSubUnits(clientExtId, extId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnitRESTServiceApi.getUnitSubUnits: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnitRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1000; // String | ExtID of the unit
$continuationToken = 1524579740000_1002; // String | Pagination continuation token
$limit = 100; // Integer | Maximum number of results

try {
    $result = $api_instance->getUnitSubUnits($clientExtId, $extId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UnitRESTServiceApi->getUnitSubUnits: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnitRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnitRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1000; # String | ExtID of the unit
my $continuationToken = 1524579740000_1002; # String | Pagination continuation token
my $limit = 100; # Integer | Maximum number of results

eval {
    my $result = $api_instance->getUnitSubUnits(clientExtId => $clientExtId, extId => $extId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UnitRESTServiceApi->getUnitSubUnits: $@\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.UnitRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1000 # String | ExtID of the unit (default to null)
continuationToken = 1524579740000_1002 # String | Pagination continuation token (optional) (default to )
limit = 100 # Integer | Maximum number of results (optional) (default to 0)

try:
    # Get children units
    api_response = api_instance.get_unit_sub_units(clientExtId, extId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnitRESTServiceApi->getUnitSubUnits: %s\n" % e)
extern crate UnitRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1000; // String
    let continuationToken = 1524579740000_1002; // String
    let limit = 100; // Integer

    let mut context = UnitRESTServiceApi::Context::default();
    let result = client.getUnitSubUnits(clientExtId, extId, continuationToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the unit
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Maximum number of results

Responses


moveUnit

moveUnit
put/core/v1/{clientExtId}/units/{extId}/children/{childExtId}

**Since:** 2.79.0 **Required permission(s):** `AccessControl.UnitModify` Moves the child unit with the given external ID under the parent unit with the given external ID.

Usage and SDK Samples

curl -X PUT \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/units/{extId}/children/{childExtId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnitRESTServiceApi;

import java.io.File;
import java.util.*;

public class UnitRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnitRESTServiceApi apiInstance = new UnitRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the parent unit
        String childExtId = 1003; // String | ExtID of the child unit

        try {
            apiInstance.moveUnit(clientExtId, extId, childExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnitRESTServiceApi#moveUnit");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the parent unit
final String childExtId = new String(); // String | ExtID of the child unit

try {
    final result = await api_instance.moveUnit(clientExtId, extId, childExtId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->moveUnit: $e\n');
}

import org.openapitools.client.api.UnitRESTServiceApi;

public class UnitRESTServiceApiExample {
    public static void main(String[] args) {
        UnitRESTServiceApi apiInstance = new UnitRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the parent unit
        String childExtId = 1003; // String | ExtID of the child unit

        try {
            apiInstance.moveUnit(clientExtId, extId, childExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnitRESTServiceApi#moveUnit");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnitRESTServiceApi *apiInstance = [[UnitRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1000; // ExtID of the parent unit (default to null)
String *childExtId = 1003; // ExtID of the child unit (default to null)

// Assign child unit
[apiInstance moveUnitWith:clientExtId
    extId:extId
    childExtId:childExtId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UnitRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1000; // {String} ExtID of the parent unit
var childExtId = 1003; // {String} ExtID of the child unit

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.moveUnit(clientExtId, extId, childExtId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class moveUnitExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UnitRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1000;  // String | ExtID of the parent unit (default to null)
            var childExtId = 1003;  // String | ExtID of the child unit (default to null)

            try {
                // Assign child unit
                apiInstance.moveUnit(clientExtId, extId, childExtId);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnitRESTServiceApi.moveUnit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnitRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1000; // String | ExtID of the parent unit
$childExtId = 1003; // String | ExtID of the child unit

try {
    $api_instance->moveUnit($clientExtId, $extId, $childExtId);
} catch (Exception $e) {
    echo 'Exception when calling UnitRESTServiceApi->moveUnit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnitRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnitRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1000; # String | ExtID of the parent unit
my $childExtId = 1003; # String | ExtID of the child unit

eval {
    $api_instance->moveUnit(clientExtId => $clientExtId, extId => $extId, childExtId => $childExtId);
};
if ($@) {
    warn "Exception when calling UnitRESTServiceApi->moveUnit: $@\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.UnitRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1000 # String | ExtID of the parent unit (default to null)
childExtId = 1003 # String | ExtID of the child unit (default to null)

try:
    # Assign child unit
    api_instance.move_unit(clientExtId, extId, childExtId)
except ApiException as e:
    print("Exception when calling UnitRESTServiceApi->moveUnit: %s\n" % e)
extern crate UnitRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1000; // String
    let childExtId = 1003; // String

    let mut context = UnitRESTServiceApi::Context::default();
    let result = client.moveUnit(clientExtId, extId, childExtId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the parent unit
Required
childExtId*
String
ExtID of the child unit
Required

Responses


patchUnit

patchUnit
patch/core/v1/{clientExtId}/units/{extId}

**Since:** 2.73.0 **Required permission(s):** `AccessControl.UnitView,AccessControl.UnitModify` Updates the unit with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/units/{extId}" \
 -d '{
  "modificationComment" : "modificationComment",
  "displayName" : {
    "key" : "displayName"
  },
  "name" : "name",
  "description" : "description",
  "location" : "location",
  "validity" : {
    "from" : "2023-01-01T00:00:00Z",
    "to" : "2033-12-31T23:59:59Z"
  },
  "state" : "state",
  "abbreviation" : {
    "key" : "abbreviation"
  },
  "version" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnitRESTServiceApi;

import java.io.File;
import java.util.*;

public class UnitRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnitRESTServiceApi apiInstance = new UnitRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the unit
        UnitPatchDTO unitPatchDTO = {"version":2,"name":"MyUnit1New","location":"somethingNew","description":"somethingNew","displayName":{"DE":"MyUnit1_DE_new","EN":"MyUnit1_EN_new","IT":"MyUnit1_IT_new","FR":"MyUnit1_FR_new"},"abbreviation":{"DE":"MU1_DE_new","EN":"MU1_EN_new","IT":"MU1_IT_new","FR":"MU1_FR_new"},"profileless":true,"modificationComment":"blablaNew","validity":{"from":"2100-01-01T00:00:00Z","to":"2200-01-01T00:00:00Z"}}; // UnitPatchDTO | 

        try {
            UnitGetDTO result = apiInstance.patchUnit(clientExtId, extId, unitPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnitRESTServiceApi#patchUnit");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the unit
final UnitPatchDTO unitPatchDTO = new UnitPatchDTO(); // UnitPatchDTO | 

try {
    final result = await api_instance.patchUnit(clientExtId, extId, unitPatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchUnit: $e\n');
}

import org.openapitools.client.api.UnitRESTServiceApi;

public class UnitRESTServiceApiExample {
    public static void main(String[] args) {
        UnitRESTServiceApi apiInstance = new UnitRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the unit
        UnitPatchDTO unitPatchDTO = {"version":2,"name":"MyUnit1New","location":"somethingNew","description":"somethingNew","displayName":{"DE":"MyUnit1_DE_new","EN":"MyUnit1_EN_new","IT":"MyUnit1_IT_new","FR":"MyUnit1_FR_new"},"abbreviation":{"DE":"MU1_DE_new","EN":"MU1_EN_new","IT":"MU1_IT_new","FR":"MU1_FR_new"},"profileless":true,"modificationComment":"blablaNew","validity":{"from":"2100-01-01T00:00:00Z","to":"2200-01-01T00:00:00Z"}}; // UnitPatchDTO | 

        try {
            UnitGetDTO result = apiInstance.patchUnit(clientExtId, extId, unitPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnitRESTServiceApi#patchUnit");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnitRESTServiceApi *apiInstance = [[UnitRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1000; // ExtID of the unit (default to null)
UnitPatchDTO *unitPatchDTO = {"version":2,"name":"MyUnit1New","location":"somethingNew","description":"somethingNew","displayName":{"DE":"MyUnit1_DE_new","EN":"MyUnit1_EN_new","IT":"MyUnit1_IT_new","FR":"MyUnit1_FR_new"},"abbreviation":{"DE":"MU1_DE_new","EN":"MU1_EN_new","IT":"MU1_IT_new","FR":"MU1_FR_new"},"profileless":true,"modificationComment":"blablaNew","validity":{"from":"2100-01-01T00:00:00Z","to":"2200-01-01T00:00:00Z"}}; // 

// Update unit
[apiInstance patchUnitWith:clientExtId
    extId:extId
    unitPatchDTO:unitPatchDTO
              completionHandler: ^(UnitGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UnitRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1000; // {String} ExtID of the unit
var unitPatchDTO = {"version":2,"name":"MyUnit1New","location":"somethingNew","description":"somethingNew","displayName":{"DE":"MyUnit1_DE_new","EN":"MyUnit1_EN_new","IT":"MyUnit1_IT_new","FR":"MyUnit1_FR_new"},"abbreviation":{"DE":"MU1_DE_new","EN":"MU1_EN_new","IT":"MU1_IT_new","FR":"MU1_FR_new"},"profileless":true,"modificationComment":"blablaNew","validity":{"from":"2100-01-01T00:00:00Z","to":"2200-01-01T00:00:00Z"}}; // {UnitPatchDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchUnit(clientExtId, extId, unitPatchDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class patchUnitExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UnitRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1000;  // String | ExtID of the unit (default to null)
            var unitPatchDTO = new UnitPatchDTO(); // UnitPatchDTO | 

            try {
                // Update unit
                UnitGetDTO result = apiInstance.patchUnit(clientExtId, extId, unitPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnitRESTServiceApi.patchUnit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnitRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1000; // String | ExtID of the unit
$unitPatchDTO = {"version":2,"name":"MyUnit1New","location":"somethingNew","description":"somethingNew","displayName":{"DE":"MyUnit1_DE_new","EN":"MyUnit1_EN_new","IT":"MyUnit1_IT_new","FR":"MyUnit1_FR_new"},"abbreviation":{"DE":"MU1_DE_new","EN":"MU1_EN_new","IT":"MU1_IT_new","FR":"MU1_FR_new"},"profileless":true,"modificationComment":"blablaNew","validity":{"from":"2100-01-01T00:00:00Z","to":"2200-01-01T00:00:00Z"}}; // UnitPatchDTO | 

try {
    $result = $api_instance->patchUnit($clientExtId, $extId, $unitPatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UnitRESTServiceApi->patchUnit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnitRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnitRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1000; # String | ExtID of the unit
my $unitPatchDTO = WWW::OPenAPIClient::Object::UnitPatchDTO->new(); # UnitPatchDTO | 

eval {
    my $result = $api_instance->patchUnit(clientExtId => $clientExtId, extId => $extId, unitPatchDTO => $unitPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UnitRESTServiceApi->patchUnit: $@\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.UnitRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1000 # String | ExtID of the unit (default to null)
unitPatchDTO = {"version":2,"name":"MyUnit1New","location":"somethingNew","description":"somethingNew","displayName":{"DE":"MyUnit1_DE_new","EN":"MyUnit1_EN_new","IT":"MyUnit1_IT_new","FR":"MyUnit1_FR_new"},"abbreviation":{"DE":"MU1_DE_new","EN":"MU1_EN_new","IT":"MU1_IT_new","FR":"MU1_FR_new"},"profileless":true,"modificationComment":"blablaNew","validity":{"from":"2100-01-01T00:00:00Z","to":"2200-01-01T00:00:00Z"}} # UnitPatchDTO | 

try:
    # Update unit
    api_response = api_instance.patch_unit(clientExtId, extId, unitPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnitRESTServiceApi->patchUnit: %s\n" % e)
extern crate UnitRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1000; // String
    let unitPatchDTO = {"version":2,"name":"MyUnit1New","location":"somethingNew","description":"somethingNew","displayName":{"DE":"MyUnit1_DE_new","EN":"MyUnit1_EN_new","IT":"MyUnit1_IT_new","FR":"MyUnit1_FR_new"},"abbreviation":{"DE":"MU1_DE_new","EN":"MU1_EN_new","IT":"MU1_IT_new","FR":"MU1_FR_new"},"profileless":true,"modificationComment":"blablaNew","validity":{"from":"2100-01-01T00:00:00Z","to":"2200-01-01T00:00:00Z"}}; // UnitPatchDTO

    let mut context = UnitRESTServiceApi::Context::default();
    let result = client.patchUnit(clientExtId, extId, unitPatchDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the unit
Required
Body parameters
Name Description
unitPatchDTO *

Responses


removeUnit

removeUnit
delete/core/v1/{clientExtId}/units/{extId}/children/{childExtId}

**Since:** 2.79.0 **Required permission(s):** `AccessControl.UnitModify,AccessControl.UnitCreateTopUnit` Removes the child unit with the given external ID from the parent unit with the given external ID. This action makes the child unit a root unit.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/units/{extId}/children/{childExtId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnitRESTServiceApi;

import java.io.File;
import java.util.*;

public class UnitRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnitRESTServiceApi apiInstance = new UnitRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the parent unit
        String childExtId = 1003; // String | ExtID of the child unit

        try {
            apiInstance.removeUnit(clientExtId, extId, childExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnitRESTServiceApi#removeUnit");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the parent unit
final String childExtId = new String(); // String | ExtID of the child unit

try {
    final result = await api_instance.removeUnit(clientExtId, extId, childExtId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->removeUnit: $e\n');
}

import org.openapitools.client.api.UnitRESTServiceApi;

public class UnitRESTServiceApiExample {
    public static void main(String[] args) {
        UnitRESTServiceApi apiInstance = new UnitRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the parent unit
        String childExtId = 1003; // String | ExtID of the child unit

        try {
            apiInstance.removeUnit(clientExtId, extId, childExtId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnitRESTServiceApi#removeUnit");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnitRESTServiceApi *apiInstance = [[UnitRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1000; // ExtID of the parent unit (default to null)
String *childExtId = 1003; // ExtID of the child unit (default to null)

// Unassign child unit
[apiInstance removeUnitWith:clientExtId
    extId:extId
    childExtId:childExtId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UnitRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1000; // {String} ExtID of the parent unit
var childExtId = 1003; // {String} ExtID of the child unit

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeUnit(clientExtId, extId, childExtId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class removeUnitExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UnitRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1000;  // String | ExtID of the parent unit (default to null)
            var childExtId = 1003;  // String | ExtID of the child unit (default to null)

            try {
                // Unassign child unit
                apiInstance.removeUnit(clientExtId, extId, childExtId);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnitRESTServiceApi.removeUnit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnitRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1000; // String | ExtID of the parent unit
$childExtId = 1003; // String | ExtID of the child unit

try {
    $api_instance->removeUnit($clientExtId, $extId, $childExtId);
} catch (Exception $e) {
    echo 'Exception when calling UnitRESTServiceApi->removeUnit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnitRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnitRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1000; # String | ExtID of the parent unit
my $childExtId = 1003; # String | ExtID of the child unit

eval {
    $api_instance->removeUnit(clientExtId => $clientExtId, extId => $extId, childExtId => $childExtId);
};
if ($@) {
    warn "Exception when calling UnitRESTServiceApi->removeUnit: $@\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.UnitRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1000 # String | ExtID of the parent unit (default to null)
childExtId = 1003 # String | ExtID of the child unit (default to null)

try:
    # Unassign child unit
    api_instance.remove_unit(clientExtId, extId, childExtId)
except ApiException as e:
    print("Exception when calling UnitRESTServiceApi->removeUnit: %s\n" % e)
extern crate UnitRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1000; // String
    let childExtId = 1003; // String

    let mut context = UnitRESTServiceApi::Context::default();
    let result = client.removeUnit(clientExtId, extId, childExtId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the parent unit
Required
childExtId*
String
ExtID of the child unit
Required

Responses


updateProperties1

updateProperties1
patch/core/v1/{clientExtId}/units/{extId}/properties

**Since:** 2.79.0 **Required permission(s):** `AccessControl.UnitView,AccessControl.UnitModify,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView,AccessControl.PropertyValueCreate,AccessControl.PropertyValueDelete,AccessControl.PropertyValueModify` Updates the properties of the unit with the given external ID, belonging to the client with the given external ID. The body has to contain an object of key-value property pairs.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/units/{extId}/properties" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnitRESTServiceApi;

import java.io.File;
import java.util.*;

public class UnitRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnitRESTServiceApi apiInstance = new UnitRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the unit
        map[String, String] requestBody = {"propertyName1":"","propertyName3":"propertyNewValue3"}; // map[String, String] | 

        try {
            map['String', 'String'] result = apiInstance.updateProperties1(clientExtId, extId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnitRESTServiceApi#updateProperties1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the unit
final map[String, String] requestBody = new map[String, String](); // map[String, String] | 

try {
    final result = await api_instance.updateProperties1(clientExtId, extId, requestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateProperties1: $e\n');
}

import org.openapitools.client.api.UnitRESTServiceApi;

public class UnitRESTServiceApiExample {
    public static void main(String[] args) {
        UnitRESTServiceApi apiInstance = new UnitRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the unit
        map[String, String] requestBody = {"propertyName1":"","propertyName3":"propertyNewValue3"}; // map[String, String] | 

        try {
            map['String', 'String'] result = apiInstance.updateProperties1(clientExtId, extId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnitRESTServiceApi#updateProperties1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnitRESTServiceApi *apiInstance = [[UnitRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1000; // ExtID of the unit (default to null)
map[String, String] *requestBody = {"propertyName1":"","propertyName3":"propertyNewValue3"}; // 

// Update unit properties
[apiInstance updateProperties1With:clientExtId
    extId:extId
    requestBody:requestBody
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UnitRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1000; // {String} ExtID of the unit
var requestBody = {"propertyName1":"","propertyName3":"propertyNewValue3"}; // {map[String, String]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateProperties1(clientExtId, extId, requestBody, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateProperties1Example
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UnitRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1000;  // String | ExtID of the unit (default to null)
            var requestBody = new map[String, String](); // map[String, String] | 

            try {
                // Update unit properties
                map['String', 'String'] result = apiInstance.updateProperties1(clientExtId, extId, requestBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnitRESTServiceApi.updateProperties1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnitRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1000; // String | ExtID of the unit
$requestBody = {"propertyName1":"","propertyName3":"propertyNewValue3"}; // map[String, String] | 

try {
    $result = $api_instance->updateProperties1($clientExtId, $extId, $requestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UnitRESTServiceApi->updateProperties1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnitRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnitRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1000; # String | ExtID of the unit
my $requestBody = WWW::OPenAPIClient::Object::map[String, String]->new(); # map[String, String] | 

eval {
    my $result = $api_instance->updateProperties1(clientExtId => $clientExtId, extId => $extId, requestBody => $requestBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UnitRESTServiceApi->updateProperties1: $@\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.UnitRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1000 # String | ExtID of the unit (default to null)
requestBody = {"propertyName1":"","propertyName3":"propertyNewValue3"} # map[String, String] | 

try:
    # Update unit properties
    api_response = api_instance.update_properties1(clientExtId, extId, requestBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnitRESTServiceApi->updateProperties1: %s\n" % e)
extern crate UnitRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1000; // String
    let requestBody = {"propertyName1":"","propertyName3":"propertyNewValue3"}; // map[String, String]

    let mut context = UnitRESTServiceApi::Context::default();
    let result = client.updateProperties1(clientExtId, extId, requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the unit
Required
Body parameters
Name Description
requestBody *

Responses


UserInfoRESTService

getUserInfo

getUserInfo
get/oic1.0/userinfo

Returns user information for the authenticated user according to requested claims. This is the GET variant.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/oic1.0/userinfo"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserInfoRESTServiceApi;

import java.io.File;
import java.util.*;

public class UserInfoRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserInfoRESTServiceApi apiInstance = new UserInfoRESTServiceApi();

        try {
            map['String', oas_any_type_not_mapped] result = apiInstance.getUserInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInfoRESTServiceApi#getUserInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getUserInfo();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUserInfo: $e\n');
}

import org.openapitools.client.api.UserInfoRESTServiceApi;

public class UserInfoRESTServiceApiExample {
    public static void main(String[] args) {
        UserInfoRESTServiceApi apiInstance = new UserInfoRESTServiceApi();

        try {
            map['String', oas_any_type_not_mapped] result = apiInstance.getUserInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInfoRESTServiceApi#getUserInfo");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserInfoRESTServiceApi *apiInstance = [[UserInfoRESTServiceApi alloc] init];

// OpenID Connect UserInfo endpoint
[apiInstance getUserInfoWithCompletionHandler: 
              ^(map['String', oas_any_type_not_mapped] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UserInfoRESTServiceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserInfoExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserInfoRESTServiceApi();

            try {
                // OpenID Connect UserInfo endpoint
                map['String', oas_any_type_not_mapped] result = apiInstance.getUserInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserInfoRESTServiceApi.getUserInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserInfoRESTServiceApi();

try {
    $result = $api_instance->getUserInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserInfoRESTServiceApi->getUserInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserInfoRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserInfoRESTServiceApi->new();

eval {
    my $result = $api_instance->getUserInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserInfoRESTServiceApi->getUserInfo: $@\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.UserInfoRESTServiceApi()

try:
    # OpenID Connect UserInfo endpoint
    api_response = api_instance.get_user_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserInfoRESTServiceApi->getUserInfo: %s\n" % e)
extern crate UserInfoRESTServiceApi;

pub fn main() {

    let mut context = UserInfoRESTServiceApi::Context::default();
    let result = client.getUserInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


postUserInfo

postUserInfo
post/oic1.0/userinfo

Returns user information for the authenticated user according to requested claims.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/oic1.0/userinfo"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserInfoRESTServiceApi;

import java.io.File;
import java.util.*;

public class UserInfoRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserInfoRESTServiceApi apiInstance = new UserInfoRESTServiceApi();

        try {
            map['String', oas_any_type_not_mapped] result = apiInstance.postUserInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInfoRESTServiceApi#postUserInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.postUserInfo();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->postUserInfo: $e\n');
}

import org.openapitools.client.api.UserInfoRESTServiceApi;

public class UserInfoRESTServiceApiExample {
    public static void main(String[] args) {
        UserInfoRESTServiceApi apiInstance = new UserInfoRESTServiceApi();

        try {
            map['String', oas_any_type_not_mapped] result = apiInstance.postUserInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInfoRESTServiceApi#postUserInfo");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserInfoRESTServiceApi *apiInstance = [[UserInfoRESTServiceApi alloc] init];

// OpenID Connect UserInfo endpoint
[apiInstance postUserInfoWithCompletionHandler: 
              ^(map['String', oas_any_type_not_mapped] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UserInfoRESTServiceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postUserInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postUserInfoExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserInfoRESTServiceApi();

            try {
                // OpenID Connect UserInfo endpoint
                map['String', oas_any_type_not_mapped] result = apiInstance.postUserInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserInfoRESTServiceApi.postUserInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserInfoRESTServiceApi();

try {
    $result = $api_instance->postUserInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserInfoRESTServiceApi->postUserInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserInfoRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserInfoRESTServiceApi->new();

eval {
    my $result = $api_instance->postUserInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserInfoRESTServiceApi->postUserInfo: $@\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.UserInfoRESTServiceApi()

try:
    # OpenID Connect UserInfo endpoint
    api_response = api_instance.post_user_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserInfoRESTServiceApi->postUserInfo: %s\n" % e)
extern crate UserInfoRESTServiceApi;

pub fn main() {

    let mut context = UserInfoRESTServiceApi::Context::default();
    let result = client.postUserInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


UserRESTService

archiveUser

archiveUser
post/core/v1/{clientExtId}/users/{extId}/archive

**Since:** 2.73.0 **Required permission(s):** `AccessControl.UserView,AccessControl.UserArchive,AccessControl.UserArchiveTechUser` Archives an existing user with the given external ID. All the profiles of the user are archived and the credentials are deleted.

Usage and SDK Samples

curl -X POST \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{extId}/archive"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserRESTServiceApi;

import java.io.File;
import java.util.*;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the user

        try {
            apiInstance.archiveUser(clientExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#archiveUser");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the user

try {
    final result = await api_instance.archiveUser(clientExtId, extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->archiveUser: $e\n');
}

import org.openapitools.client.api.UserRESTServiceApi;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the user

        try {
            apiInstance.archiveUser(clientExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#archiveUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserRESTServiceApi *apiInstance = [[UserRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1000; // ExtID of the user (default to null)

// Archive user
[apiInstance archiveUserWith:clientExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UserRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1000; // {String} ExtID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.archiveUser(clientExtId, extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class archiveUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1000;  // String | ExtID of the user (default to null)

            try {
                // Archive user
                apiInstance.archiveUser(clientExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserRESTServiceApi.archiveUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1000; // String | ExtID of the user

try {
    $api_instance->archiveUser($clientExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling UserRESTServiceApi->archiveUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1000; # String | ExtID of the user

eval {
    $api_instance->archiveUser(clientExtId => $clientExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling UserRESTServiceApi->archiveUser: $@\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.UserRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1000 # String | ExtID of the user (default to null)

try:
    # Archive user
    api_instance.archive_user(clientExtId, extId)
except ApiException as e:
    print("Exception when calling UserRESTServiceApi->archiveUser: %s\n" % e)
extern crate UserRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1000; // String

    let mut context = UserRESTServiceApi::Context::default();
    let result = client.archiveUser(clientExtId, extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the user
Required

Responses


createConsent

createConsent
post/core/v1/{clientExtId}/users/{userExtId}/consents

**Since:** 2.75.1 **Required permission(s):** `AccessControl.ConsentCreate` Creates a consent by accepting terms for a user determined by its client external ID and user external ID. The accepted terms are determined by the terms external ID provided in the request body.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/consents" \
 -d '{
  "termsExtId" : "termsExtId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserRESTServiceApi;

import java.io.File;
import java.util.*;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1000; // String | ExtID of the user
        ConsentCreateDTO consentCreateDTO = {"termsExtId":"1001"}; // ConsentCreateDTO | 

        try {
            apiInstance.createConsent(clientExtId, userExtId, consentCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#createConsent");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final ConsentCreateDTO consentCreateDTO = new ConsentCreateDTO(); // ConsentCreateDTO | 

try {
    final result = await api_instance.createConsent(clientExtId, userExtId, consentCreateDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createConsent: $e\n');
}

import org.openapitools.client.api.UserRESTServiceApi;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1000; // String | ExtID of the user
        ConsentCreateDTO consentCreateDTO = {"termsExtId":"1001"}; // ConsentCreateDTO | 

        try {
            apiInstance.createConsent(clientExtId, userExtId, consentCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#createConsent");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserRESTServiceApi *apiInstance = [[UserRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1000; // ExtID of the user (default to null)
ConsentCreateDTO *consentCreateDTO = {"termsExtId":"1001"}; // 

// Create consent
[apiInstance createConsentWith:clientExtId
    userExtId:userExtId
    consentCreateDTO:consentCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UserRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1000; // {String} ExtID of the user
var consentCreateDTO = {"termsExtId":"1001"}; // {ConsentCreateDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createConsent(clientExtId, userExtId, consentCreateDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createConsentExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1000;  // String | ExtID of the user (default to null)
            var consentCreateDTO = new ConsentCreateDTO(); // ConsentCreateDTO | 

            try {
                // Create consent
                apiInstance.createConsent(clientExtId, userExtId, consentCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserRESTServiceApi.createConsent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1000; // String | ExtID of the user
$consentCreateDTO = {"termsExtId":"1001"}; // ConsentCreateDTO | 

try {
    $api_instance->createConsent($clientExtId, $userExtId, $consentCreateDTO);
} catch (Exception $e) {
    echo 'Exception when calling UserRESTServiceApi->createConsent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1000; # String | ExtID of the user
my $consentCreateDTO = WWW::OPenAPIClient::Object::ConsentCreateDTO->new(); # ConsentCreateDTO | 

eval {
    $api_instance->createConsent(clientExtId => $clientExtId, userExtId => $userExtId, consentCreateDTO => $consentCreateDTO);
};
if ($@) {
    warn "Exception when calling UserRESTServiceApi->createConsent: $@\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.UserRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1000 # String | ExtID of the user (default to null)
consentCreateDTO = {"termsExtId":"1001"} # ConsentCreateDTO | 

try:
    # Create consent
    api_instance.create_consent(clientExtId, userExtId, consentCreateDTO)
except ApiException as e:
    print("Exception when calling UserRESTServiceApi->createConsent: %s\n" % e)
extern crate UserRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1000; // String
    let consentCreateDTO = {"termsExtId":"1001"}; // ConsentCreateDTO

    let mut context = UserRESTServiceApi::Context::default();
    let result = client.createConsent(clientExtId, userExtId, consentCreateDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
consentCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

createProfile

createProfile
post/core/v1/{clientExtId}/users/{extId}/profiles

**Since:** 2.71.0 **Required permission(s):** `AccessControl.ProfileCreate,AccessControl.AuthorizationCreate` Creates a new profile for the user with the given external ID.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{extId}/profiles" \
 -d '{
  "profileState" : "profileState",
  "unitExtId" : "unitExtId",
  "modificationComment" : "modificationComment",
  "name" : "name",
  "extId" : "extId",
  "validity" : {
    "from" : "2023-01-01T00:00:00Z",
    "to" : "2033-12-31T23:59:59Z"
  },
  "isDefaultProfile" : true,
  "remarks" : "remarks"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserRESTServiceApi;

import java.io.File;
import java.util.*;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the user
        ProfileCreateDTO profileCreateDTO = {"extId":"1003","unitExtId":"200","deputedProfileExtId":"8566","profileState":"active","name":"something3","isDefaultProfile":true,"remarks":"something3","modificationComment":"none"}; // ProfileCreateDTO | 

        try {
            apiInstance.createProfile(clientExtId, extId, profileCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#createProfile");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the user
final ProfileCreateDTO profileCreateDTO = new ProfileCreateDTO(); // ProfileCreateDTO | 

try {
    final result = await api_instance.createProfile(clientExtId, extId, profileCreateDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProfile: $e\n');
}

import org.openapitools.client.api.UserRESTServiceApi;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the user
        ProfileCreateDTO profileCreateDTO = {"extId":"1003","unitExtId":"200","deputedProfileExtId":"8566","profileState":"active","name":"something3","isDefaultProfile":true,"remarks":"something3","modificationComment":"none"}; // ProfileCreateDTO | 

        try {
            apiInstance.createProfile(clientExtId, extId, profileCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#createProfile");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserRESTServiceApi *apiInstance = [[UserRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1000; // ExtID of the user (default to null)
ProfileCreateDTO *profileCreateDTO = {"extId":"1003","unitExtId":"200","deputedProfileExtId":"8566","profileState":"active","name":"something3","isDefaultProfile":true,"remarks":"something3","modificationComment":"none"}; // 

// Create user profile
[apiInstance createProfileWith:clientExtId
    extId:extId
    profileCreateDTO:profileCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UserRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1000; // {String} ExtID of the user
var profileCreateDTO = {"extId":"1003","unitExtId":"200","deputedProfileExtId":"8566","profileState":"active","name":"something3","isDefaultProfile":true,"remarks":"something3","modificationComment":"none"}; // {ProfileCreateDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createProfile(clientExtId, extId, profileCreateDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createProfileExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1000;  // String | ExtID of the user (default to null)
            var profileCreateDTO = new ProfileCreateDTO(); // ProfileCreateDTO | 

            try {
                // Create user profile
                apiInstance.createProfile(clientExtId, extId, profileCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserRESTServiceApi.createProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1000; // String | ExtID of the user
$profileCreateDTO = {"extId":"1003","unitExtId":"200","deputedProfileExtId":"8566","profileState":"active","name":"something3","isDefaultProfile":true,"remarks":"something3","modificationComment":"none"}; // ProfileCreateDTO | 

try {
    $api_instance->createProfile($clientExtId, $extId, $profileCreateDTO);
} catch (Exception $e) {
    echo 'Exception when calling UserRESTServiceApi->createProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1000; # String | ExtID of the user
my $profileCreateDTO = WWW::OPenAPIClient::Object::ProfileCreateDTO->new(); # ProfileCreateDTO | 

eval {
    $api_instance->createProfile(clientExtId => $clientExtId, extId => $extId, profileCreateDTO => $profileCreateDTO);
};
if ($@) {
    warn "Exception when calling UserRESTServiceApi->createProfile: $@\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.UserRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1000 # String | ExtID of the user (default to null)
profileCreateDTO = {"extId":"1003","unitExtId":"200","deputedProfileExtId":"8566","profileState":"active","name":"something3","isDefaultProfile":true,"remarks":"something3","modificationComment":"none"} # ProfileCreateDTO | 

try:
    # Create user profile
    api_instance.create_profile(clientExtId, extId, profileCreateDTO)
except ApiException as e:
    print("Exception when calling UserRESTServiceApi->createProfile: %s\n" % e)
extern crate UserRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1000; // String
    let profileCreateDTO = {"extId":"1003","unitExtId":"200","deputedProfileExtId":"8566","profileState":"active","name":"something3","isDefaultProfile":true,"remarks":"something3","modificationComment":"none"}; // ProfileCreateDTO

    let mut context = UserRESTServiceApi::Context::default();
    let result = client.createProfile(clientExtId, extId, profileCreateDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the user
Required
Body parameters
Name Description
profileCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

createUser1

createUser1
post/core/v1/{clientExtId}/users

**Since:** 2.71.0 **Required permission(s):** `AccessControl.UserCreate,AccessControl.LoginIdOverride,AccessControl.UserCreateTechUser` Creates a new user for the client with the given external ID. From version 2.82, creating the custom properties of a user in the same call is also possible.

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users" \
 -d '{
  "loginId" : "loginId",
  "address" : {
    "dwellingNumber" : "A12",
    "city" : "Zürich",
    "street" : "Bahnhofstrasse",
    "countryCode" : "CH",
    "postalCode" : 8001,
    "postOfficeBoxText" : "Postfach",
    "houseNumber" : 1,
    "locality" : "Kreis 1",
    "addressline2" : "Wohnung 2",
    "addressline1" : "Bahnhofstrasse 1",
    "postOfficeBoxNumber" : 123
  },
  "gender" : "female",
  "modificationComment" : "modificationComment",
  "sex" : "sex",
  "languageCode" : "languageCode",
  "birthDate" : "birthDate",
  "userState" : "active",
  "name" : {
    "firstName" : "John",
    "familyName" : "Doe",
    "title" : "Mr."
  },
  "isTechnicalUser" : true,
  "extId" : "extId",
  "validity" : {
    "from" : "2023-01-01T00:00:00Z",
    "to" : "2033-12-31T23:59:59Z"
  },
  "properties" : {
    "key" : "properties"
  },
  "contacts" : {
    "mobile" : "+41781254156",
    "telephone" : "+41781254153",
    "telefax" : "+41781254154",
    "email" : "[email protected]"
  },
  "remarks" : "remarks"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserRESTServiceApi;

import java.io.File;
import java.util.*;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        UserCreateDTO userCreateDTO = {"extId":"4254","userState":"active","loginId":"testUser","languageCode":"en","isTechnicalUser":false,"name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Zurich","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781254153","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is the new test user john doe","modificationComment":"They live in ZH","properties":{"custom_property1":"value1","custom_property2":"value2"}}; // UserCreateDTO | 

        try {
            apiInstance.createUser1(clientExtId, userCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#createUser1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final UserCreateDTO userCreateDTO = new UserCreateDTO(); // UserCreateDTO | 

try {
    final result = await api_instance.createUser1(clientExtId, userCreateDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createUser1: $e\n');
}

import org.openapitools.client.api.UserRESTServiceApi;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        UserCreateDTO userCreateDTO = {"extId":"4254","userState":"active","loginId":"testUser","languageCode":"en","isTechnicalUser":false,"name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Zurich","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781254153","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is the new test user john doe","modificationComment":"They live in ZH","properties":{"custom_property1":"value1","custom_property2":"value2"}}; // UserCreateDTO | 

        try {
            apiInstance.createUser1(clientExtId, userCreateDTO);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#createUser1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserRESTServiceApi *apiInstance = [[UserRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
UserCreateDTO *userCreateDTO = {"extId":"4254","userState":"active","loginId":"testUser","languageCode":"en","isTechnicalUser":false,"name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Zurich","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781254153","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is the new test user john doe","modificationComment":"They live in ZH","properties":{"custom_property1":"value1","custom_property2":"value2"}}; // 

// Create user
[apiInstance createUser1With:clientExtId
    userCreateDTO:userCreateDTO
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UserRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userCreateDTO = {"extId":"4254","userState":"active","loginId":"testUser","languageCode":"en","isTechnicalUser":false,"name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Zurich","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781254153","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is the new test user john doe","modificationComment":"They live in ZH","properties":{"custom_property1":"value1","custom_property2":"value2"}}; // {UserCreateDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createUser1(clientExtId, userCreateDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createUser1Example
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userCreateDTO = new UserCreateDTO(); // UserCreateDTO | 

            try {
                // Create user
                apiInstance.createUser1(clientExtId, userCreateDTO);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserRESTServiceApi.createUser1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userCreateDTO = {"extId":"4254","userState":"active","loginId":"testUser","languageCode":"en","isTechnicalUser":false,"name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Zurich","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781254153","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is the new test user john doe","modificationComment":"They live in ZH","properties":{"custom_property1":"value1","custom_property2":"value2"}}; // UserCreateDTO | 

try {
    $api_instance->createUser1($clientExtId, $userCreateDTO);
} catch (Exception $e) {
    echo 'Exception when calling UserRESTServiceApi->createUser1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userCreateDTO = WWW::OPenAPIClient::Object::UserCreateDTO->new(); # UserCreateDTO | 

eval {
    $api_instance->createUser1(clientExtId => $clientExtId, userCreateDTO => $userCreateDTO);
};
if ($@) {
    warn "Exception when calling UserRESTServiceApi->createUser1: $@\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.UserRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userCreateDTO = {"extId":"4254","userState":"active","loginId":"testUser","languageCode":"en","isTechnicalUser":false,"name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Zurich","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781254153","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is the new test user john doe","modificationComment":"They live in ZH","properties":{"custom_property1":"value1","custom_property2":"value2"}} # UserCreateDTO | 

try:
    # Create user
    api_instance.create_user1(clientExtId, userCreateDTO)
except ApiException as e:
    print("Exception when calling UserRESTServiceApi->createUser1: %s\n" % e)
extern crate UserRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userCreateDTO = {"extId":"4254","userState":"active","loginId":"testUser","languageCode":"en","isTechnicalUser":false,"name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Zurich","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781254153","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is the new test user john doe","modificationComment":"They live in ZH","properties":{"custom_property1":"value1","custom_property2":"value2"}}; // UserCreateDTO

    let mut context = UserRESTServiceApi::Context::default();
    let result = client.createUser1(clientExtId, userCreateDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
Body parameters
Name Description
userCreateDTO *

Responses

Name Type Format Description
Location String Location of created role

deleteUser1

deleteUser1
delete/core/v1/{clientExtId}/users/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.UserDelete,AccessControl.UserDeleteTechUser` or `SelfAdmin` Role Deletes the user with the given external ID, belonging to the client with the given external ID.

Usage and SDK Samples

curl -X DELETE \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserRESTServiceApi;

import java.io.File;
import java.util.*;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the user

        try {
            apiInstance.deleteUser1(clientExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#deleteUser1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the user

try {
    final result = await api_instance.deleteUser1(clientExtId, extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteUser1: $e\n');
}

import org.openapitools.client.api.UserRESTServiceApi;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the user

        try {
            apiInstance.deleteUser1(clientExtId, extId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#deleteUser1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserRESTServiceApi *apiInstance = [[UserRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1000; // ExtID of the user (default to null)

// Delete user
[apiInstance deleteUser1With:clientExtId
    extId:extId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UserRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1000; // {String} ExtID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUser1(clientExtId, extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteUser1Example
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1000;  // String | ExtID of the user (default to null)

            try {
                // Delete user
                apiInstance.deleteUser1(clientExtId, extId);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserRESTServiceApi.deleteUser1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1000; // String | ExtID of the user

try {
    $api_instance->deleteUser1($clientExtId, $extId);
} catch (Exception $e) {
    echo 'Exception when calling UserRESTServiceApi->deleteUser1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1000; # String | ExtID of the user

eval {
    $api_instance->deleteUser1(clientExtId => $clientExtId, extId => $extId);
};
if ($@) {
    warn "Exception when calling UserRESTServiceApi->deleteUser1: $@\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.UserRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1000 # String | ExtID of the user (default to null)

try:
    # Delete user
    api_instance.delete_user1(clientExtId, extId)
except ApiException as e:
    print("Exception when calling UserRESTServiceApi->deleteUser1: %s\n" % e)
extern crate UserRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1000; // String

    let mut context = UserRESTServiceApi::Context::default();
    let result = client.deleteUser1(clientExtId, extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the user
Required

Responses


getConsents

getConsents
get/core/v1/{clientExtId}/users/{userExtId}/consents

**Since:** 2.83.0 **Required permission(s):** `AccessControl.ConsentView` Lists all consents accepted by a user determined by its client external ID and user external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/consents"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserRESTServiceApi;

import java.io.File;
import java.util.*;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1000; // String | ExtID of the user

        try {
            ConsentGetDTO result = apiInstance.getConsents(clientExtId, userExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#getConsents");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user

try {
    final result = await api_instance.getConsents(clientExtId, userExtId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getConsents: $e\n');
}

import org.openapitools.client.api.UserRESTServiceApi;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1000; // String | ExtID of the user

        try {
            ConsentGetDTO result = apiInstance.getConsents(clientExtId, userExtId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#getConsents");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserRESTServiceApi *apiInstance = [[UserRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1000; // ExtID of the user (default to null)

// Get consents
[apiInstance getConsentsWith:clientExtId
    userExtId:userExtId
              completionHandler: ^(ConsentGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UserRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1000; // {String} ExtID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsents(clientExtId, userExtId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getConsentsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1000;  // String | ExtID of the user (default to null)

            try {
                // Get consents
                ConsentGetDTO result = apiInstance.getConsents(clientExtId, userExtId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserRESTServiceApi.getConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1000; // String | ExtID of the user

try {
    $result = $api_instance->getConsents($clientExtId, $userExtId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserRESTServiceApi->getConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1000; # String | ExtID of the user

eval {
    my $result = $api_instance->getConsents(clientExtId => $clientExtId, userExtId => $userExtId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserRESTServiceApi->getConsents: $@\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.UserRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1000 # String | ExtID of the user (default to null)

try:
    # Get consents
    api_response = api_instance.get_consents(clientExtId, userExtId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserRESTServiceApi->getConsents: %s\n" % e)
extern crate UserRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1000; // String

    let mut context = UserRESTServiceApi::Context::default();
    let result = client.getConsents(clientExtId, userExtId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required

Responses


getCredentials

getCredentials
get/core/v1/{clientExtId}/users/{extId}/credentials

**Since:** 7.2405.0, 8.2405.0 **Required permission(s):** `AccessControl.CredentialView` or `SelfAdmin` Role Returns all credentials of the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{extId}/credentials?continuationToken=continuationToken_example&limit=1000"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserRESTServiceApi;

import java.io.File;
import java.util.*;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForCredentialGetDTO result = apiInstance.getCredentials(clientExtId, extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#getCredentials");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the user
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

try {
    final result = await api_instance.getCredentials(clientExtId, extId, continuationToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCredentials: $e\n');
}

import org.openapitools.client.api.UserRESTServiceApi;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 1000; // Integer | Pagination limit

        try {
            ItemsWrapperForCredentialGetDTO result = apiInstance.getCredentials(clientExtId, extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#getCredentials");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserRESTServiceApi *apiInstance = [[UserRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1000; // ExtID of the user (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 1000; // Pagination limit (optional) (default to 0)

// Get user credentials
[apiInstance getCredentialsWith:clientExtId
    extId:extId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForCredentialGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UserRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1000; // {String} ExtID of the user
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 1000 // {Integer} Pagination limit
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCredentials(clientExtId, extId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCredentialsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1000;  // String | ExtID of the user (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 1000;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get user credentials
                ItemsWrapperForCredentialGetDTO result = apiInstance.getCredentials(clientExtId, extId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserRESTServiceApi.getCredentials: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1000; // String | ExtID of the user
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 1000; // Integer | Pagination limit

try {
    $result = $api_instance->getCredentials($clientExtId, $extId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserRESTServiceApi->getCredentials: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1000; # String | ExtID of the user
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 1000; # Integer | Pagination limit

eval {
    my $result = $api_instance->getCredentials(clientExtId => $clientExtId, extId => $extId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserRESTServiceApi->getCredentials: $@\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.UserRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1000 # String | ExtID of the user (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 1000 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get user credentials
    api_response = api_instance.get_credentials(clientExtId, extId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserRESTServiceApi->getCredentials: %s\n" % e)
extern crate UserRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1000; // String
    let continuationToken = continuationToken_example; // String
    let limit = 1000; // Integer

    let mut context = UserRESTServiceApi::Context::default();
    let result = client.getCredentials(clientExtId, extId, continuationToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the user
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


getPendingTerms

getPendingTerms
get/core/v1/{clientExtId}/users/{userExtId}/terms-pending

**Since:** 2.75.1 **Required permission(s):** `AccessControl.ConsentView,AccessControl.TermsView` Gets all the pending terms for a user.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/terms-pending?continuationToken=continuationToken_example&limit=100"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserRESTServiceApi;

import java.io.File;
import java.util.*;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1000; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperDTO result = apiInstance.getPendingTerms(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#getPendingTerms");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

try {
    final result = await api_instance.getPendingTerms(clientExtId, userExtId, continuationToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPendingTerms: $e\n');
}

import org.openapitools.client.api.UserRESTServiceApi;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1000; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperDTO result = apiInstance.getPendingTerms(clientExtId, userExtId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#getPendingTerms");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserRESTServiceApi *apiInstance = [[UserRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1000; // ExtID of the user (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 100; // Pagination limit (optional) (default to 0)

// Get pending terms
[apiInstance getPendingTermsWith:clientExtId
    userExtId:userExtId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UserRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1000; // {String} ExtID of the user
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 100 // {Integer} Pagination limit
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPendingTerms(clientExtId, userExtId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getPendingTermsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1000;  // String | ExtID of the user (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 100;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get pending terms
                ItemsWrapperDTO result = apiInstance.getPendingTerms(clientExtId, userExtId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserRESTServiceApi.getPendingTerms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1000; // String | ExtID of the user
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 100; // Integer | Pagination limit

try {
    $result = $api_instance->getPendingTerms($clientExtId, $userExtId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserRESTServiceApi->getPendingTerms: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1000; # String | ExtID of the user
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 100; # Integer | Pagination limit

eval {
    my $result = $api_instance->getPendingTerms(clientExtId => $clientExtId, userExtId => $userExtId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserRESTServiceApi->getPendingTerms: $@\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.UserRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1000 # String | ExtID of the user (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 100 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get pending terms
    api_response = api_instance.get_pending_terms(clientExtId, userExtId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserRESTServiceApi->getPendingTerms: %s\n" % e)
extern crate UserRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1000; // String
    let continuationToken = continuationToken_example; // String
    let limit = 100; // Integer

    let mut context = UserRESTServiceApi::Context::default();
    let result = client.getPendingTerms(clientExtId, userExtId, continuationToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


getProfiles

getProfiles
get/core/v1/{clientExtId}/users/{extId}/profiles

**Since:** 2.71.0 **Required permission(s):** `AccessControl.UserView,AccessControl.ProfileView` or `SelfAdmin` Role Returns all profiles of the user with the given external ID.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{extId}/profiles?continuationToken=continuationToken_example&limit=100"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserRESTServiceApi;

import java.io.File;
import java.util.*;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 100; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperForProfileGetDTO result = apiInstance.getProfiles(clientExtId, extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#getProfiles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the user
final String continuationToken = new String(); // String | Pagination continuation token
final Integer limit = new Integer(); // Integer | Pagination limit

try {
    final result = await api_instance.getProfiles(clientExtId, extId, continuationToken, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getProfiles: $e\n');
}

import org.openapitools.client.api.UserRESTServiceApi;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 100; // String | ExtID of the user
        String continuationToken = continuationToken_example; // String | Pagination continuation token
        Integer limit = 100; // Integer | Pagination limit

        try {
            ItemsWrapperForProfileGetDTO result = apiInstance.getProfiles(clientExtId, extId, continuationToken, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#getProfiles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserRESTServiceApi *apiInstance = [[UserRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 100; // ExtID of the user (default to null)
String *continuationToken = continuationToken_example; // Pagination continuation token (optional) (default to )
Integer *limit = 100; // Pagination limit (optional) (default to 0)

// Get user profiles
[apiInstance getProfilesWith:clientExtId
    extId:extId
    continuationToken:continuationToken
    limit:limit
              completionHandler: ^(ItemsWrapperForProfileGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UserRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 100; // {String} ExtID of the user
var opts = {
  'continuationToken': continuationToken_example, // {String} Pagination continuation token
  'limit': 100 // {Integer} Pagination limit
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProfiles(clientExtId, extId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getProfilesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 100;  // String | ExtID of the user (default to null)
            var continuationToken = continuationToken_example;  // String | Pagination continuation token (optional)  (default to )
            var limit = 100;  // Integer | Pagination limit (optional)  (default to 0)

            try {
                // Get user profiles
                ItemsWrapperForProfileGetDTO result = apiInstance.getProfiles(clientExtId, extId, continuationToken, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserRESTServiceApi.getProfiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 100; // String | ExtID of the user
$continuationToken = continuationToken_example; // String | Pagination continuation token
$limit = 100; // Integer | Pagination limit

try {
    $result = $api_instance->getProfiles($clientExtId, $extId, $continuationToken, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserRESTServiceApi->getProfiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 100; # String | ExtID of the user
my $continuationToken = continuationToken_example; # String | Pagination continuation token
my $limit = 100; # Integer | Pagination limit

eval {
    my $result = $api_instance->getProfiles(clientExtId => $clientExtId, extId => $extId, continuationToken => $continuationToken, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserRESTServiceApi->getProfiles: $@\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.UserRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 100 # String | ExtID of the user (default to null)
continuationToken = continuationToken_example # String | Pagination continuation token (optional) (default to )
limit = 100 # Integer | Pagination limit (optional) (default to 0)

try:
    # Get user profiles
    api_response = api_instance.get_profiles(clientExtId, extId, continuationToken=continuationToken, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserRESTServiceApi->getProfiles: %s\n" % e)
extern crate UserRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 100; // String
    let continuationToken = continuationToken_example; // String
    let limit = 100; // Integer

    let mut context = UserRESTServiceApi::Context::default();
    let result = client.getProfiles(clientExtId, extId, continuationToken, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the user
Required
Query parameters
Name Description
continuationToken
String
Pagination continuation token
limit
Integer (int32)
Pagination limit

Responses


getProperties

getProperties
get/core/v1/{clientExtId}/users/{extId}/properties

**Since:** 2.79.0 **Required permission(s):** `AccessControl.UserView,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView` Returns all properties of the user with the given external ID, as an object of key-value pairs. If there are no properties found, an empty object is returned.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{extId}/properties"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserRESTServiceApi;

import java.io.File;
import java.util.*;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the user

        try {
            PropertyGetWithClassificationDTO result = apiInstance.getProperties(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#getProperties");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the user

try {
    final result = await api_instance.getProperties(clientExtId, extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getProperties: $e\n');
}

import org.openapitools.client.api.UserRESTServiceApi;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the user

        try {
            PropertyGetWithClassificationDTO result = apiInstance.getProperties(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#getProperties");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserRESTServiceApi *apiInstance = [[UserRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1000; // ExtID of the user (default to null)

// Get user properties
[apiInstance getPropertiesWith:clientExtId
    extId:extId
              completionHandler: ^(PropertyGetWithClassificationDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UserRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1000; // {String} ExtID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProperties(clientExtId, extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getPropertiesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1000;  // String | ExtID of the user (default to null)

            try {
                // Get user properties
                PropertyGetWithClassificationDTO result = apiInstance.getProperties(clientExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserRESTServiceApi.getProperties: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1000; // String | ExtID of the user

try {
    $result = $api_instance->getProperties($clientExtId, $extId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserRESTServiceApi->getProperties: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1000; # String | ExtID of the user

eval {
    my $result = $api_instance->getProperties(clientExtId => $clientExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserRESTServiceApi->getProperties: $@\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.UserRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1000 # String | ExtID of the user (default to null)

try:
    # Get user properties
    api_response = api_instance.get_properties(clientExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserRESTServiceApi->getProperties: %s\n" % e)
extern crate UserRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1000; // String

    let mut context = UserRESTServiceApi::Context::default();
    let result = client.getProperties(clientExtId, extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the user
Required

Responses


getUser1

getUser1
get/core/v1/{clientExtId}/users/{extId}

**Required permission(s):** `AccessControl.UserView,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView` or `SelfAdmin` Role Returns the user with the given external ID, belonging to the client with the given external ID. Custom properties and classifications may be returned with the user, but if the caller does not have the right to access them, then they are simply omitted from the DTO.

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{extId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserRESTServiceApi;

import java.io.File;
import java.util.*;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the user

        try {
            UserGetDTO result = apiInstance.getUser1(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#getUser1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the user

try {
    final result = await api_instance.getUser1(clientExtId, extId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUser1: $e\n');
}

import org.openapitools.client.api.UserRESTServiceApi;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the user

        try {
            UserGetDTO result = apiInstance.getUser1(clientExtId, extId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#getUser1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserRESTServiceApi *apiInstance = [[UserRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1000; // ExtID of the user (default to null)

// Get user
[apiInstance getUser1With:clientExtId
    extId:extId
              completionHandler: ^(UserGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UserRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1000; // {String} ExtID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUser1(clientExtId, extId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUser1Example
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1000;  // String | ExtID of the user (default to null)

            try {
                // Get user
                UserGetDTO result = apiInstance.getUser1(clientExtId, extId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserRESTServiceApi.getUser1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1000; // String | ExtID of the user

try {
    $result = $api_instance->getUser1($clientExtId, $extId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserRESTServiceApi->getUser1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1000; # String | ExtID of the user

eval {
    my $result = $api_instance->getUser1(clientExtId => $clientExtId, extId => $extId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserRESTServiceApi->getUser1: $@\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.UserRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1000 # String | ExtID of the user (default to null)

try:
    # Get user
    api_response = api_instance.get_user1(clientExtId, extId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserRESTServiceApi->getUser1: %s\n" % e)
extern crate UserRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1000; // String

    let mut context = UserRESTServiceApi::Context::default();
    let result = client.getUser1(clientExtId, extId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the user
Required

Responses


patchUser1

patchUser1
patch/core/v1/{clientExtId}/users/{extId}

**Since:** 2.71.0 **Required permission(s):** `AccessControl.UserView,AccessControl.UserModify,AccessControl.UserModifyTechUser` or `SelfAdmin` Role Updates the user with the given external ID, belonging to the client with the given external ID. From version 2.82, updating the custom properties of a user in the same call is also possible.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{extId}" \
 -d '{
  "loginId" : "loginId",
  "address" : {
    "dwellingNumber" : "A12",
    "city" : "Zürich",
    "street" : "Bahnhofstrasse",
    "countryCode" : "CH",
    "postalCode" : 8001,
    "postOfficeBoxText" : "Postfach",
    "houseNumber" : 1,
    "locality" : "Kreis 1",
    "addressline2" : "Wohnung 2",
    "addressline1" : "Bahnhofstrasse 1",
    "postOfficeBoxNumber" : 123
  },
  "gender" : "female",
  "modificationComment" : "modificationComment",
  "sex" : "sex",
  "languageCode" : "languageCode",
  "birthDate" : "birthDate",
  "version" : 0,
  "userState" : "active",
  "name" : {
    "firstName" : "John",
    "familyName" : "Doe",
    "title" : "Mr."
  },
  "validity" : {
    "from" : "2023-01-01T00:00:00Z",
    "to" : "2033-12-31T23:59:59Z"
  },
  "properties" : {
    "key" : "properties"
  },
  "contacts" : {
    "mobile" : "+41781254156",
    "telephone" : "+41781254153",
    "telefax" : "+41781254154",
    "email" : "[email protected]"
  },
  "remarks" : "remarks"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserRESTServiceApi;

import java.io.File;
import java.util.*;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the user
        UserPatchDTO userPatchDTO = {"userState":"active","version":0,"loginId":"testUser","languageCode":"en","name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Budapest","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781234567","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is test user john doe","modificationComment":"Adjusted his telephone number","properties":{"custom_property1":"value1","custom_property2":"value2"}}; // UserPatchDTO | 

        try {
            UserGetDTO result = apiInstance.patchUser1(clientExtId, extId, userPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#patchUser1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the user
final UserPatchDTO userPatchDTO = new UserPatchDTO(); // UserPatchDTO | 

try {
    final result = await api_instance.patchUser1(clientExtId, extId, userPatchDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchUser1: $e\n');
}

import org.openapitools.client.api.UserRESTServiceApi;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the user
        UserPatchDTO userPatchDTO = {"userState":"active","version":0,"loginId":"testUser","languageCode":"en","name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Budapest","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781234567","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is test user john doe","modificationComment":"Adjusted his telephone number","properties":{"custom_property1":"value1","custom_property2":"value2"}}; // UserPatchDTO | 

        try {
            UserGetDTO result = apiInstance.patchUser1(clientExtId, extId, userPatchDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#patchUser1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserRESTServiceApi *apiInstance = [[UserRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1000; // ExtID of the user (default to null)
UserPatchDTO *userPatchDTO = {"userState":"active","version":0,"loginId":"testUser","languageCode":"en","name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Budapest","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781234567","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is test user john doe","modificationComment":"Adjusted his telephone number","properties":{"custom_property1":"value1","custom_property2":"value2"}}; // 

// Update user
[apiInstance patchUser1With:clientExtId
    extId:extId
    userPatchDTO:userPatchDTO
              completionHandler: ^(UserGetDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UserRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1000; // {String} ExtID of the user
var userPatchDTO = {"userState":"active","version":0,"loginId":"testUser","languageCode":"en","name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Budapest","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781234567","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is test user john doe","modificationComment":"Adjusted his telephone number","properties":{"custom_property1":"value1","custom_property2":"value2"}}; // {UserPatchDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchUser1(clientExtId, extId, userPatchDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class patchUser1Example
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1000;  // String | ExtID of the user (default to null)
            var userPatchDTO = new UserPatchDTO(); // UserPatchDTO | 

            try {
                // Update user
                UserGetDTO result = apiInstance.patchUser1(clientExtId, extId, userPatchDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserRESTServiceApi.patchUser1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1000; // String | ExtID of the user
$userPatchDTO = {"userState":"active","version":0,"loginId":"testUser","languageCode":"en","name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Budapest","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781234567","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is test user john doe","modificationComment":"Adjusted his telephone number","properties":{"custom_property1":"value1","custom_property2":"value2"}}; // UserPatchDTO | 

try {
    $result = $api_instance->patchUser1($clientExtId, $extId, $userPatchDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserRESTServiceApi->patchUser1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1000; # String | ExtID of the user
my $userPatchDTO = WWW::OPenAPIClient::Object::UserPatchDTO->new(); # UserPatchDTO | 

eval {
    my $result = $api_instance->patchUser1(clientExtId => $clientExtId, extId => $extId, userPatchDTO => $userPatchDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserRESTServiceApi->patchUser1: $@\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.UserRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1000 # String | ExtID of the user (default to null)
userPatchDTO = {"userState":"active","version":0,"loginId":"testUser","languageCode":"en","name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Budapest","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781234567","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is test user john doe","modificationComment":"Adjusted his telephone number","properties":{"custom_property1":"value1","custom_property2":"value2"}} # UserPatchDTO | 

try:
    # Update user
    api_response = api_instance.patch_user1(clientExtId, extId, userPatchDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserRESTServiceApi->patchUser1: %s\n" % e)
extern crate UserRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1000; // String
    let userPatchDTO = {"userState":"active","version":0,"loginId":"testUser","languageCode":"en","name":{"title":"Mr.","firstName":"John","familyName":"Doe"},"sex":"male","gender":"male","birthDate":"1969-04-12","address":{"countryCode":"ch","city":"Budapest","postalCode":"123414","addressline1":"PostBox 1241","addressline2":"Company XYZ","street":"Poststreet","houseNumber":"12","dwellingNumber":"102B","postOfficeBoxText":"PostBox","postOfficeBoxNumber":1241,"locality":"Province XYZ"},"contacts":{"telephone":"+41781234567","telefax":"+41781254154","mobile":"+41781254156","email":"[email protected]"},"validity":{"from":"2016-12-31T12:00:00Z","to":"2022-01-01T12:00:00Z"},"remarks":"This is test user john doe","modificationComment":"Adjusted his telephone number","properties":{"custom_property1":"value1","custom_property2":"value2"}}; // UserPatchDTO

    let mut context = UserRESTServiceApi::Context::default();
    let result = client.patchUser1(clientExtId, extId, userPatchDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the user
Required
Body parameters
Name Description
userPatchDTO *

Responses


updateLoginInfo1

updateLoginInfo1
post/core/v1/{clientExtId}/users/{userExtId}/login-info

**Since:** 2.88.0 **Required permission(s):** `AccessControl.CredentialModify, AccessControl.UserModify, AccessControl.UserView, AccessControl.CredentialView` Update user's login information and if credential is present, then the credential’s login information as well.

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/login-info" \
 -d '{
  "credentialExtId" : 1000,
  "success" : true
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserRESTServiceApi;

import java.io.File;
import java.util.*;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1000; // String | ExtID of the user
        UpdateLoginInfoDTO updateLoginInfoDTO = ; // UpdateLoginInfoDTO | 

        try {
            ExtendedLoginStatusDTO result = apiInstance.updateLoginInfo1(clientExtId, userExtId, updateLoginInfoDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#updateLoginInfo1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String userExtId = new String(); // String | ExtID of the user
final UpdateLoginInfoDTO updateLoginInfoDTO = new UpdateLoginInfoDTO(); // UpdateLoginInfoDTO | 

try {
    final result = await api_instance.updateLoginInfo1(clientExtId, userExtId, updateLoginInfoDTO);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateLoginInfo1: $e\n');
}

import org.openapitools.client.api.UserRESTServiceApi;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String userExtId = 1000; // String | ExtID of the user
        UpdateLoginInfoDTO updateLoginInfoDTO = ; // UpdateLoginInfoDTO | 

        try {
            ExtendedLoginStatusDTO result = apiInstance.updateLoginInfo1(clientExtId, userExtId, updateLoginInfoDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#updateLoginInfo1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserRESTServiceApi *apiInstance = [[UserRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *userExtId = 1000; // ExtID of the user (default to null)
UpdateLoginInfoDTO *updateLoginInfoDTO = ; // 

// Update login information
[apiInstance updateLoginInfo1With:clientExtId
    userExtId:userExtId
    updateLoginInfoDTO:updateLoginInfoDTO
              completionHandler: ^(ExtendedLoginStatusDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UserRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var userExtId = 1000; // {String} ExtID of the user
var updateLoginInfoDTO = ; // {UpdateLoginInfoDTO} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateLoginInfo1(clientExtId, userExtId, updateLoginInfoDTO, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateLoginInfo1Example
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var userExtId = 1000;  // String | ExtID of the user (default to null)
            var updateLoginInfoDTO = new UpdateLoginInfoDTO(); // UpdateLoginInfoDTO | 

            try {
                // Update login information
                ExtendedLoginStatusDTO result = apiInstance.updateLoginInfo1(clientExtId, userExtId, updateLoginInfoDTO);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserRESTServiceApi.updateLoginInfo1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$userExtId = 1000; // String | ExtID of the user
$updateLoginInfoDTO = ; // UpdateLoginInfoDTO | 

try {
    $result = $api_instance->updateLoginInfo1($clientExtId, $userExtId, $updateLoginInfoDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserRESTServiceApi->updateLoginInfo1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $userExtId = 1000; # String | ExtID of the user
my $updateLoginInfoDTO = WWW::OPenAPIClient::Object::UpdateLoginInfoDTO->new(); # UpdateLoginInfoDTO | 

eval {
    my $result = $api_instance->updateLoginInfo1(clientExtId => $clientExtId, userExtId => $userExtId, updateLoginInfoDTO => $updateLoginInfoDTO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserRESTServiceApi->updateLoginInfo1: $@\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.UserRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
userExtId = 1000 # String | ExtID of the user (default to null)
updateLoginInfoDTO =  # UpdateLoginInfoDTO | 

try:
    # Update login information
    api_response = api_instance.update_login_info1(clientExtId, userExtId, updateLoginInfoDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserRESTServiceApi->updateLoginInfo1: %s\n" % e)
extern crate UserRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let userExtId = 1000; // String
    let updateLoginInfoDTO = ; // UpdateLoginInfoDTO

    let mut context = UserRESTServiceApi::Context::default();
    let result = client.updateLoginInfo1(clientExtId, userExtId, updateLoginInfoDTO, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
userExtId*
String
ExtID of the user
Required
Body parameters
Name Description
updateLoginInfoDTO *

Responses


updateProperties

updateProperties
patch/core/v1/{clientExtId}/users/{extId}/properties

**Since:** 2.79.0 **Required permission(s):** `AccessControl.UserView,AccessControl.UserModify,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView,AccessControl.PropertyValueCreate,AccessControl.PropertyValueDelete,AccessControl.PropertyValueModify` Updates the properties of the user with the given external ID, belonging to the client with the given external ID. The body has to contain an object of key-value property pairs.

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost:8080/nevisidm/api/core/v1/{clientExtId}/users/{extId}/properties" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserRESTServiceApi;

import java.io.File;
import java.util.*;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the user
        map[String, String] requestBody = {"propertyName1":"propertyNewValue1","propertyName3":"propertyNewValue3"}; // map[String, String] | 

        try {
            PropertyGetWithClassificationDTO result = apiInstance.updateProperties(clientExtId, extId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#updateProperties");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String clientExtId = new String(); // String | ExtID of the client
final String extId = new String(); // String | ExtID of the user
final map[String, String] requestBody = new map[String, String](); // map[String, String] | 

try {
    final result = await api_instance.updateProperties(clientExtId, extId, requestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateProperties: $e\n');
}

import org.openapitools.client.api.UserRESTServiceApi;

public class UserRESTServiceApiExample {
    public static void main(String[] args) {
        UserRESTServiceApi apiInstance = new UserRESTServiceApi();
        String clientExtId = 1000; // String | ExtID of the client
        String extId = 1000; // String | ExtID of the user
        map[String, String] requestBody = {"propertyName1":"propertyNewValue1","propertyName3":"propertyNewValue3"}; // map[String, String] | 

        try {
            PropertyGetWithClassificationDTO result = apiInstance.updateProperties(clientExtId, extId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserRESTServiceApi#updateProperties");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserRESTServiceApi *apiInstance = [[UserRESTServiceApi alloc] init];
String *clientExtId = 1000; // ExtID of the client (default to null)
String *extId = 1000; // ExtID of the user (default to null)
map[String, String] *requestBody = {"propertyName1":"propertyNewValue1","propertyName3":"propertyNewValue3"}; // 

// Update user properties
[apiInstance updatePropertiesWith:clientExtId
    extId:extId
    requestBody:requestBody
              completionHandler: ^(PropertyGetWithClassificationDTO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NevisIdmRestApiDocumentation = require('nevis_idm_rest_api_documentation');

// Create an instance of the API class
var api = new NevisIdmRestApiDocumentation.UserRESTServiceApi()
var clientExtId = 1000; // {String} ExtID of the client
var extId = 1000; // {String} ExtID of the user
var requestBody = {"propertyName1":"propertyNewValue1","propertyName3":"propertyNewValue3"}; // {map[String, String]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateProperties(clientExtId, extId, requestBody, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updatePropertiesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserRESTServiceApi();
            var clientExtId = 1000;  // String | ExtID of the client (default to null)
            var extId = 1000;  // String | ExtID of the user (default to null)
            var requestBody = new map[String, String](); // map[String, String] | 

            try {
                // Update user properties
                PropertyGetWithClassificationDTO result = apiInstance.updateProperties(clientExtId, extId, requestBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserRESTServiceApi.updateProperties: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserRESTServiceApi();
$clientExtId = 1000; // String | ExtID of the client
$extId = 1000; // String | ExtID of the user
$requestBody = {"propertyName1":"propertyNewValue1","propertyName3":"propertyNewValue3"}; // map[String, String] | 

try {
    $result = $api_instance->updateProperties($clientExtId, $extId, $requestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserRESTServiceApi->updateProperties: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserRESTServiceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserRESTServiceApi->new();
my $clientExtId = 1000; # String | ExtID of the client
my $extId = 1000; # String | ExtID of the user
my $requestBody = WWW::OPenAPIClient::Object::map[String, String]->new(); # map[String, String] | 

eval {
    my $result = $api_instance->updateProperties(clientExtId => $clientExtId, extId => $extId, requestBody => $requestBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserRESTServiceApi->updateProperties: $@\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.UserRESTServiceApi()
clientExtId = 1000 # String | ExtID of the client (default to null)
extId = 1000 # String | ExtID of the user (default to null)
requestBody = {"propertyName1":"propertyNewValue1","propertyName3":"propertyNewValue3"} # map[String, String] | 

try:
    # Update user properties
    api_response = api_instance.update_properties(clientExtId, extId, requestBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserRESTServiceApi->updateProperties: %s\n" % e)
extern crate UserRESTServiceApi;

pub fn main() {
    let clientExtId = 1000; // String
    let extId = 1000; // String
    let requestBody = {"propertyName1":"propertyNewValue1","propertyName3":"propertyNewValue3"}; // map[String, String]

    let mut context = UserRESTServiceApi::Context::default();
    let result = client.updateProperties(clientExtId, extId, requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
clientExtId*
String
ExtID of the client
Required
extId*
String
ExtID of the user
Required
Body parameters
Name Description
requestBody *

Responses