Interface IOrganizationsPolicyObjectsGroups

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

public interface IOrganizationsPolicyObjectsGroups

Extension Methods

IOrganizationsPolicyObjectsGroupsExtensions.GetOrganizationPolicyObjectsGroupsAllAsync(IOrganizationsPolicyObjectsGroups, string, CancellationToken)

Methods

CreateOrganizationPolicyObjectsGroupAsync(string, OrganizationPolicyObjectsGroupCreateRequest, CancellationToken)

Creates a new Policy Objects Group

[Post("/organizations/{organizationId}/policyObjects/groups")]
Task<OrganizationPolicyObjectsGroup> CreateOrganizationPolicyObjectsGroupAsync(string organizationId, OrganizationPolicyObjectsGroupCreateRequest organizationPolicyObjectsGroupCreateRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

organizationPolicyObjectsGroupCreateRequest OrganizationPolicyObjectsGroupCreateRequest

The body for the creation request

cancellationToken CancellationToken

Cancellation Token

Returns

Task<OrganizationPolicyObjectsGroup>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationPolicyObjectsGroupAsync(string, string, CancellationToken)

Deletes a Policy Object

[Delete("/organizations/{organizationId}/policyObjects/groups/{policyObjectGroupId}")]
Task DeleteOrganizationPolicyObjectsGroupAsync(string organizationId, string policyObjectGroupId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

policyObjectGroupId string

The policy object id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationPolicyObjectsGroupAsync(string, string, CancellationToken)

Shows details of a Policy Object Group.

[Get("/organizations/{organizationId}/policyObjects/groups/{policyObjectGroupId}")]
Task<OrganizationPolicyObjectsGroup> GetOrganizationPolicyObjectsGroupAsync(string organizationId, string policyObjectGroupId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

policyObjectGroupId string

The policy object id

cancellationToken CancellationToken

Cancellation Token

Returns

Task<OrganizationPolicyObjectsGroup>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationPolicyObjectsGroupsAsync(string, int?, string?, string?, CancellationToken)

Lists Policy Object Groups belonging to the organization.

[Get("/organizations/{organizationId}/policyObjects/groups")]
Task<List<OrganizationPolicyObjectsGroup>> GetOrganizationPolicyObjectsGroupsAsync(string organizationId, int? perPage = 1000, 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<OrganizationPolicyObjectsGroup>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationPolicyObjectsGroupAsync(string, string, OrganizationPolicyObjectsGroupUpdateRequest, CancellationToken)

Update Organization Policy Objects Group

[Put("/organizations/{organizationId}/policyObjects/groups/{policyObjectGroupId}")]
Task<OrganizationPolicyObjectsGroup> UpdateOrganizationPolicyObjectsGroupAsync(string organizationId, string policyObjectGroupId, OrganizationPolicyObjectsGroupUpdateRequest organizationPolicyObjectsGroupUpdateRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

policyObjectGroupId string

The id of the policy objects group

organizationPolicyObjectsGroupUpdateRequest OrganizationPolicyObjectsGroupUpdateRequest

The body for the update request

cancellationToken CancellationToken

Cancellation Token

Returns

Task<OrganizationPolicyObjectsGroup>

Exceptions

ApiException

Thrown when fails to make API call