Interface IOrganizationsClients

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface IOrganizationsClients

Methods

GetOrganizationClientsSearchAsync(string, string, int, string?, string?, CancellationToken)

Return the client details in an organization

[Get("/organizations/{organizationId}/clients/search")]
Task<ClientSearchResult> GetOrganizationClientsSearchAsync(string organizationId, string mac, int perPage = 5, string? startingAfter = null, string? endingBefore = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

mac string

The MAC address of the client. Required.

perPage int

The number of entries per page returned. Acceptable range is 3 - 5. Default is 5.

startingAfter string

A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

endingBefore string

A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

cancellationToken CancellationToken

Returns

Task<ClientSearchResult>

Exceptions

ApiException

Thrown when fails to make API call