1- <!DOCTYPE html>
2- < html >
3- < head >
4- < meta charset ="utf-8 ">
5- < meta name ="viewport " content ="width=device-width, initial-scale=1.0 ">
6- < title >
7- Module: OmniAuth
8-
9- — Documentation by YARD 0.9.37
10-
11- </ title >
12-
13- < link rel ="stylesheet " href ="css/style.css " type ="text/css " />
14-
15- < link rel ="stylesheet " href ="css/common.css " type ="text/css " />
16-
17- < script type ="text/javascript ">
18- pathId = "OmniAuth" ;
19- relpath = '' ;
20- </ script >
21-
22-
23- < script type ="text/javascript " charset ="utf-8 " src ="js/jquery.js "> </ script >
24-
25- < script type ="text/javascript " charset ="utf-8 " src ="js/app.js "> </ script >
26-
27-
28- </ head >
29- < body >
30- < div class ="nav_wrap ">
31- < iframe id ="nav " src ="class_list.html?1 "> </ iframe >
32- < div id ="resizer "> </ div >
33- </ div >
34-
35- < div id ="main " tabindex ="-1 ">
36- < div id ="header ">
37- < div id ="menu ">
38-
39- < a href ="_index.html "> Index (O)</ a > »
40-
41-
42- < span class ="title "> OmniAuth</ span >
43-
44- </ div >
45-
46- < div id ="search ">
47-
48- < a class ="full_list_link " id ="class_list_link "
49- href ="class_list.html ">
50-
51- < svg width ="24 " height ="24 ">
52- < rect x ="0 " y ="4 " width ="24 " height ="4 " rx ="1 " ry ="1 "> </ rect >
53- < rect x ="0 " y ="12 " width ="24 " height ="4 " rx ="1 " ry ="1 "> </ rect >
54- < rect x ="0 " y ="20 " width ="24 " height ="4 " rx ="1 " ry ="1 "> </ rect >
55- </ svg >
56- </ a >
57-
58- </ div >
59- < div class ="clear "> </ div >
60- </ div >
61-
62- < div id ="content "> < h1 > Module: OmniAuth
63-
64-
65-
66- </ h1 >
67- < div class ="box_info ">
68-
69-
70-
71-
72-
73-
74-
75-
76-
77-
78-
79- < dl >
80- < dt > Defined in:</ dt >
81- < dd > lib/omniauth/strategies/ldap.rb< span class ="defines "> ,< br />
82- lib/omniauth-ldap/adaptor.rb,< br /> lib/omniauth-ldap/version.rb</ span >
83- </ dd >
84- </ dl >
85-
86- </ div >
87-
88- < h2 > Overview</ h2 > < div class ="docstring ">
89- < div class ="discussion ">
90- < p > OmniAuth strategies namespace.</ p >
91-
92- < p > This file implements an LDAP authentication strategy for OmniAuth.< br />
93- It provides both an interactive request phase (login form) and a< br />
94- callback phase which binds to an LDAP directory to authenticate the< br />
95- user or performs a lookup for header-based SSO.</ p >
96-
97- < p > The strategy exposes a number of options (see < code > option</ code > calls below)< br />
98- that control LDAP connection, mapping of LDAP attributes to the< br />
99- OmniAuth < code > info</ code > hash, header-based SSO behavior, and SSL/timeouts.</ p >
100-
101-
102- </ div >
103- </ div >
104- < div class ="tags ">
105-
106- < div class ="examples ">
107- < h4 class ="tag_title "> Examples:</ h4 >
108-
109-
110- < h5 class ="example_title "> < div class ='inline '> < p > Minimal Rack mounting</ p >
111- </ div > </ h5 >
112-
113- < pre class ="example code "> < code > < span class ='id identifier rubyid_use '> use</ span > < span class ='const '> OmniAuth</ span > < span class ='op '> ::</ span > < span class ='const '> Builder</ span > < span class ='kw '> do</ span >
114- < span class ='id identifier rubyid_provider '> provider</ span > < span class ='symbol '> :ldap</ span > < span class ='comma '> ,</ span > < span class ='lbrace '> {</ span >
115- < span class ='label '> host:</ span > < span class ='tstring '> < span class ='tstring_beg '> '</ span > < span class ='tstring_content '> ldap.example.com</ span > < span class ='tstring_end '> '</ span > </ span > < span class ='comma '> ,</ span >
116- < span class ='label '> base:</ span > < span class ='tstring '> < span class ='tstring_beg '> '</ span > < span class ='tstring_content '> dc=example,dc=com</ span > < span class ='tstring_end '> '</ span > </ span >
117- < span class ='rbrace '> }</ span >
118- < span class ='kw '> end</ span > </ code > </ pre >
119-
120- </ div >
121-
122-
123- </ div > < h2 > Defined Under Namespace</ h2 >
124- < p class ="children ">
125-
126-
127- < strong class ="modules "> Modules:</ strong > < span class ='object_link '> < a href ="OmniAuth/LDAP.html " title ="OmniAuth::LDAP (module) "> LDAP</ a > </ span > , < span class ='object_link '> < a href ="OmniAuth/Strategies.html " title ="OmniAuth::Strategies (module) "> Strategies</ a > </ span >
128-
129-
130-
131-
132- </ p >
133-
134-
135-
136-
137-
138-
139-
140-
141-
142- </ div >
143-
144- < div id ="footer ">
145- Generated on Mon Nov 10 14:11:47 2025 by
146- < a href ="https://yardoc.org " title ="Yay! A Ruby Documentation Tool " target ="_parent "> yard</ a >
147- 0.9.37 (ruby-3.4.7).
148- </ div >
149-
150- </ div >
151- </ body >
152- </ html >
0 commit comments