Create a LDAP provider.

post

https://cluster.ip.address/irisservices/api/v1/public/ldapProvider

Privileges: AD_LDAP_MODIFY

Returns the created LDAP provider.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to configure a LDAP provider.

Specifies the configuration settings for an LDAP provider.

adDomainName

string | null

Specifies the domain name of an Active Directory which is mapped to this
LDAP provider

attributeCommonName

string | null

Name of the LDAP attribute used for common name of an object.

attributeGid

string | null

Name of the attribute used to lookup unix GID of an LDAP user.

attributeMemberOf

string | null

Name of the LDAP attribute used to lookup members of a group.

attributeUid

string | null

Name of the attribute used to lookup unix UID of an LDAP user.

attributeUserName

string | null

Name of the LDAP attribute used to lookup a user by user ID.

authType

string | null

enum

Specifies the authentication type used while connecting to LDAP servers.
Authentication level.
'kAnonymous' indicates LDAP authentication type 'Anonymous'
'kSimple' indicates LDAP authentication type 'Simple'

Allowed:

baseDistinguishedName

string | null

Specifies the base distinguished name used as the base for LDAP
search requests.

domainName

string | null

Specifies the name of the domain name to be used for querying LDAP servers
from DNS. If PreferredLdapServerList is set, then DomainName field is
ignored.

name

string | null

Specifies the name of the LDAP provider.

objectClassGroup

string | null

Name of the LDAP group object class for user accounts.

objectClassUser

string | null

Name of the LDAP user object class for user accounts.

port

int32 | null

Specifies LDAP server port.

preferredLdapServerList

array of strings | null

Specifies the preferred LDAP servers. Server names should be either in
fully qualified domain name (FQDN) format or IP addresses.

preferredLdapServerList

tenantId

string | null

Specifies the unique id of the tenant.

useSsl

boolean | null

Specifies whether to use SSL for LDAP connections.

userDistinguishedName

string | null

Specifies the user distinguished name that is used for LDAP authentication.
It should be provided if the AuthType is set to either kSimple or kSasl.

userPassword

string | null

Specifies the user password that is used for LDAP authentication.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Success

defaultError