Legrand / Raritan Xerus™ JSON-RPC API for Remote Access Devices like KX4-101, KX3G2

Loading...
Searching...
No Matches
AuthManager.idl
1/* SPDX-License-Identifier: BSD-3-Clause */
2/*
3 * Copyright 2010 Raritan Inc. All rights reserved.
4 */
5
6/** Local and Remote Authentication Management */
7module auth {
8
9 /** Authentication type */
10 enumeration Type {
11 LOCAL, ///< local authentication
12 RADIUS, ///< authentication via radius server
13 KERBEROS, ///< authentication with kerberos tickets (not implemented)
14 TACACS_PLUS, ///< authentication via TACACS+ (not implemented)
15 LDAP, ///< authentication via LDAP server
16 CC ///< cc authentication
17 };
18
19 /** Authentication policy */
20 structure Policy {
21 auth.Type type; ///< Authentication type
22 boolean useLocalIfRemoteFailed; ///< Fall back to local authentication if remote authentication fails
23 };
24
25 /** Authentication manager interface */
26 interface AuthManager {
27
28 constant int ERR_UNSUPPORTED_TYPE = 1; ///< Unsupported authentication type
29
30 /**
31 * Gets a policy.
32 *
33 * @return a Policy object
34 */
35 Policy getPolicy();
36
37 /**
38 * Sets a policy.
39 *
40 * @return 0 on success
41 * @return 1 in case authentication type is not supported
42 */
43 int setPolicy(in Policy p);
44
45 };
46
47}
auth::AuthManager
Authentication manager interface.
Definition AuthManager.idl:26
auth::AuthManager::getPolicy
Policy getPolicy()
Gets a policy.
auth::AuthManager::ERR_UNSUPPORTED_TYPE
constant int ERR_UNSUPPORTED_TYPE
Unsupported authentication type.
Definition AuthManager.idl:28
auth::AuthManager::setPolicy
int setPolicy(in Policy p)
Sets a policy.
auth
Local and Remote Authentication Management.
Definition AuthManager.idl:7
auth::Type
Type
Authentication type.
Definition AuthManager.idl:10
auth::KERBEROS
@ KERBEROS
authentication with kerberos tickets (not implemented)
Definition AuthManager.idl:13
auth::TACACS_PLUS
@ TACACS_PLUS
authentication via TACACS+ (not implemented)
Definition AuthManager.idl:14
auth::RADIUS
@ RADIUS
authentication via radius server
Definition AuthManager.idl:12
auth::LOCAL
@ LOCAL
local authentication
Definition AuthManager.idl:11
auth::LDAP
@ LDAP
authentication via LDAP server
Definition AuthManager.idl:15
auth::CC
@ CC
cc authentication
Definition AuthManager.idl:16
auth::Policy
Authentication policy.
Definition AuthManager.idl:20
auth::Policy::type
auth::Type type
Authentication type.
Definition AuthManager.idl:21
auth::Policy::useLocalIfRemoteFailed
boolean useLocalIfRemoteFailed
Fall back to local authentication if remote authentication fails.
Definition AuthManager.idl:22