Interface IOrganizationsPolicyObjects

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

public interface IOrganizationsPolicyObjects

Extension Methods

IOrganizationsPolicyObjectsExtensions.GetOrganizationPolicyObjectsAllAsync(IOrganizationsPolicyObjects, string, CancellationToken)

Methods

CreateOrganizationPolicyObjectAsync(string, OrganizationPolicyObjectCreateRequest, CancellationToken)

Creates a new Policy Object.

[Post("/organizations/{organizationId}/policyObjects")]
Task<OrganizationPolicyObject> CreateOrganizationPolicyObjectAsync(string organizationId, OrganizationPolicyObjectCreateRequest organizationPolicyObjectCreateRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

organizationPolicyObjectCreateRequest OrganizationPolicyObjectCreateRequest

The body for the creation request

cancellationToken CancellationToken

Cancellation Token

Returns

Task<OrganizationPolicyObject>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationPolicyObjectAsync(string, string, CancellationToken)

Deletes a Policy Object

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

Parameters

organizationId string

The organization id

policyObjectId string

The policy object id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationPolicyObjectAsync(string, string, CancellationToken)

Shows details of a Policy Object.

[Get("/organizations/{organizationId}/policyObjects/{policyObjectId}")]
Task<OrganizationPolicyObject> GetOrganizationPolicyObjectAsync(string organizationId, string policyObjectId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

policyObjectId string

The policy object id

cancellationToken CancellationToken

Cancellation Token

Returns

Task<OrganizationPolicyObject>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationPolicyObjectsAsync(string, int?, string?, string?, CancellationToken)

Lists Policy Objects belonging to the organization.

[Get("/organizations/{organizationId}/policyObjects")]
Task<List<OrganizationPolicyObject>> GetOrganizationPolicyObjectsAsync(string organizationId, int? perPage = 5000, string? startingAfter = null, string? endingBefore = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

perPage int?

TThe number of entries per page returned. Acceptable range is 10 - 5000. Default is 5000.

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

Cancellation Token

Returns

Task<List<OrganizationPolicyObject>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationPolicyObjectAsync(string, string, OrganizationPolicyObjectUpdateRequest, CancellationToken)

Updates a Policy Object.

[Put("/organizations/{organizationId}/policyObjects/{policyObjectId}")]
Task<OrganizationPolicyObject> UpdateOrganizationPolicyObjectAsync(string organizationId, string policyObjectId, OrganizationPolicyObjectUpdateRequest organizationPolicyObjectUpdateRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

policyObjectId string

The id of the policy object

organizationPolicyObjectUpdateRequest OrganizationPolicyObjectUpdateRequest

The body for the update request

cancellationToken CancellationToken

Cancellation Token

Returns

Task<OrganizationPolicyObject>

Exceptions

ApiException

Thrown when fails to make API call