Template Management: Authorized SSID

SSIDs are a set of unique tokens that identify 802.11 wireless network. Wireless network devices use SSIDs to gain information about the network and establish a wireless connectivity. SSIDs can be authorized in various ways. SSID help to provide limited access to some guest users and on the other hand also provide access to secure data to some of the authorised users. This is specific to some of the authorised users. You need proper credentials to log in. If the client device meets the security configurations on the AP for that specific SSID, it is then allowed to join the network.

API Calls

/V5/templates/AUTHORIZED_SSID

/V5/templates/{templateId}/AUTHORIZED_SSID

/V5/templates

/V5/templates/copy/{templateid}/AUTHORIZED_SSID

<Base_URL>/V2/analytics/associationdata/{startdate}/{enddate}

/V5/templates

/V5/templates/{templateId}/AUTHORIZED_SSID

Get All Authorized SSID

Description Fetches the primary information about all authorized SSID templates
for the specified location.
Who Can Execute? Superuser, Administrator, Operator, and Viewer.
Syntax
GET <Base_URL>/templates/AUTHORIZED_SSID?locationid=<value>&
minimalinforequired =<value>&fields=<value>&filter=<value>&fetchSubTreeTemplates=<value>
  • locationid

    Is used to specify location Id for which information is requested. It takes an integer
    value. To retrieve the value for location id refer Location call.

  • minimalinforequired

    Is used to retrieve minimal information. For false all attributes are populated
    else minimal information is retrieved. It takes a boolean value. It is a mandatory attribute.

  • fields

    List of selective fields which will be returned in the response. It takes String value.

  • filter

    An optional parameter to filter the results. Click Filter to view details of how filters need to be specified in the URL. For possible names of property attribute, datatypes, applicable values, and whether the results can be sorted based on the parameter click Authorized SSID Filter.

  • fetchSubTreeTemplates

    If set to true, templates created above, at and below the given location will be returned. If false, only templates created above and at the given location will be returned. It takes a boolean value.

Sample code
GET https://training.mojonetworks.com/new/webservice/V5/templates/AUTHORIZED_SSID?
locationid=1&minimalinforequired=true
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains the detailed information about all authorized SSID profiles for the specified location. The response is in
the application/json format.

Get Details of an Authorized SSID

Description Fetches the complete details of an authorized SSID.
Who Can Execute? Superuser, Administrator, Operator, and Viewer.
Syntax
GET <Base_URL>/templates/{templateId}/AUTHORIZED_SSID?locationid=<value>&fields=<value>
  • templateid

    It is Id to identify the template. It takes an integer value.

  • locationid

    Is used to specify location Id for which information is requested.
    It takes an integer value. To retrieve the value for location id refer Location call.

  • fields

    List of selective fields which will be returned in the response. It takes String value.

Sample code
GET https://training.mojonetworks.com/new/webservice/V5/templates/1/AUTHORIZED_SSID?
locationid=0
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains detailed information of the specified authorized SSID.
The response is in the application/json format.

Add an Authorized  SSID

Description Adds a template at the specified location.
Who Can Execute? Superuser, Administrator, and Operator.
Syntax
PUT <Base_URL>/templates?locationid=<value>
  • locationid

    The value for the locationid parameter specifies the location at which the
    template must be added. The parameter value is specified in the application/json format.
    To retrieve the value for location id refer Location call.

Sample code
PUT https://training.mojonetworks.com/new/webservice/V5/templates?locationid=1
Request Body This API call requires the details of the Authorized SSID. You must provide the appropriate
values for the following mandatory attributes:

  • type
  • templateName
  • ssid

A sample request body is as follows:

{
        "type": "authssid",
        "templateName": "test ssid",
        "ssid": "test ssid"
}
Response Body If the API call is successful, the HTTP response status is 200. The response body contains details of the
newly created authorized SSID. The response is in the application/json format.

Copy an Authorized SSID

Description Copies an authorized SSID template at the specified location.
Who Can Execute? Superuser, Administrator, and Operator.
Syntax
PUT <Base_URL>/templates/copy/{templateid}/AUTHORIZED_SSID?locationid=<value>&
nodeid=<value>
  • templateid

    Is the ID of the template. It takes an integer value.

  • locationid

    This takes an integer value specifying the location at which the template exists.
    To retrieve the value for location id refer Location call.

  • nodeid

    This takes an integer value specifying the node in a cluster deployment on which the location exists.

Sample code
PUT https://training.mojonetworks.com/new/webservice/V5/templates/copy/0/AUTHORIZED_SSID?
locationid=0&nodeid=1
Request Body This API call requires the details of the location to which the Authorized SSID must be copied.
The destination location information is passed as parameters in the request body.
The parameters are passed in the application/json format. You must provide
appropriate values for the childId JSON attribute in the case of a cluster deployment.
A sample request body is as follows:

{

  "type": "locallocationid",
  "id": 2

}
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains detailed information of the copied Authorized SSID.
The response is in the application/json format.

Put APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.

User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.

Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Edit an Authorized SSID

Description Modifies the details of the specified authorized SSID template.
Who Can Execute? Superuser, Administrator, and Operator.
Syntax
PPOST <Base_URL>/templates
Sample code
POST https://training.mojonetworks.com/new/webservice/V5/templates
Request Body This API call requires the details of the Authorized SSID to be modified, which is passed as
parameters in the request body. The templateId attribute is generated by the system when you
add a template. To modify the template, you must provide the same system-generated
template ID. You must provide the appropriate values for the following attributes:

  • type
  • templateName
  • createdAtLocationId
  • templateId
  • ssid

