Interface ICameraRoles

Namespace

Meraki.Api.Interfaces.Products.Camera

Assembly

Meraki.Api.dll

public interface ICameraRoles

Methods

CreateOrganizationCameraRoleAsync(string, CameraRole, CancellationToken)

Creates new role for this organization.

[Post("/organizations/{organizationId}/camera/roles")]
Task<CameraRole> CreateOrganizationCameraRoleAsync(string organizationId, CameraRole cameraRole, CancellationToken cancellationToken = default)

Parameters

organizationId string

Organization ID

cameraRole CameraRole

Camera Role

cancellationToken CancellationToken

Returns

Task<CameraRole>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationCameraRoleAsync(string, string, CancellationToken)

Delete an existing role for this organization.

[Delete("/organizations/{organizationId}/camera/roles/{roleId}")]
Task DeleteOrganizationCameraRoleAsync(string organizationId, string roleId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

roleId string

The role id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationCameraRoleAsync(string, string, CancellationToken)

Retrieve a single role.

[Get("/organizations/{organizationId}/camera/roles/{roleId}")]
Task<CameraRole> GetOrganizationCameraRoleAsync(string organizationId, string roleId, CancellationToken cancellationToken = default)

Parameters

organizationId string

Organization ID

roleId string

Role ID

cancellationToken CancellationToken

Returns

Task<CameraRole>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationCameraRolesAsync(string, CancellationToken)

List all the roles in this organization

[Get("/organizations/{organizationId}/camera/roles")]
Task<List<CameraRole>> GetOrganizationCameraRolesAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

Organization ID

cancellationToken CancellationToken

Returns

Task<List<CameraRole>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationCameraRoleAsync(string, string, CameraRole, CancellationToken)

Update an existing role in this organization.

[Put("/organizations/{organizationId}/camera/roles/{roleId}")]
Task<CameraRole> UpdateOrganizationCameraRoleAsync(string organizationId, string roleId, CameraRole cameraRole, CancellationToken cancellationToken = default)

Parameters

organizationId string

Organization ID

roleId string

cameraRole CameraRole

Camera Role

cancellationToken CancellationToken

Returns

Task<CameraRole>

Exceptions

ApiException

Thrown when fails to make API call