Interface IOrganizationsAdmins

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

Admins interface

public interface IOrganizationsAdmins

Methods

CreateOrganizationAdminAsync(string, AdminCreationRequest, CancellationToken)

Create a new dashboard administrator

[Post("/organizations/{organizationId}/admins")]
Task<Admin> CreateOrganizationAdminAsync(string organizationId, AdminCreationRequest createOrganizationAdmin, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

createOrganizationAdmin AdminCreationRequest

Body for creating organization admin

cancellationToken CancellationToken

Returns

Task<Admin>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationAdminAsync(string, string, CancellationToken)

Revoke all access for a dashboard administrator within this organization

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

Parameters

organizationId string

The organization id

adminId string

The admin id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationAdminsAsync(string, CancellationToken)

List the dashboard administrators in this organization.

[Get("/organizations/{organizationId}/admins")]
Task<List<Admin>> GetOrganizationAdminsAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

cancellationToken CancellationToken

Returns

Task<List<Admin>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationAdminAsync(string, string, AdminUpdateRequest, CancellationToken)

Update an administrator

[Put("/organizations/{organizationId}/admins/{adminId}")]
Task<Admin> UpdateOrganizationAdminAsync(string organizationId, string adminId, AdminUpdateRequest adminUpdateRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

adminId string

The admin id

adminUpdateRequest AdminUpdateRequest

Body for updating admin

cancellationToken CancellationToken

Returns

Task<Admin>

Exceptions

ApiException

Thrown when fails to make API call