A sample request body is as follows:

 {
    "type": "authssid",
    "templateId": 44,
    "templateName": "test ssid",
    "createdAtLocationId": {
        "type": "locallocationid",
        "id": 2
    },
    "ssid": "test ssid"
}
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains modified authorized SSID details. The response is in
the application/json format.

Delete an  Authorized SSID

Description Deletes the specified authorized SSID template.
Who Can Execute? Superuser, Administrator, and Operator.
Syntax
DELETE <Base_URL>/templates/{templateId}/AUTHORIZED_SSID?locationid=<value>
  • templateid

    It is id to identify the template. It takes an integer value.

  • locationid

    Is used to specify location Id for which information is requested.
    It takes an integer value. To retrieve the value for location id refer Location call.

Sample code
DELETE https://training.mojonetworks.com/new/webservice/V5/templates/1/AUTHORIZED_SSID?
locationid=1
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 204.
The response body does not contain any other information.

Test APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.

User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.

Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.
JSON Table

Attribute Data Type Description
type String Template type. Expected value is authssid.
templateId int System generated value to identify the template.
templateName String Name of the template.
createdAtLocationId application/json ID of location at which the template is created. The value is of the
type Location
ID
JSON.
description String Description of the template.
templateType String Template type. The applicable value is AUTHORIZED_SSID
mncTemplateId int System-generated ID of the template provided via the parent server to
the child server.
ssid String The SSID profile
allowedSecuritySetting String List of allowed security settings. Applicable values are OPEN, WEP,
WPA, DOT_11i, and ANY
allowedAuthFramework String List of authorization framework. Applicable values are PSK, ONE_X, and
ANY
allowedAuthType String List of authorization types. Applicable values are PEAP, EAP_TLS, LEAP,
EAP_TTLS, EAP_FAST, EAP_SIM, and ANY
allowedNetworkProtocol String List of network protocols. Applicable values are A, B, G, and ANY
allowedEncryptionProtocol String List of encryption protocols. Applicable values are WEP40, WEP104, TKIP,
CCMP, and ANY
allowedApCapability String List of AP capability. Applicable values are DOT11n, TURBO, SUPER_AG,
and ANY
mfpSettings String List of MFP settings. Applicable values are ENABLED, DISABLED, and ANY
allowedVendorList List of allowed vendors
allowedNetworkList List of allowed networks
appliedAtCurrentLocation
guest boolean True indicates this is a guest SSID
mnctemplate boolean True indicates this has been pushed by the parent server

Sample JSON
[
    {
        "type": "authssid",
        "templateId": 2,
        "templateName": "DocTest 1",
        "createdAtLocationId": {
            "type": "locallocationid",
            "id": 1
        },
        "description": "Doc Test",
        "templateType": "AUTHORIZED_SSID",
        "mncTemplateId": 0,
        "ssid": "FeFiFoFum",
        "ssidProfileId": 0,
        "allowedSecuritySetting": [
            "ANY"
        ],
        "allowedAuthFramework": [
            "ANY"
        ],
        "allowedAuthType": [
            "ANY"
        ],
        "allowedNetworkProtocol": [
            "ANY"
        ],
        "allowedEncryptionProtocol": [
            "ANY"
        ],
        "allowedApCapability": [
            "ANY"
        ],
        "mfpSettings": [
            "ENABLED",
            "ANY",
            "DISABLED"
        ],
        "allowedVendorList": null,
        "allowedNetworkList": null,
        "appliedAtCurrentLocation": false,
        "guest": false,
        "mnctemplate": false
    },
    {
        "type": "authssid",
        "templateId": 3,
        "templateName": "DocSample_authwlan",
        "createdAtLocationId": {
            "type": "locallocationid",
            "id": 0
        },
        "description": "WEBAPI",
        "templateType": "AUTHORIZED_SSID",
        "mncTemplateId": 0,
        "ssid": "DocSample",
        "ssidProfileId": 0,
        "allowedSecuritySetting": [
            "WPA",
            "DOT_11i"
        ],
        "allowedAuthFramework": [
            "PSK"
        ],
        "allowedAuthType": [
            "ANY"
        ],
        "allowedNetworkProtocol": [
            "ANY"
        ],
        "allowedEncryptionProtocol": [
            "CCMP",
            "TKIP"
        ],
        "allowedApCapability": [
            "ANY"
        ],
        "mfpSettings": [
            "ENABLED",
            "ANY",
            "DISABLED"
        ],
        "allowedVendorList": null,
        "allowedNetworkList": null,
        "appliedAtCurrentLocation": false,
        "guest": false,
        "mnctemplate": false
    },
    {
        "type": "authssid",
        "templateId": 5,
        "templateName": "EnterpriseWiFi_authwlan",
        "createdAtLocationId": {
            "type": "locallocationid",
            "id": 0
        },
        "description": "WEBAPI",
        "templateType": "AUTHORIZED_SSID",
        "mncTemplateId": 0,
        "ssid": "EnterpriseWiFi",
        "ssidProfileId": 0,
        "allowedSecuritySetting": [
            "WPA",
            "DOT_11i"
        ],
        "allowedAuthFramework": [
            "PSK"
        ],
        "allowedAuthType": [
            "ANY"
        ],
        "allowedNetworkProtocol": [
            "ANY"
        ],
        "allowedEncryptionProtocol": [
            "CCMP",
            "TKIP"
        ],
        "allowedApCapability": [
            "ANY"
        ],
        "mfpSettings": [
            "ENABLED",
            "ANY",
            "DISABLED"
        ],
        "allowedVendorList": null,
        "allowedNetworkList": null,
        "appliedAtCurrentLocation": false,
        "guest": false,
        "mnctemplate": false
    }
]