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

Update authentication profile configuration.

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

Authentication profile to be used for Central NAC.

Authentication profile defines the authentication method, authentication sources, and additional attributes used to authenticate users on the associated networks.

Authentication profiles must be configured with default query parameters.

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

Unique immutable identifier for 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

wired-profile
object

Configuration for an authentication profile when supporting a wired network.

The wired field must be true, and the auth-type must be CAPTIVE_PORTAL, to configure a wired-profile.

eap
object

Unified Endpoint Management(UEM) profile top level grouping

mpsk
object

MPSK profile.

mab
object

MAC authentication bypass profile.

captive-portal
object

Captive network configuration

airpass-profile
object

Air Pass enables seamless cellular roaming to enterprise networks.
Air Pass profiles can be configured to use SIM based or OpenRoaming workflows for Central NAC.

Air Pass profiles must be configured with default query parameters.

default-policy
object

Default policy to apply to Central NAC captive portal network sessions.

The auth-type must be CAPTIVE_PORTAL to configure a default-policy.

string
length ≤ 9999

Unique immutable identifier for auth profile.

string
enum
required

Type of authentication method to determine profile configuration.

Allowed:
string
length between 0 and 255
boolean
Defaults to false

Indicate if Wi-Fi Easy Connect (DPP) is supported on this network.

identity-stores
array of strings
length ≤ 2147483647
identity-stores
string
required
length between 1 and 255

Name of authentication profile.

networks
array of strings
length ≤ 2147483647
networks
string
length ≤ 9999

Organization name used for provisioning in onboarding workflows.

string
length ≤ 9999

Reference to the portal profile that defines the required web portal customizations.

boolean
Defaults to false

Indicate if auth profile applies to wired profiles.

When wired is true, and auth-type is CAPTIVE_PORTAL, a wired-profile must also be configured.

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