Active Directory Integration

Escape Characters with Active Directory Integration Guide

The Active Directory Integration (ADI) tool allows you to transfer users and groups from your Active Directory (AD) into the KnowBe4 training console. 

Organizational Units (OU) and security groups within AD can use any character set, but some of these character sets require special accommodation. 

Click the drop-down arrow next to the title of each column in the table for more information about the table. 

Note: All of the information in this article has been validated as of ADI Sync version 1.0.20.

Table Information

  • Character: This column lists the characters used within an OU. If a character isn’t listed, it is understood to be anywhere within the name of the OU.
  • Escape Sequence Syntax: This column lists the sequences required to escape the character in an OU.
  • Example: This column provides an example for reference.

Character Escape Table

Character

Escape Sequence Syntax 

Example 

Angle brackets (<>)

Add double backslash before the angle bracket.

">Foo<Bar" becomes "\\>Foo\\<Bar"

Backslash (\)

Switch to single quotes and add a backslash after the original backslash.

"Foo\Bar" becomes 'Foo\\Bar'

Comma (,)

Add double backslash before the comma.

",Foo, Bar" becomes "\\,Foo\\, Bar"

Equals sign (=)

Add double backslash in front of the equal sign.

"=Foo=Bar" becomes "\\=Foo\\=Bar"

Forward slash (/)

Switch to single quotes and add a backslash before the forward slash.

"Foo/Bar" becomes 'Foo\/Bar'

Number sign aka Hashtag (#) at the beginning of an OU

Add double backslash in front of the hashtag at the beginning of an OU name.

"#FooBar" becomes "\\#FooBar"

International Letters (á)

Add single quotes around the entry containing international letters.

“FooBár” becomes ‘FooBár’

Plus sign (+)

Add double backslash in front of the plus sign.

"+Foo+Bar" becomes "\\+Foo\\+Bar"

Semicolon (;)

Add double backslash in front of the semicolon.

";Foo;Bar" becomes "\\;Foo\\;Bar"

Characters Not Requiring Escape Table

Character

Example

Ampersand (&)

"&Foo&Bar" stays "&Foo&Bar"

Asterisk (*)

"*Foo*Bar" stays "*Foo*Bar"

At symbol (@) 

"Foo @Bar" stays "Foo @Bar"

Caret (^)

"Foo^Bar" stays "Foo^Bar"

Colon (:)

":Foo:Bar" stays ":Foo:Bar" 

Curly brackets ({})

"{Foo}Bar" stays "{Foo}Bar" 

Dollar sign ($)

"$Foo$ Bar" stays "$Foo$ Bar" 

Grave accent (`)

"Foo`Bar" stays "Foo`Bar" 

Hyphen (-)

"Foo-Bar" stays "Foo-Bar"

Number sign aka Hashtag (#) elsewhere in an OU

"Foo#Bar" stays "Foo#Bar"

Parenthesis ()

"Foo(doo)Bar" stays "Foo(doo)Bar"

Percent sign (%)

"Foo%Bar" stays "Foo%Bar"

Period (.)

".Foo.Bar." stays ".Foo.Bar."

Question mark (?)

"?Foo?Bar" stays "?Foo?Bar" 

Square brackets ([])

"[Foo]Bar" stays "[Foo]Bar" 

Tilde (~)

"~Foo~Bar" stays "~Foo~Bar"

Underscore (_)

"_Foo_Bar" stays "_Foo_Bar"

Vertical bar (|)

"|Foo|Bar" stays "|Foo|Bar" 

Can't find what you're looking for?

Contact Support