Table of Contents

Interface IOrganizations

Namespace
Meraki.Api.Interfaces.General.Organizations
Assembly
Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface IOrganizations
Extension Methods

Methods

ClaimIntoOrganizationAsync(string, OrganizationClaimRequest, CancellationToken)

Claim a list of devices, licenses, and/or orders into an organization inventory

[Post("/organizations/{organizationId}/claim")]
[Obsolete("Use ClaimIntoOrganizationInventoryAsync")]
Task<OrganizationClaimResponse> ClaimIntoOrganizationAsync(string organizationId, OrganizationClaimRequest organizationClaimRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

organizationClaimRequest OrganizationClaimRequest

Body for making a claim request

cancellationToken CancellationToken

Returns

Task<OrganizationClaimResponse>

Exceptions

ApiException

Thrown when fails to make API call

CloneOrganizationAsync(string, CloneOrganization, CancellationToken)

Create a new organization by cloning the addressed organization

[Post("/organizations/{organizationId}/clone")]
Task<Organization> CloneOrganizationAsync(string organizationId, CloneOrganization cloneOrganization, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

cloneOrganization CloneOrganization

Body for cloning an organization

cancellationToken CancellationToken

Returns

Task<Organization>

Exceptions

ApiException

Thrown when fails to make API call

CreateOrganizationAsync(OrganizationCreateRequest, CancellationToken)

Create a new organization

[Post("/organizations")]
Task<Organization> CreateOrganizationAsync(OrganizationCreateRequest createOrganization, CancellationToken cancellationToken = default)

Parameters

createOrganization OrganizationCreateRequest

Body for creating an organization

cancellationToken CancellationToken

Returns

Task<Organization>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationAsync(string, CancellationToken)

Delete an organization

[Delete("/organizations/{organizationId}")]
Task DeleteOrganizationAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationAsync(string, CancellationToken)

Return an organization

[Get("/organizations/{organizationId}")]
Task<Organization> GetOrganizationAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

cancellationToken CancellationToken

Returns

Task<Organization>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationsAsync(int?, string?, string?, CancellationToken)

List the organizations that the user has privileges on

[Get("/organizations")]
Task<List<Organization>> GetOrganizationsAsync(int? perPage = 9000, string? startingAfter = null, string? endingBefore = null, CancellationToken cancellationToken = default)

Parameters

perPage int?

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

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<List<Organization>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationAsync(string, OrganizationUpdateRequest, CancellationToken)

Update an organization

[Put("/organizations/{organizationId}")]
Task<Organization> UpdateOrganizationAsync(string organizationId, OrganizationUpdateRequest updateOrganization, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

updateOrganization OrganizationUpdateRequest

Body for updating an organization

cancellationToken CancellationToken

Returns

Task<Organization>

Exceptions

ApiException

Thrown when fails to make API call

Edit this page