Documentation
Home
Products
DirX Access DirX Audit DirX Directory DirX Identity
Get Support

DirX Directory

  • General
    • Copyright
    • About this Documentation
    • Notation Conventions
  • Introduction
    • Preface
    • Introducing DirX Directory
      • What is DirX Directory?
      • The LDAP server
      • DSA
      • DirX Directory Progsvr
      • The DirX Directory HTTP server
      • The DBAM Database
      • DirX Directory Security Services
      • Replication Services
      • Recovery Services
      • Monitoring, Auditing, and Logging Services
      • DirX Directory and High Availability Configurations
      • DirX Directory Administration Tools
      • Setting Up the DirX Directory Service
      • Maintaining the DirX Directory Service
    • Glossary
  • Administration Guide
    • Preface
    • Understanding DBAM and Storage Management
      • Disk Hardware Concepts
      • RAID Disk Management
      • Windows Disk Management
      • Linux Disk Management
      • The DBAM Storage Model
      • DBAM Configuration Tools
    • Using the DirX Directory Administration Tools
      • Using DirX Directory Manager
      • Using dirxcp
      • Using dirxadm
      • Using Tcl Scripts with dirxadm and dirxcp
      • Using dirxload
      • Using dirxmodify
      • Using dirxbackup
    • Getting Started with DirX Directory Setup
      • General Notes
      • Setting up the Sample Service on Windows
      • Setting up the Sample Service on Linux
    • Setting up the DirX Directory Service
      • Setting up the DSA
      • Setting up the LDAP Server
      • Loading the Directory Data
      • Starting the Service
    • Extending the DirX Directory Service
      • Extending the Stand-Alone DSA
      • Extending the My Company LDAP Server Configuration
    • Creating a Shadow DSA
      • Before You Begin
      • Planning the Shadow Configuration
      • Building the Shadow Configuration
      • Using disp to Perform a Total Update
      • Switching Supplier DSAs in a Shadow Configuration
      • Password Policies in a Shadow Configuration
      • Shadowing in a Heterogeneous Network
      • Managing Unique Constraint Checks in a Shadow Configuration
    • Distributing the DIT across Multiple DSAs
      • Planning the Distributed Configuration
      • Building the Distributed Configuration
      • Establishing DSA Communications
      • Extending My-Company Distributed DIT Configuration
    • Multireplication
      • Planning the Shadow Configuration
      • Building the Shadow Configuration
      • Negotiating the Shadowing Agreements
      • Using dirxadm to Prepare DSA1 and DSA4 for Shadowing
      • Creating the DSA Policy on DSA4
      • Using dirxadm to Create DSA Policy on DSA1
      • Access Control for Multireplication
      • Setting DUA Service Controls for Binds to Consumer DSAs
    • Creating a Synchronous Shadow DSA
      • Understanding Asynchronous and Synchronous Shadowing
      • Planning the Shadow Configuration
      • Building the Shadow Configuration
      • Extending the DIT with New Company Data
      • Disabling and Enabling the Shadowing Agreements
      • Monitoring Data Synchronicity Status
      • Switching Supplier DSAs
    • Using Multiple Contact DSAs
      • Understanding the Multiple Contact DSA Configuration
      • Additional Features, Limitations, and Issues
      • Planning the Multiple Contact DSA Configuration
      • Building the Multiple Contact DSA Configuration
      • Disabling and Enabling Contact DSAs
      • Monitoring a Multiple Contact DSA Configuration
      • Mixing Single and Multi-Contact DSA Configurations
    • Using LDIF Files for Data Synchronization
      • Exporting Directory Data to LDIF Files
      • Importing Directory Updates from an LDIF File
    • Monitoring DirX Directory
      • Monitoring the DSA MIBs with dirxadm
      • Monitoring the LDAP MIBs
      • Monitoring DirX Directory with LDAP Extended Operations
      • Monitoring DirX Directory with SNMPv2 Traps
      • Monitoring DirX Directory with Nagios
      • Monitoring DirX Directory with the Supervisor Scripts
      • Using DSA Auditing
      • Using LDAP Auditing
      • Evaluating the Audit Log File
      • Using DirX Directory Diagnostic Logging
      • Using the Logging Configuration Files
      • Enabling and Disabling Diagnostic Logging
      • Locating and Reading the Diagnostic Log Files
      • Checking Database Consistency
      • Managing Backups
      • Exceeding Database Limits
    • Understanding External Authentication
      • Why Use External Authentication?
      • What Kinds of Bind Requests Can Be Externally Authenticated?
      • How Is External Authentication Controlled?
      • What External Authentication Services Are Supported?
    • Managing Miscellaneous Scenarios
      • Working with Nested Groups
      • Working with Dynamic Groups
      • Managing Huge Search Results
      • Enabling NAT Support in PSAP Addresses
      • Creating a Mixed IP Version Configuration
      • Encrypting X.500 Protocols
      • Changing Host IP Addresses of DirX Directory Servers
      • Using Two-Factor Authentication (2FA)
  • Administration Reference
    • Preface
    • DirX Directory Commands
      • dirxadm
        • abbr (dirxcp, dirxadm)
        • attr (dirxadm)
        • audit (dirxadm)
        • db (dirxadm)
        • dse (dirxadm)
        • ldap (dirxadm)
        • lob (dirxadm)
        • nmi (dirxadm)
        • progsvr (dirxadm)
        • sob (dirxadm)
        • sys (dirxadm)
        • util (dirxadm)
      • dirxcp
        • abbr (dirxadm, dirxcp)
        • args (dirxcp)
        • ldapargs (dirxcp)
        • obj (dirxcp)
        • util (dirxcp)
      • dirxauddecode
      • dirxaudstatistics
      • dirxdumplog
      • dirxbackup
      • dirxmodify
      • dirxconfig
      • dbaminit
      • dbamconfig
      • dbamboot
      • dirxload
      • dbamverify
      • dbamdevinfo
      • dirxextop
      • dirxhostinfo
    • DirX Directory Files
      • DirX Directory Environment Variable Ini File
      • Abbreviation Files
      • LDAP Server Configuration File
      • HTTP Server Configuration File
      • Directory Client Configuration File
      • LDAP Server Key Material
      • SSL/TLS trusted CA Certificates
      • IDMS Configuration and Key Material Files
      • RPC with TLS Configuration and Key Material Files
      • SNMPv2 Trap Configuration File
      • dirxauddecode Configuration File
      • syslog Configuration File
      • Logging Configuration Files
      • Code Signing Files
      • DirX Directory License Files
    • DirX Directory Default DSA Schema
      • Attribute Table
      • Object Classes Table
      • Attribute Syntax Table
      • Matching Rule Table
      • Schema Check
    • Environment Variables
      • Setting Environment Variables
        • Using the DirX Directory ini File
        • Windows Systems
        • Linux Systems
      • DirX Directory Environment Variables
      • Additional Environment Variables
      • Operating System Environment Variables
        • System Directories for Temporary Files
        • Enabling KEEPALIVE Time/Interval
    • IP Port Numbers
      • General Information
      • Port Numbers Specified in Environment Variables
      • Port Numbers Specified in Attributes of LDAP Server Configuration Subentry
      • Port Numbers Specified in Configuration Files
      • Port Numbers and the Firewall
    • File Locations
    • LDAP MIB Tables
      • LDAP MIB Static Table
      • LDAP MIB Total Table
      • LDAP MIB Current Table
      • LDAP MIB Association Table
      • LDAP MIB Environment Table
    • Exit Codes
      • HTTP Server Exit Codes
      • Progsvr Exit Codes
      • DSA Exit Codes
      • LDAP Server Exit Codes
      • Exit Codes and the DirX Directory Watchdog Process
    • DBAM MIB Tables
      • DBAM Transaction Statistics
      • DBAM Buffer Cache Statistics
      • DBAM Buffer Cache I/O Statistics
      • DBAM Translog Device I/O Statistics
      • DBAM Checkpoint Statistics
      • DBAM Interval Statistics
  • Syntaxes and Attributes
    • Preface
    • DirX Directory String Representation for DAP Binds
      • Reserved Characters
      • Simple and Structured Attributes
      • Distinguished Names
      • Search Filters
      • Attribute Syntax
      • String Representations for Simple Attribute Syntaxes
      • String Representations for Structured Attribute Syntaxes
    • DirX Directory String Representation for LDAP Binds
      • Reserved Characters
      • Simple and Structured Attributes
      • Distinguished Names
      • Search Filters
      • Attribute Syntax
      • String Representations for Simple Attribute Syntaxes
      • String Representations for Structured Attribute Syntaxes
    • DirX Directory Attributes
      • X.500 User Application Attributes
      • X.500 Directory Operational Attributes
      • X.500 Distributed Operational Attributes
      • DirX Directory DSA Operational Attributes
    • Country Codes
  • LDAP Extended Operations
    • Preface
    • DirX Directory LDAP Extended Operations
      • Invoking DirX Directory LDAP Extended Operations
      • Configuring DirX Directory LDAP Extended Operations
      • DirX Directory DSA LDAP Extended Operations Reference Descriptions
        • dsa_ac_log_on
        • dsa_ac_log_off
        • dsa_dbam_aac
        • dsa_dirxadm_cmd
        • dsa_relevant_aci
      • DirX Directory LDAP Server LDAP Extended Operations Reference Descriptions
        • ldap_cfg_upd
        • ldap_disable_config_dsa
        • ldap_enable_config_dsa
        • ldap_show_cfg_audit
        • ldap_show_cfg_general
        • ldap_show_cfg_ssl
        • ldap_show_cfg_upd_attr
        • ldap_show_cfg_upd_history
        • ldap_show_config_dsas
        • ldap_show_policy_rules
        • ldap_show_policy_users
        • ldap_show_single_user_policy_rules
  • External Authentication
    • Preface
    • External Authentication
      • Enabling External Authentication
      • External Authentication Configuration File Format
      • Generic External Authentication Configuration Parameters
      • Windows External Authentication
      • RACF External Authentication
  • Supervisor
    • Preface
    • DirX Directory Supervisor Scripts
      • General Information
      • dirxsupervisor
      • Supervisor Setup Script
      • Supervisor Password File
  • Nagios Plugins
    • Preface
    • DirX Directory Nagios Plugins
      • General Information
      • DirX Directory Nagios Plugins Reference Descriptions
      • DirX Directory Nagios Plugin Configuration File
  • Disc Dimensioning Guide
    • Preface
    • Introduction
    • References
    • Definitions
    • DBAM Storage Model and Terminology
    • DBAM Tools: Overview on Configuration Options
    • Indexes
    • Dimensioning Rules
    • Dimensioning Spread Sheet
    • Working Area
    • DBAM Tools: Getting Information on the Disk Space in Use
    • Extending the Directory Database
  • Guide for CSP Administrators
    • Preface
    • General Information
      • About DirX Directory for CSP
      • About the DirX Directory for CSP Scenario
    • Installation and Environment
    • Configuration
      • Configuring Encrypted X.500 Protocols
      • Setting Up Replication
      • Configuring Authentication-Related Attributes and Policies
      • Configuring the LDAP Servers
    • Access Control
      • Defining the ObjectClasses
      • Creating Access Control Subentries
      • Changing Certificate Access Status
    • Operation
      • Managing Auditing
      • Using SNMP Traps
      • Checking Database Consistency
      • Managing Backups
      • Managing Patches
    • Abbreviations
  • LDAP Proxy
    • Preface
    • Introduction
      • Configuration Elements
      • Features and Limitations
    • Configuration
      • LDAP Proxy Mode Attribute
      • DLP Server Configuration File
      • DLP Server Configuration Objects
    • Proxy Rules
      • User Routing Rules
      • Operation Routing Rules
      • Rewriting Rules
      • Character Set Requirements in Rule Conditions and Actions
      • Handling Special Characters in Rule Conditions and Actions
    • Operation
      • LDAP Server Process Startup for DLP
      • Connect Timeout
      • Offline Handling and Server Retry
      • Round Robin Selection and Failover
      • Character Set Handling
      • General Operation Forwarding Example
    • Monitoring and Analysis
      • Analyzing Errors in Rewriting Rule Definitions
      • DLP Server Logging
      • DLP Server Audit
      • LDAP Extended Operations for DLP Servers
    • Examples and Considerations
      • Examples of Rewriting Conditions and Actions
      • Considerations for Rewriting Rules
  • Corporate Directory Application
    • Preface
    • Readme
    • Overview
    • Installation and Deployment
    • Configuration
    • User Interface
  • REST API
    • API Reference
    • Configuration
    • Restrictions
    • Open API Reference
  • Containerization
    • Preface
    • Overview
    • Container Images
      • Full Image
      • Per-Server Images
      • Controller Image
      • Tagging
      • Database Files
      • Password Files
    • Example Kubernetes Projects
      • Restrictions
      • Prerequisites
      • Standalone Example Project
      • Scalable Example Project
      • Using the Example Kubernetes Projects
      • Troubleshooting
  • Revocery Best Practices
    • Preface
    • Overview
      • Prerequisites
      • Related Documentation
    • General Database Error Recovery Process
      • Determining the Type of Database Inconsistency
      • Determining the Database Inconsistency Severity
      • Collecting Data for Analysis
      • Reporting the Inconsistency to DirX Directory Support
      • Choosing a Database Recovery Strategy
      • Preserving Relevant Data
    • Error-specific Database Recovery Procedures
      • Attribute Index Inconsistency
      • Subordinate Bit String Inconsistency
      • Tree Inconsistency
      • Real Object Inconsistency
    • General Methods for Database Recovery
      • Restore Using an LDIF Dump
      • Restore Using a Backup Archive
      • Restore by Initiating a Total Update
    • Release Notes
      • General
        • Previous Releases
        • DirX Directory 10.0
      • Installation
        • Initial Installation
        • Upgrade Installation
        • Upgrade Installation and Database Migration
        • Upgrade Installation in a Shadowing Environment
        • Uninstallation
        • Code Signing and Verification
      • Administration
        • Database Administration
        • Administration on Linux
      • Compatibility
        • DBAM Database Compatibility
        • Other Compatibility Aspects
      • Restrictions
        • General Restriction
        • DAP
        • DOP
        • DirX Server
        • LDAP Proxy
        • dirxload
        • dirxadm
        • dirxcp
        • DirX Manager
        • Support of IPv6 Addresses
      • Notes
        • Example Scripts
        • DirX Manager
        • System Tuning
        • Environment Variables
        • Access to DirX using ADSI (LDAP Provider)
        • Deletion of Profiles with dbamconfig
        • Watchdog Start without (x)inetd on Linux
        • DirX crash handler
        • DirX DSA cache size
        • dirxschema tool
      • Known Problems
        • DirX Server
        • Ldap Server
        • dirxdumplog
        • dirxmodify
        • dirxcp
        • OpenSSL Command Line Tool
        • dirxsupervisor
        • Documentation
      • History of Previous Releases
        • DirX Directory 9.1
        • DirX Directory 9.0
      • Recommendations for an Operation Concept
    • DirX Directory license agreement
DirX Directory 10.0
  • DirX
  • DirX Access
    • 9.1
  • DirX Audit
    • 9.1
    • 9.0
    • 7.2
  • DirX Directory
    • 10.0
    • 9.1
  • DirX Directory Manager
    • 3.3.0
  • DirX Identity
    • 9.0.2
    • 8.10.16
Home
  • DirX Directory
  • REST API
  • Open API Reference
10.0 9.1

Open API Reference

Restrictions Preface

DirX is a registered trademark © Copyright ${currentyear}, Atos Group – All rights reserved.

The UI for this site is derived from the Antora default UI and is licensed under the MPL-2.0 license. Several icons used are provided by Google and are licensed under the Apache License Version 2.0.