Interface IOrganizationsBrandingPolicies

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

public interface IOrganizationsBrandingPolicies

Methods

CreateOrganizationBrandingPolicyAsync(string, BrandingPolicy, CancellationToken)

Add a new branding policy to an organization

[Post("/organizations/{organizationId}/brandingPolicies")]
Task<BrandingPolicy> CreateOrganizationBrandingPolicyAsync(string organizationId, BrandingPolicy brandingPolicy, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

brandingPolicy BrandingPolicy

Body for creating an organization's branding policy

cancellationToken CancellationToken

Returns

Task<BrandingPolicy>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationBrandingPolicyAsync(string, string, CancellationToken)

Delete a branding policy

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

Parameters

organizationId string

The organization id

brandingPolicyId string

The branding policy id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationBrandingPoliciesAsync(string, CancellationToken)

List the branding policies of an organization

[Get("/organizations/{organizationId}/brandingPolicies")]
Task<List<BrandingPolicy>> GetOrganizationBrandingPoliciesAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

cancellationToken CancellationToken

Returns

Task<List<BrandingPolicy>>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationBrandingPolicyAsync(string, string, CancellationToken)

Return a branding policy

[Get("/organizations/{organizationId}/brandingPolicies/{brandingPolicyId}")]
Task<BrandingPolicy> GetOrganizationBrandingPolicyAsync(string organizationId, string brandingPolicyId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

brandingPolicyId string

The branding policy id

cancellationToken CancellationToken

Returns

Task<BrandingPolicy>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationBrandingPolicyAsync(string, string, BrandingPolicy, CancellationToken)

Update a branding policy

[Put("/organizations/{organizationId}/brandingPolicies/{brandingPolicyId}")]
Task<BrandingPolicy> UpdateOrganizationBrandingPolicyAsync(string organizationId, string brandingPolicyId, BrandingPolicy brandingPolicy, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

brandingPolicyId string

brandingPolicy BrandingPolicy

Body for updating an organization's branding policy

cancellationToken CancellationToken

Returns

Task<BrandingPolicy>

Exceptions

ApiException

Thrown when fails to make API call