authentication.get

Description

object authentication.get(object **parameters**)

The method allows to retrieve authentication object according to the given parameters.

This method is only available to Super admin user type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object) Parameters defining the desired output.

The method supports only one parameter.

ParameterTypeDescription
outputqueryThis parameter being common for all get methods described in the reference commentary.

Return values

(object) Returns authentication object.

Examples

Request:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "authentication.get",
  4.     "params": {
  5.         "output": "extend"
  6.     },
  7.     "auth": "038e1d7b1735c6a5436ee9eae095879e",
  8.     "id": 1
  9. }

Response:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": {
  4.         "authentication_type": "0",
  5.         "http_auth_enabled": "0",
  6.         "http_login_form": "0",
  7.         "http_strip_domains": "",
  8.         "http_case_sensitive": "1",
  9.         "ldap_configured": "0",
  10.         "ldap_host": "",
  11.         "ldap_port": "389",
  12.         "ldap_base_dn": "",
  13.         "ldap_search_attribute": "",
  14.         "ldap_bind_dn": "",
  15.         "ldap_case_sensitive": "1",
  16.         "ldap_bind_password": "",
  17.         "saml_auth_enabled": "0",
  18.         "saml_idp_entityid": "",
  19.         "saml_sso_url": "",
  20.         "saml_slo_url": "",
  21.         "saml_username_attribute": "",
  22.         "saml_sp_entityid": "",
  23.         "saml_nameid_format": "",
  24.         "saml_sign_messages": "0",
  25.         "saml_sign_assertions": "0",
  26.         "saml_sign_authn_requests": "0",
  27.         "saml_sign_logout_requests": "0",
  28.         "saml_sign_logout_responses": "0",
  29.         "saml_encrypt_nameid": "0",
  30.         "saml_encrypt_assertions": "0",
  31.         "saml_case_sensitive": "0"
  32.     },
  33.     "id": 1
  34. }

Source

CAuthentication::get() in ui/include/classes/api/services/CAuthentication.php.