v4

latestOpenAPI 3.0.1Apache 2.02026-08-036821,1001.5 MB
Configuration - Authentication

Create internal RADIUS server configuration

Create a new internal RADIUS server configuration.

post/radius-servers/internal

Request body

namestring required

The internal RADIUS server name

descriptionstring

The internal RADIUS server description

authentication_method_group'TLS_PEAP_TTLS_LEAP_MD5' | 'TLS_PEAP_TTLS_LEAP' | 'TLS_PEAP' | 'TLS_TTLS' | 'TLS' | 'LEAP' required

The authentication group

default_authentication_method'TLS' | 'PEAP' | 'TTLS' | 'LEAP' | 'MD5' required

The default authentication method

enable_verify_server_certboolean required

Enable verify server cert or not

server_key_passwordstring

password for server key

enable_check_cert_common_nameboolean required

Enable check cert common name or not

enable_check_user_for_tls_authboolean required

Enable check user for TLS auth or not

enable_check_user_for_peap_authboolean

Enable check user for PEAP auth or not, for Active Directory as the external user directory only

enable_check_user_for_ttls_authboolean

Enable check user for TTLS auth or not, for Active Directory as the external user directory only

enable_authentication_serverboolean required

Enable the RADIUS server as authentication or not

enable_radius_accounting_settingsboolean required

Enable the RADIUS server as accounting or not, must enable authentication server if want to enable accounting settings

authentication_server_portinteger

Port for the authentication, must enable authentication. Max:65535, Min:1

active_session_limitinteger

Active session limit, must enable accounting setting. Max:15, Min:0

active_session_age_timeoutinteger

Active session age timeout in seconds, must enable accounting setting. Max:300000000, Min:30

ca_certificate_idinteger required

The CA certificate ID, which could be fetched from endpoint: '/certificates' and pick up with type 'CA'

server_certificate_idinteger required

The Server certificate ID, which could be fetched from endpoint: '/certificates' and pick up with type 'CERT'

server_key_idinteger required

The Server key ID, which could be fetched from endpoint: '/certificates' and pick up with type 'KEY'

device_idsinteger[] required

The list of device ID associated with the internal RADIUS server

Example request

{
  "external_user_directory": {
    "user_group_attribute": "memberOf"
  }
}

Response

Created

idinteger required

The unique identifier

create_timestring date-time required

The create time in UTC (ISO 8601 format)

update_timestring date-time required

The last update time in UTC (ISO 8601 format)

org_idinteger

The organization identifier, valid when enabling HIQ feature

namestring required

The internal RADIUS server name

descriptionstring

The internal RADIUS server description

authentication_method_group'TLS_PEAP_TTLS_LEAP_MD5' | 'TLS_PEAP_TTLS_LEAP' | 'TLS_PEAP' | 'TLS_TTLS' | 'TLS' | 'LEAP' required

The authentication group

default_authentication_method'TLS' | 'PEAP' | 'TTLS' | 'LEAP' | 'MD5' required

The default authentication method

enable_verify_server_certboolean required

Enable verify server cert or not

server_key_passwordstring

password for server key

enable_check_cert_common_nameboolean required

Enable check cert common name or not

enable_check_user_for_tls_authboolean required

Enable check user for TLS auth or not

enable_check_user_for_peap_authboolean

Enable check user for PEAP auth or not, for Active Directory as the external user directory only

enable_check_user_for_ttls_authboolean

Enable check user for TTLS auth or not, for Active Directory as the external user directory only

enable_authentication_serverboolean required

Enable the RADIUS server as authentication or not

enable_radius_accounting_settingsboolean required

Enable the RADIUS server as accounting or not, must enable authentication server if want to enable accounting settings

authentication_server_portinteger required

Port for the authentication, must enable authentication. Max:65535, Min:1

active_session_limitinteger

Active session limit, must enable accounting setting. Max:15, Min:0

active_session_age_timeoutinteger

Active session age timeout in seconds, must enable accounting setting. Max:300000000, Min:0

ca_certificate_idinteger required

The CA certificate ID

server_certificate_idinteger required

The Server certificate ID

server_key_idinteger required

The Server key ID

device_idsinteger[] required

The list of device ID associated with the internal RADIUS server

Example response

{
  "external_user_directory": {
    "user_group_attribute": "memberOf"
  }
}