Interface INetworksMerakiAuthUsers

Namespace

Meraki.Api.Interfaces.General.Networks

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface INetworksMerakiAuthUsers

Methods

CreateNetworkMerakiAuthUserAsync(string, MerakiAuthUserCreateUpdateRequest, CancellationToken)

Authorize a user configured with Meraki Authentication for a network

[Post("/networks/{networkId}/merakiAuthUsers")]
Task<MerakiAuthUser> CreateNetworkMerakiAuthUserAsync(string networkId, MerakiAuthUserCreateUpdateRequest merakiAuthUser, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

merakiAuthUser MerakiAuthUserCreateUpdateRequest

Body for authorizing a meraki user

cancellationToken CancellationToken

Returns

Task<MerakiAuthUser>

Exceptions

ApiException

Thrown when fails to make API call

DeleteNetworkMerakiAuthUserAsync(string, string, bool, CancellationToken)

Deauthorize a user

[Delete("/networks/{networkId}/merakiAuthUsers/{merakiAuthUserId}")]
Task DeleteNetworkMerakiAuthUserAsync(string networkId, string merakiAuthUserId, bool delete, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

merakiAuthUserId string

The meraki user id

delete bool

If the ID supplied is for a splash guest or client VPN user, and that user is not authorized for any other networks in the organization, then also delete the user. 802.1X RADIUS users are always deleted regardless of this optional attribute.

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkMerakiAuthUserAsync(string, string, CancellationToken)

Return the Meraki Auth splash guest, RADIUS, or client VPN user

[Get("/networks/{networkId}/merakiAuthUsers/{merakiAuthUserId}")]
Task<MerakiAuthUser> GetNetworkMerakiAuthUserAsync(string networkId, string merakiAuthUserId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

merakiAuthUserId string

The meraki user id

cancellationToken CancellationToken

Returns

Task<MerakiAuthUser>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkMerakiAuthUsersAsync(string, CancellationToken)

List the users configured under Meraki Authentication for a network

[Get("/networks/{networkId}/merakiAuthUsers")]
Task<List<MerakiAuthUser>> GetNetworkMerakiAuthUsersAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

Returns

Task<List<MerakiAuthUser>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkMerakiAuthUserAsync(string, string, MerakiAuthUserCreateUpdateRequest, CancellationToken)

Update a user configured with Meraki Authentication

[Put("/networks/{networkId}/merakiAuthUsers/{merakiAuthUserId}")]
Task<MerakiAuthUser> UpdateNetworkMerakiAuthUserAsync(string networkId, string merakiAuthUserId, MerakiAuthUserCreateUpdateRequest merakiAuthUser, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

merakiAuthUserId string

The meraki user id

merakiAuthUser MerakiAuthUserCreateUpdateRequest

Body for updating a user

cancellationToken CancellationToken

Returns

Task<MerakiAuthUser>

Exceptions

ApiException

Thrown when fails to make API call