com.quantum.dxi.rest.Security

Class LdapSettings

java.lang.Object

Base

com.quantum.dxi.rest.Security.LdapSettings

public class LdapSettings
extends Base

The LdapSettings resource represents the property settings for the Security LdapSettings feature. The LdapSettings service provides interfaces to get the LDAP settings, update the LDAP settings, and test the LDAP settings to see if they allow connectivity to the LDAP server.

The schema that defines the Veeam resource is defined below.

 
    <xs:element name="LdapSettings">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="LdapEnabled" type="xs:boolean" minOccurs="0"/>
                <xs:element name="PrimaryServer" type="xs:string" minOccurs="0"/>
                <xs:element name="AlternateServer" type="xs:string" minOccurs="0"/>
                <xs:element name="ProtocolType" type="xs:string" minOccurs="0"/>
                <xs:element name="Port" type="xs:int" minOccurs="0"/>
                <xs:element name="SchemaType" type="xs:string" minOccurs="0"/>
                <xs:element name="CaseSensitive" type="xs:boolean" minOccurs="0"/>
                <xs:element name="TestPwExpired" type="xs:boolean" minOccurs="0"/>
                <xs:element name="PwExpAttr" type="xs:string" minOccurs="0">
                <xs:element name="CaCertUrl" type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>
                            This field is used only for PUT.
                            This field may be a URL for a certificate to be downloaded from a server,
                            or the field may specify the name of a local file that was uploaded with POST rest/Upload.
                            The certificate must be PEM format.
                        </xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Principal" type="xs:string" minOccurs="0"/>
                <xs:element name="Password" type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Password is write only and is not returned by GET.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="UserDn" type="xs:string" minOccurs="0"/>
                <xs:element name="MonitorGroup" type="xs:string" minOccurs="0"/>
                <xs:element name="AdminGroup" type="xs:string" minOccurs="0"/>
                <xs:element name="RbacAdminGroup" type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>
                            Since 1.2.2
                        </xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="RbacOperatorGroup" type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>
                            Since 1.2.2
                        </xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Username" type="xs:string" minOccurs="0"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
LdapSettings()

Method Summary

Modifier and Type	Method and Description
com.quantum.dxi.dao.types.LdapSettings	getLdapSettingsXml(javax.servlet.http.HttpServletRequest request, String errorType) GET /rest/LdapSettings
com.quantum.dxi.dao.types.LdapSettings	setLdapSettings(javax.servlet.http.HttpServletRequest request, String actionString, com.quantum.dxi.dao.types.LdapSettings settings, String errorType) Deprecated. As of 1.1 POST /rest/LdapSettings @see #updateLdapSettings(HttpServletRequest, com.quantum.dxi.dao.types.LdapSettings, String) ?action=testLdapUser @see #testLdapUser(HttpServletRequest, com.quantum.dxi.dao.types.LdapSettings, String) ?action=testLdapSettings @see #testLdapSettings(HttpServletRequest, com.quantum.dxi.dao.types.LdapSettings, String)
void	testLdapSettings(javax.servlet.http.HttpServletRequest request, com.quantum.dxi.dao.types.LdapSettings settings, String errorType) POST /rest/LdapSettings/testLdapSettings
void	testLdapUser(javax.servlet.http.HttpServletRequest request, com.quantum.dxi.dao.types.LdapSettings settings, String errorType) POST /rest/LdapSettings/testLdapUser
com.quantum.dxi.dao.types.LdapSettings	updateLdapSettings(javax.servlet.http.HttpServletRequest request, com.quantum.dxi.dao.types.LdapSettings settings, String errorType) PUT /rest/LdapSettings

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LdapSettings

public LdapSettings()

Method Detail

getLdapSettingsXml

public com.quantum.dxi.dao.types.LdapSettings getLdapSettingsXml(@Context
                                                                 javax.servlet.http.HttpServletRequest request,
                                                                 String errorType)

GET /rest/LdapSettings

Get the LDAP configuration from the system.

Response Entity type: <xs:element name="LdapSettings">

testLdapUser

public void testLdapUser(@Context
                         javax.servlet.http.HttpServletRequest request,
                         com.quantum.dxi.dao.types.LdapSettings settings,
                         String errorType)

POST /rest/LdapSettings/testLdapUser

Validate the LDAP user.

Request Entity type: <xs:element name="LdapSettings">

Since:

1.1

testLdapSettings

public void testLdapSettings(@Context
                             javax.servlet.http.HttpServletRequest request,
                             com.quantum.dxi.dao.types.LdapSettings settings,
                             String errorType)

POST /rest/LdapSettings/testLdapSettings

Validate the LDAP settings, including the principal's credentials.

Request Entity type: <xs:element name="LdapSettings">

Since:

1.1

updateLdapSettings

public com.quantum.dxi.dao.types.LdapSettings updateLdapSettings(@Context
                                                                 javax.servlet.http.HttpServletRequest request,
                                                                 com.quantum.dxi.dao.types.LdapSettings settings,
                                                                 String errorType)

PUT /rest/LdapSettings

Update the LDAP settings on the system.

Request Entity type: <xs:element name="LdapSettings">

Response Entity type: <xs:element name="LdapSettings">

Since:

1.1

setLdapSettings

public com.quantum.dxi.dao.types.LdapSettings setLdapSettings(@Context
                                                              javax.servlet.http.HttpServletRequest request,
                                                              String actionString,
                                                              com.quantum.dxi.dao.types.LdapSettings settings,
                                                              String errorType)

Deprecated. As of 1.1
POST /rest/LdapSettings @see #updateLdapSettings(HttpServletRequest, com.quantum.dxi.dao.types.LdapSettings, String)
?action=testLdapUser @see #testLdapUser(HttpServletRequest, com.quantum.dxi.dao.types.LdapSettings, String)
?action=testLdapSettings @see #testLdapSettings(HttpServletRequest, com.quantum.dxi.dao.types.LdapSettings, String)

POST /rest/LdapSettings

Update the LDAP settings on the system, or perform an action related to the LDAP settings.

The action query parameter is optional.

Supported actions are:

• ?action=testLdapUser validate the LDAP user
• ?action=testLdapSettings validate the LDAP settings, including the principal's credentials

Request Entity type: <xs:element name="LdapSettings">

Response Entity type: <xs:element name="LdapSettings">