Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Credentials configuration guidelines can be found here.

Ldap LDAP Identity Connector's Credentials type must always be specified as "ldap-identity".

Properties specific to the Ldap LDAP Identity Connector's Credentials are described below.

Easy Heading Free
navigationTitleOn this Page
wrapNavigationTexttrue
navigationExpandOptionexpand-all-by-default

{
    "type": "ldap-identity",
    "description": "<Connector Name> Credential",
    "properties": {
        "authenticationType": "SIMPLE",
        "user": "cn=Directory Manager",
        "password": ""
    }
}

Create Credential


Field

Required

Default

Multiple

NotesExample
typeYes-No

The value must be "".

"ldap-identity"

descriptionYes-NoName of the credential object.

"Ldap IdentityCredential"

propertiesYes-NoConfiguration object
AuthenticationYesSimpleYesType of authentication to use against the LDAP serverSimple or Digest (MD5)
UsernameYes-NoCould be a distinguished name for an LDAP server, or a domain\\user for ActiveDirectory."cn=Directory Manager"
PasswordYes-NoPassword for the account."Twj0u4sp5mgf8Q90xftpm62BHT="

Example

Code Block
themeRDark
titlePOST aspire/_api/credentials
{
	"id": "2a5ca234-e328-4d40-bb2a-2df3e550b065",
	"type": "ldap-identity",
	"description": "Ldap Identity Credentials Test",
	"properties": {
		"authenticationType": "SIMPLE",
		"user": "cn=Directory Manager",
		"password": "encrypted:8DBA..."
	}
}