Skip to content

Commit f4d0fe0

Browse files
author
Meraki
committed
API version 1.1.0-beta.1
1 parent 72d0a9f commit f4d0fe0

File tree

1 file changed

+109
-11
lines changed

1 file changed

+109
-11
lines changed

‎openapi/spec2.json

Lines changed: 109 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"swagger": "2.0",
33
"info": {
4-
"version": "1.1.0-beta.0",
4+
"version": "1.1.0-beta.1",
55
"title": "Meraki Dashboard API",
6-
"description": "The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification.\n\n> Date: 02 September, 2020\n>\n> [What's New](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n"
6+
"description": "The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification.\n\n> Date: 09 September, 2020\n>\n> [What's New](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n"
77
},
88
"host": "api.meraki.com",
99
"basePath": "/api/v1",
@@ -16520,7 +16520,7 @@
1652016520
]
1652116521
},
1652216522
"delete": {
16523-
"description": "Delete a user configured with Meraki Authentication (currently only 802.1X RADIUS users can be deleted)",
16523+
"description": "Delete a user configured with Meraki Authentication (currently, 802.1X RADIUS and Splash Guest users can be deleted)",
1652416524
"operationId": "deleteNetworkMerakiAuthUser",
1652516525
"parameters": [
1652616526
{
@@ -16541,15 +16541,15 @@
1654116541
"description": "Successful operation"
1654216542
}
1654316543
},
16544-
"summary": "Delete a user configured with Meraki Authentication (currently only 802.1X RADIUS users can be deleted)",
16544+
"summary": "Delete a user configured with Meraki Authentication (currently, 802.1X RADIUS and Splash Guest users can be deleted)",
1654516545
"tags": [
1654616546
"networks",
1654716547
"configure",
1654816548
"merakiAuthUsers"
1654916549
]
1655016550
},
1655116551
"put": {
16552-
"description": "Update a user configured with Meraki Authentication (currently only 802.1X RADIUS users can be updated)",
16552+
"description": "Update a user configured with Meraki Authentication (currently, 802.1X RADIUS and Splash Guest users can be updated)",
1655316553
"operationId": "updateNetworkMerakiAuthUser",
1655416554
"parameters": [
1655516555
{
@@ -16635,7 +16635,7 @@
1663516635
}
1663616636
}
1663716637
},
16638-
"summary": "Update a user configured with Meraki Authentication (currently only 802.1X RADIUS users can be updated)",
16638+
"summary": "Update a user configured with Meraki Authentication (currently, 802.1X RADIUS and Splash Guest users can be updated)",
1663916639
"tags": [
1664016640
"networks",
1664116641
"configure",
@@ -29552,7 +29552,20 @@
2955229552
"ssidNumber": 0,
2955329553
"splashPage": "Click-through splash page",
2955429554
"splashUrl": "https://www.custom_splash_url.com",
29555-
"useSplashUrl": true
29555+
"useSplashUrl": true,
29556+
"redirectUrl": "https://example.com",
29557+
"useRedirectUrl": true,
29558+
"welcomeMessage": "Welcome!",
29559+
"splashLogo": {
29560+
"md5": "abcd1234",
29561+
"extension": "jpg"
29562+
},
29563+
"splashImage": {
29564+
"md5": null
29565+
},
29566+
"splashPrepaidFront": {
29567+
"md5": null
29568+
}
2955629569
}
2955729570
}
2955829571
}
@@ -29595,11 +29608,83 @@
2959529608
"useSplashUrl": {
2959629609
"type": "boolean",
2959729610
"description": "[optional] Boolean indicating whether the users will be redirected to the custom splash url. A custom splash URL must be set if this is true. Note that depending on your SSID's access control settings, it may not be possible to use the custom splash URL."
29611+
},
29612+
"splashTimeout": {
29613+
"type": "integer",
29614+
"description": "Splash timeout in minutes. This will determine how often users will see the splash page."
29615+
},
29616+
"redirectUrl": {
29617+
"type": "string",
29618+
"description": "The custom redirect URL where the users will go after the splash page."
29619+
},
29620+
"useRedirectUrl": {
29621+
"type": "boolean",
29622+
"description": "The Boolean indicating whether the the user will be redirected to the custom redirect URL after the splash page. A custom redirect URL must be set if this is true."
29623+
},
29624+
"welcomeMessage": {
29625+
"type": "string",
29626+
"description": "The welcome message for the users on the splash page."
29627+
},
29628+
"splashLogo": {
29629+
"type": "object",
29630+
"properties": {
29631+
"md5": {
29632+
"type": "string",
29633+
"description": "The MD5 value of the logo file. Setting this to null will remove the logo from the splash page."
29634+
},
29635+
"extension": {
29636+
"type": "string",
29637+
"description": "The extension of the logo file."
29638+
}
29639+
},
29640+
"description": "The logo used in the splash page."
29641+
},
29642+
"splashImage": {
29643+
"type": "object",
29644+
"properties": {
29645+
"md5": {
29646+
"type": "string",
29647+
"description": "The MD5 value of the image file. Setting this to null will remove the image from the splash page."
29648+
},
29649+
"extension": {
29650+
"type": "string",
29651+
"description": "The extension of the image file."
29652+
}
29653+
},
29654+
"description": "The image used in the splash page."
29655+
},
29656+
"splashPrepaidFront": {
29657+
"type": "object",
29658+
"properties": {
29659+
"md5": {
29660+
"type": "string",
29661+
"description": "The MD5 value of the prepaid front image file. Setting this to null will remove the prepaid front from the splash page."
29662+
},
29663+
"extension": {
29664+
"type": "string",
29665+
"description": "The extension of the prepaid front image file."
29666+
}
29667+
},
29668+
"description": "The prepaid front image used in the splash page."
2959829669
}
2959929670
},
2960029671
"example": {
29672+
"splashPage": "Click-through splash page",
2960129673
"splashUrl": "https://www.custom_splash_url.com",
29602-
"useSplashUrl": true
29674+
"useSplashUrl": true,
29675+
"redirectUrl": "https://example.com",
29676+
"useRedirectUrl": true,
29677+
"welcomeMessage": "Welcome!",
29678+
"splashLogo": {
29679+
"md5": "abcd1234",
29680+
"extension": "jpg"
29681+
},
29682+
"splashImage": {
29683+
"md5": null
29684+
},
29685+
"splashPrepaidFront": {
29686+
"md5": null
29687+
}
2960329688
}
2960429689
}
2960529690
}
@@ -29615,7 +29700,20 @@
2961529700
"ssidNumber": 0,
2961629701
"splashPage": "Click-through splash page",
2961729702
"splashUrl": "https://www.custom_splash_url.com",
29618-
"useSplashUrl": true
29703+
"useSplashUrl": true,
29704+
"redirectUrl": "https://example.com",
29705+
"useRedirectUrl": true,
29706+
"welcomeMessage": "Welcome!",
29707+
"splashLogo": {
29708+
"md5": "abcd1234",
29709+
"extension": "jpg"
29710+
},
29711+
"splashImage": {
29712+
"md5": null
29713+
},
29714+
"splashPrepaidFront": {
29715+
"md5": null
29716+
}
2961929717
}
2962029718
}
2962129719
}
@@ -37490,13 +37588,13 @@
3749037588
},
3749137589
{
3749237590
"group": "Meraki auth user",
37493-
"summary": "Delete a user configured with Meraki Authentication (currently only 802.1X RADIUS users can be deleted)",
37591+
"summary": "Delete a user configured with Meraki Authentication (currently, 802.1X RADIUS and Splash Guest users can be deleted)",
3749437592
"resource": "/networks/{networkId}/merakiAuthUsers/{merakiAuthUserId}",
3749537593
"operation": "destroy"
3749637594
},
3749737595
{
3749837596
"group": "Meraki auth user",
37499-
"summary": "Update a user configured with Meraki Authentication (currently only 802.1X RADIUS users can be updated)",
37597+
"summary": "Update a user configured with Meraki Authentication (currently, 802.1X RADIUS and Splash Guest users can be updated)",
3750037598
"resource": "/networks/{networkId}/merakiAuthUsers/{merakiAuthUserId}",
3750137599
"operation": "update"
3750237600
},

0 commit comments

Comments
 (0)