|
APIs in Category: Ldap |
API version 5.0 |
LdapServerAdd |
DFM LDAP related APIs To specify the configuration for authentication with LDAP servers. More than one LDAP server may be specified for redundancy. LDAP server is used for authentication of centralized users. For example: Consider the case where users are added in LDAP server and DFM is configured for authentication with the LDAP server. When a user tries To login To DFM UI To View Reports, the credentials of the user are checked with the LDAP server and if it matches only then will DFM allow the user To View the Reports. |
| LdapServerAdd (supported) | [top] |
Add LDAP server To DFM.
Input Name Type LdapServerAdd LdapServerAdd
Output Name Type LdapServerAddResult LdapServerAddResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUT
| LdapServerDelete (supported) | [top] |
Delete LDAP server From DFM.
Input Name Type LdapServerDelete LdapServerDelete
Output Name Type LdapServerDeleteResult LdapServerDeleteResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUT
| LdapServerListInfo (supported) | [top] |
Returns list of LDAP servers known To DFM.
Input Name Type LdapServerListInfo LdapServerListInfo
Output Name Type LdapServerListInfoResult LdapServerListInfoResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUT
| Element definition: LdapServerAdd | [top] |
Add LDAP server To DFM.
Name Type Description LdapServer LdapServer
IP Address and port details of LDAP server To be added To DFM.
| Element definition: LdapServerAddResult | [top] |
[none]
| Element definition: LdapServerDelete | [top] |
Delete LDAP server From DFM.
Name Type Description LdapServer LdapServer
IP Address and port details of an LDAP server in DFM To be deleted.
| Element definition: LdapServerDeleteResult | [top] |
[none]
| Element definition: LdapServerListInfo | [top] |
Returns list of LDAP servers known To DFM.
Name Type Description LdapServer LdapServer
optional
IP Address and port details of the LDAP server whose information will be listed. If no input was provided then all the LDAP server added in DFM will be listed.
| Element definition: LdapServerListInfoResult | [top] |
Name Type Description LdapServers ArrayOfLdapServerInfo
The list of LDAP servers.
| Element definition: ArrayOfLdapServerInfo | [top] |
Name Type Description LdapServerInfo LdapServerInfo[]
| Element definition: LdapServer | [top] |
Information of one LDAP server contains ip Address and port number. This uniquely identifies the LDAP server in DFM.
Name Type Description LdapServerAddr NetworkAddress
Address of the LDAP server. LdapServerPort xsd:integer
optional
Represents port number on which LDAP server will be listening. The default port number is 389. Range : [1..2^16-1]
| Element definition: LdapServerInfo | [top] |
Information of one LDAP server.
Name Type Description LastFailedTime Timestamp
optional
Represents the last time when DFM communication with LDAP server failed. Absent if DFM communication with LDAP server has not failed. LastUsedTime Timestamp
Represents the last time when LDAP server was used. LdapServer LdapServer
IP Address and port details of the LDAP server.
| Element definition: NetworkAddress | [top] |
IP Address of the network or Host
[none]
| Element definition: Timestamp | [top] |
Seconds since 1/1/1970 in UTC. Range: [0..2^31-1].
[none]