Create a Role and Assign it to a Site

1. Log in to the REST API server (api.ezcloudx.com) using administrator credentials. You must also forward the credentials with each API call. For an example of how to log in, see Log in to the REST API Server.
2. Verify that the role does not already exist by checking the list of current roles using the GET method:
   

   GET HTTP://ipAddress/v3/roles

3. Create the new role instance using the POST method:
   

   POST HTTP://ipAddress/v3/roles

   When you POST or PUT data to the REST API, at minimum set the Content-Type header to application/json. However, you should generally specify two headers when you post the log in request.

   Example:

   • 

     content-type: application/json ;charset=UTF-8
     

   • 

     accept: application/json, text/plain, */*

   Any of the following Accept headers are allowed with the Content-Type header request header:

   • accept: application/json
   • accept-encoding: gzip, deflate, br
   • accept-language: en-US,en;q=0.8,und;q=0.6
   

   Request Attributes

   Attribute	Data Type	Description
   cpAddApNameAndSerial	Boolean	A flag to indicate if the AP serial number and name should be added as a parameter for external captive portal (ECP) authentication.
   cpAddBssid	Boolean	A flag to indicate if the access point's BSSIDs should be added as a parameter for ECP authentication.
   cpAddIpAndPort	Boolean	A flag to indicate if IP address and port should be added as a parameter for ECP authentication.
   cpAddMac	Boolean	A flag to indicate if the client's MAC should be added as a parameter for ECP authentication.
   cpAddRole	Boolean	A flag to indicate if the current role assigned to the client should be added as a parameter for ECP authentication.
   cpAddSign	Boolean	A flag to indicate if the AWS Signature should be added as a parameter for ECP authentication.
   cpAddSsid	Boolean	A flag to indicate if SSID should be added as a parameter for ECP authentication.
   cpAddTime	Boolean	A flag to indicate if time should be added as a parameter for ECP authentication.
   cpAddVlan	Boolean	A flag to indicate if the current VLAN assigned to the client should be added as a parameter for ECP authentication.
   cpAddVnsName	Boolean	A flag to indicate if Virtual Network segment name should be added as a parameter for ECP authentication.
   cpDefaultRedirectUrl	String	The redirection URL to which the wireless device user will be directed to after authentication.
   cpHttp	Boolean	A flag to indicate if HTTP should be used.
   cpIdentity	String	The identity used by the ECP and AP redirecting station to identify each other. Validations: A not null and non-empty string, having maximum of 255 characters, if any of the filter rule has an action as 'FILTERACTION_REDIRECT'.
   cpRedirect	String	The URL of the captive portal login page.
   cpRedirectUrlSelect	RedirUrlSelect	The post-authentication URL selection.
   cpSharedKey	String	The shared secret (used with identity to sign and encrypt the redirection URL). It is a password that is common to both the controller and the external Web server if you want to encrypt the information passed between the controller and the external web server. Validations: A not null and non-empty string, between 8 and 64 characters, if any of the filter rules has an action as 'FILTERACTION_REDIRECT'.
   defaultAction	PolicyAccessControlAction	The default access control action to be applied when there are no policy rules or none of the rules match the frame. Validations: A not null and valid PolicyAccessControlAction value as a string.
   defaultCos	String	The class of service (CoS) to assign to a matching frame if the role has no rules, or none of the rules match the frame or if none of the rules that match the frame assign a CoS to the frame. Set this to null to indicate that no CoS will be applied to the frame. In that case the frame's QoS fields will not be remarked and the traffic will not be rate limited in either direction. Validations: A valid UUID of a CoS.
   features	Array of strings	A list of supported features.
   filters	Array of PolicyRuleElement filters	A list of rule filters associated with the role. More information about filters is available at: http://documentation.extremenetworks.com/extremecloud/rest_api/index.html
   name	String	The role name that is unique across the customer sites. Validations: A not null and non-empty string, between 1 to 255 characters. Valid character set: Alphanumeric and special characters, except semi-colon, colon, and ampersand.
   topology	String	If defaultAction == containToVlan, the topology must reference a defined topology. If defaultAction has any other value, the topology should be null and in any case it will be ignored/discarded. Validations: A valid UUID of a topology.

4. Assign the role to an existing site.
   

   PUT HTTP://ipAddress/v3/management/sites/siteID