MerakiAuthUsersApi
MerakiAuthUsersApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- createNetworkMerakiAuthUser() : object
- Operation createNetworkMerakiAuthUser
- createNetworkMerakiAuthUserAsync() : PromiseInterface
- Operation createNetworkMerakiAuthUserAsync
- createNetworkMerakiAuthUserAsyncWithHttpInfo() : PromiseInterface
- Operation createNetworkMerakiAuthUserAsyncWithHttpInfo
- createNetworkMerakiAuthUserWithHttpInfo() : array<string|int, mixed>
- Operation createNetworkMerakiAuthUserWithHttpInfo
- deleteNetworkMerakiAuthUser() : void
- Operation deleteNetworkMerakiAuthUser
- deleteNetworkMerakiAuthUserAsync() : PromiseInterface
- Operation deleteNetworkMerakiAuthUserAsync
- deleteNetworkMerakiAuthUserAsyncWithHttpInfo() : PromiseInterface
- Operation deleteNetworkMerakiAuthUserAsyncWithHttpInfo
- deleteNetworkMerakiAuthUserWithHttpInfo() : array<string|int, mixed>
- Operation deleteNetworkMerakiAuthUserWithHttpInfo
- getConfig() : Configuration
- getNetworkMerakiAuthUser() : object
- Operation getNetworkMerakiAuthUser
- getNetworkMerakiAuthUserAsync() : PromiseInterface
- Operation getNetworkMerakiAuthUserAsync
- getNetworkMerakiAuthUserAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkMerakiAuthUserAsyncWithHttpInfo
- getNetworkMerakiAuthUsers() : object
- Operation getNetworkMerakiAuthUsers
- getNetworkMerakiAuthUsersAsync() : PromiseInterface
- Operation getNetworkMerakiAuthUsersAsync
- getNetworkMerakiAuthUsersAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkMerakiAuthUsersAsyncWithHttpInfo
- getNetworkMerakiAuthUsersWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkMerakiAuthUsersWithHttpInfo
- getNetworkMerakiAuthUserWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkMerakiAuthUserWithHttpInfo
- updateNetworkMerakiAuthUser() : object
- Operation updateNetworkMerakiAuthUser
- updateNetworkMerakiAuthUserAsync() : PromiseInterface
- Operation updateNetworkMerakiAuthUserAsync
- updateNetworkMerakiAuthUserAsyncWithHttpInfo() : PromiseInterface
- Operation updateNetworkMerakiAuthUserAsyncWithHttpInfo
- updateNetworkMerakiAuthUserWithHttpInfo() : array<string|int, mixed>
- Operation updateNetworkMerakiAuthUserWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- createNetworkMerakiAuthUserRequest() : Request
- Create request for operation 'createNetworkMerakiAuthUser'
- deleteNetworkMerakiAuthUserRequest() : Request
- Create request for operation 'deleteNetworkMerakiAuthUser'
- getNetworkMerakiAuthUserRequest() : Request
- Create request for operation 'getNetworkMerakiAuthUser'
- getNetworkMerakiAuthUsersRequest() : Request
- Create request for operation 'getNetworkMerakiAuthUsers'
- updateNetworkMerakiAuthUserRequest() : Request
- Create request for operation 'updateNetworkMerakiAuthUser'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
Return values
mixed —createNetworkMerakiAuthUser()
Operation createNetworkMerakiAuthUser
public
createNetworkMerakiAuthUser(string $network_id, CreateNetworkMerakiAuthUser $create_network_meraki_auth_user) : object
Authorize a user configured with Meraki Authentication for a network (currently supports 802.1X, splash guest, and client VPN users, and currently, organizations have a 50,000 user cap)
Parameters
- $network_id : string
-
network_id (required)
- $create_network_meraki_auth_user : CreateNetworkMerakiAuthUser
-
create_network_meraki_auth_user (required)
Tags
Return values
object —createNetworkMerakiAuthUserAsync()
Operation createNetworkMerakiAuthUserAsync
public
createNetworkMerakiAuthUserAsync(string $network_id, CreateNetworkMerakiAuthUser $create_network_meraki_auth_user) : PromiseInterface
Authorize a user configured with Meraki Authentication for a network (currently supports 802.1X, splash guest, and client VPN users, and currently, organizations have a 50,000 user cap)
Parameters
- $network_id : string
-
(required)
- $create_network_meraki_auth_user : CreateNetworkMerakiAuthUser
-
(required)
Tags
Return values
PromiseInterface —createNetworkMerakiAuthUserAsyncWithHttpInfo()
Operation createNetworkMerakiAuthUserAsyncWithHttpInfo
public
createNetworkMerakiAuthUserAsyncWithHttpInfo(string $network_id, CreateNetworkMerakiAuthUser $create_network_meraki_auth_user) : PromiseInterface
Authorize a user configured with Meraki Authentication for a network (currently supports 802.1X, splash guest, and client VPN users, and currently, organizations have a 50,000 user cap)
Parameters
- $network_id : string
-
(required)
- $create_network_meraki_auth_user : CreateNetworkMerakiAuthUser
-
(required)
Tags
Return values
PromiseInterface —createNetworkMerakiAuthUserWithHttpInfo()
Operation createNetworkMerakiAuthUserWithHttpInfo
public
createNetworkMerakiAuthUserWithHttpInfo(string $network_id, CreateNetworkMerakiAuthUser $create_network_meraki_auth_user) : array<string|int, mixed>
Authorize a user configured with Meraki Authentication for a network (currently supports 802.1X, splash guest, and client VPN users, and currently, organizations have a 50,000 user cap)
Parameters
- $network_id : string
-
(required)
- $create_network_meraki_auth_user : CreateNetworkMerakiAuthUser
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
deleteNetworkMerakiAuthUser()
Operation deleteNetworkMerakiAuthUser
public
deleteNetworkMerakiAuthUser(string $network_id, string $meraki_auth_user_id) : void
Deauthorize a user
Parameters
- $network_id : string
-
network_id (required)
- $meraki_auth_user_id : string
-
meraki_auth_user_id (required)
Tags
Return values
void —deleteNetworkMerakiAuthUserAsync()
Operation deleteNetworkMerakiAuthUserAsync
public
deleteNetworkMerakiAuthUserAsync(string $network_id, string $meraki_auth_user_id) : PromiseInterface
Deauthorize a user
Parameters
- $network_id : string
-
(required)
- $meraki_auth_user_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteNetworkMerakiAuthUserAsyncWithHttpInfo()
Operation deleteNetworkMerakiAuthUserAsyncWithHttpInfo
public
deleteNetworkMerakiAuthUserAsyncWithHttpInfo(string $network_id, string $meraki_auth_user_id) : PromiseInterface
Deauthorize a user
Parameters
- $network_id : string
-
(required)
- $meraki_auth_user_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteNetworkMerakiAuthUserWithHttpInfo()
Operation deleteNetworkMerakiAuthUserWithHttpInfo
public
deleteNetworkMerakiAuthUserWithHttpInfo(string $network_id, string $meraki_auth_user_id) : array<string|int, mixed>
Deauthorize a user
Parameters
- $network_id : string
-
(required)
- $meraki_auth_user_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getNetworkMerakiAuthUser()
Operation getNetworkMerakiAuthUser
public
getNetworkMerakiAuthUser(string $network_id, string $meraki_auth_user_id) : object
Return the Meraki Auth splash guest, RADIUS, or client VPN user
Parameters
- $network_id : string
-
network_id (required)
- $meraki_auth_user_id : string
-
meraki_auth_user_id (required)
Tags
Return values
object —getNetworkMerakiAuthUserAsync()
Operation getNetworkMerakiAuthUserAsync
public
getNetworkMerakiAuthUserAsync(string $network_id, string $meraki_auth_user_id) : PromiseInterface
Return the Meraki Auth splash guest, RADIUS, or client VPN user
Parameters
- $network_id : string
-
(required)
- $meraki_auth_user_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkMerakiAuthUserAsyncWithHttpInfo()
Operation getNetworkMerakiAuthUserAsyncWithHttpInfo
public
getNetworkMerakiAuthUserAsyncWithHttpInfo(string $network_id, string $meraki_auth_user_id) : PromiseInterface
Return the Meraki Auth splash guest, RADIUS, or client VPN user
Parameters
- $network_id : string
-
(required)
- $meraki_auth_user_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkMerakiAuthUsers()
Operation getNetworkMerakiAuthUsers
public
getNetworkMerakiAuthUsers(string $network_id) : object
List the users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a wired network)
Parameters
- $network_id : string
-
network_id (required)
Tags
Return values
object —getNetworkMerakiAuthUsersAsync()
Operation getNetworkMerakiAuthUsersAsync
public
getNetworkMerakiAuthUsersAsync(string $network_id) : PromiseInterface
List the users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a wired network)
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkMerakiAuthUsersAsyncWithHttpInfo()
Operation getNetworkMerakiAuthUsersAsyncWithHttpInfo
public
getNetworkMerakiAuthUsersAsyncWithHttpInfo(string $network_id) : PromiseInterface
List the users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a wired network)
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkMerakiAuthUsersWithHttpInfo()
Operation getNetworkMerakiAuthUsersWithHttpInfo
public
getNetworkMerakiAuthUsersWithHttpInfo(string $network_id) : array<string|int, mixed>
List the users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a wired network)
Parameters
- $network_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkMerakiAuthUserWithHttpInfo()
Operation getNetworkMerakiAuthUserWithHttpInfo
public
getNetworkMerakiAuthUserWithHttpInfo(string $network_id, string $meraki_auth_user_id) : array<string|int, mixed>
Return the Meraki Auth splash guest, RADIUS, or client VPN user
Parameters
- $network_id : string
-
(required)
- $meraki_auth_user_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateNetworkMerakiAuthUser()
Operation updateNetworkMerakiAuthUser
public
updateNetworkMerakiAuthUser(string $network_id, string $meraki_auth_user_id[, UpdateNetworkMerakiAuthUser $update_network_meraki_auth_user = null ]) : object
Update a user configured with Meraki Authentication (currently, 802.1X RADIUS, splash guest, and client VPN users can be updated)
Parameters
- $network_id : string
-
network_id (required)
- $meraki_auth_user_id : string
-
meraki_auth_user_id (required)
- $update_network_meraki_auth_user : UpdateNetworkMerakiAuthUser = null
-
update_network_meraki_auth_user (optional)
Tags
Return values
object —updateNetworkMerakiAuthUserAsync()
Operation updateNetworkMerakiAuthUserAsync
public
updateNetworkMerakiAuthUserAsync(string $network_id, string $meraki_auth_user_id[, UpdateNetworkMerakiAuthUser $update_network_meraki_auth_user = null ]) : PromiseInterface
Update a user configured with Meraki Authentication (currently, 802.1X RADIUS, splash guest, and client VPN users can be updated)
Parameters
- $network_id : string
-
(required)
- $meraki_auth_user_id : string
-
(required)
- $update_network_meraki_auth_user : UpdateNetworkMerakiAuthUser = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkMerakiAuthUserAsyncWithHttpInfo()
Operation updateNetworkMerakiAuthUserAsyncWithHttpInfo
public
updateNetworkMerakiAuthUserAsyncWithHttpInfo(string $network_id, string $meraki_auth_user_id[, UpdateNetworkMerakiAuthUser $update_network_meraki_auth_user = null ]) : PromiseInterface
Update a user configured with Meraki Authentication (currently, 802.1X RADIUS, splash guest, and client VPN users can be updated)
Parameters
- $network_id : string
-
(required)
- $meraki_auth_user_id : string
-
(required)
- $update_network_meraki_auth_user : UpdateNetworkMerakiAuthUser = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkMerakiAuthUserWithHttpInfo()
Operation updateNetworkMerakiAuthUserWithHttpInfo
public
updateNetworkMerakiAuthUserWithHttpInfo(string $network_id, string $meraki_auth_user_id[, UpdateNetworkMerakiAuthUser $update_network_meraki_auth_user = null ]) : array<string|int, mixed>
Update a user configured with Meraki Authentication (currently, 802.1X RADIUS, splash guest, and client VPN users can be updated)
Parameters
- $network_id : string
-
(required)
- $meraki_auth_user_id : string
-
(required)
- $update_network_meraki_auth_user : UpdateNetworkMerakiAuthUser = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options
createNetworkMerakiAuthUserRequest()
Create request for operation 'createNetworkMerakiAuthUser'
protected
createNetworkMerakiAuthUserRequest(string $network_id, CreateNetworkMerakiAuthUser $create_network_meraki_auth_user) : Request
Parameters
- $network_id : string
-
(required)
- $create_network_meraki_auth_user : CreateNetworkMerakiAuthUser
-
(required)
Tags
Return values
Request —deleteNetworkMerakiAuthUserRequest()
Create request for operation 'deleteNetworkMerakiAuthUser'
protected
deleteNetworkMerakiAuthUserRequest(string $network_id, string $meraki_auth_user_id) : Request
Parameters
- $network_id : string
-
(required)
- $meraki_auth_user_id : string
-
(required)
Tags
Return values
Request —getNetworkMerakiAuthUserRequest()
Create request for operation 'getNetworkMerakiAuthUser'
protected
getNetworkMerakiAuthUserRequest(string $network_id, string $meraki_auth_user_id) : Request
Parameters
- $network_id : string
-
(required)
- $meraki_auth_user_id : string
-
(required)
Tags
Return values
Request —getNetworkMerakiAuthUsersRequest()
Create request for operation 'getNetworkMerakiAuthUsers'
protected
getNetworkMerakiAuthUsersRequest(string $network_id) : Request
Parameters
- $network_id : string
-
(required)
Tags
Return values
Request —updateNetworkMerakiAuthUserRequest()
Create request for operation 'updateNetworkMerakiAuthUser'
protected
updateNetworkMerakiAuthUserRequest(string $network_id, string $meraki_auth_user_id[, UpdateNetworkMerakiAuthUser $update_network_meraki_auth_user = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $meraki_auth_user_id : string
-
(required)
- $update_network_meraki_auth_user : UpdateNetworkMerakiAuthUser = null
-
(optional)