forked from randallknutson/services
-
Notifications
You must be signed in to change notification settings - Fork 1
/
services.authentication.api.php
38 lines (34 loc) · 1.41 KB
/
services.authentication.api.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<?php
/**
* @file
* Hooks provided by Services for the definition of authentication plugins.
*/
/**
* @addtogroup hooks
* @{
*/
/**
* Supplies information about a given authentication method to Services.
*
* @return
* An associative array with information about the authentication method
* and its callbacks. The possible keys are as follows (all keys are
* optional unless noted).
*
* - title (required): The display name for this authentication method.
* - description (required): Longer text describing this authentciation
* method.
* - authenticate_call (required): The name of a function to be called
* to perform the actual authentication. <details of params/return>
* - security_settings: A callback function which returns an associative
* array of Form API elements for a settings form.
* - _services_oauth_security_settings_validate: The name of a standard form
* validation callback for the form defined in 'security_settings'.
* - _services_oauth_security_settings_submit: The name of a standard form
* submit callback for the form defined in 'security_settings'.
* - alter_methods: The name of a callback function which will alter a
* services method signature in order to add required arguments.
* - file: An include file which contains the authentication callbacks.
*/
function hook_services_authentication_info() {
}