API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference
GithubAirheads Developer Community

Update an existing MAC authentication profile

patch
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/macauth/

List of MAC Auth profiles.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

Name of the MAC Auth profile.

Query Params
string

LOCAL - To update local objects. SHARED - To update shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be updated. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be updated. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilebody object

int32
1 to 256
Defaults to 1

Maximum number of authenticated mac addresses that can be allowed on the interface.

string
enum
Defaults to NONE

The MAC address format to be used in the RADIUS
request messages for authentication.

Show Details
COLON XX:XX:XX:XX:XX:XX
COMMAXX,XX,XX,XX,XX,XX
DASHXX-XX-XX-XX-XX-XX
NONEXXXXXXXXXXXX
OUI_NICXXXXXX-XXXXXX
PERCENTXX%XX%XX%XX%XX%XX
SLASHXX/XX/XX/XX/XX/XX
Allowed:
int32
1 to 4094

Configures the VLAN where the port is moved after a successful
authentication.

boolean
Defaults to false

Enable cached re-authentication.

int64
1 to 4294967295

Time period (in seconds) during which cached re-authentication
is allowed. This is applicable only when cached-reauth is enabled.

string
enum
Defaults to LOWER

The case for MAC address format to be used in the
RADIUS request messages for authentication.

Show Details
LOWERLower Case
UPPERUpper Case
Allowed:
boolean
Defaults to false

Enable MAC authentication on a port.

boolean
Defaults to false

Enable enforced cached re-authentication.

int64
1 to 999999999
Defaults to 300

Time period (in seconds) after which a client will be considered
removed from the port for a lack of activity.

boolean
Defaults to false

Enable MAC pinning.

int32
0 to 10

Number of authentication attempts before authentication fails.

int32
0 to 65535

Time period (in seconds) to wait before processing an authentication
request from a client that failed authentication.

boolean
Defaults to false

Enable periodic re-authentication.

int64
0 to 4294967295

Time period (in seconds) to enforce periodic re-authentication of
clients. This is applicable only when reauth is enabled.

int32
1 to 300
Defaults to 300

Time period (in seconds) to wait for a server response to an
authentication request. If there is no response within the configured
time frame, the device assumes that the authentication attempt has
timed out.

int32
0 to 255
Defaults to 0

Time period (in seconds) to wait before moving the interface to the
VLAN for unauthenticated clients.

int32
1 to 4094

Configures the VLAN where the port is moved with an unauthenticated
client.

boolean
Defaults to false

Use Server provided Reauthentication interval.

string
length between 1 and 256

MAC Auth profile description.

string
length between 1 and 256

Name of the MAC Auth profile.

Responses

Updated 11 days ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago