Interface IOrganizationsSmAdmins

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

I Organizations Sm Admins

public interface IOrganizationsSmAdmins

Methods

CreateOrganizationSmAdminsRoleAsync(string, OrganizationSmAdminsRoleCreateRequest, CancellationToken)

Create a Limited Access Role

[Post("/organizations/{organizationId}/sm/admins/roles")]
Task<OrganizationSmAdminsRole> CreateOrganizationSmAdminsRoleAsync(string organizationId, OrganizationSmAdminsRoleCreateRequest organizationSmAdminsRole, CancellationToken cancellationToken = default)

Parameters

organizationId string

organizationSmAdminsRole OrganizationSmAdminsRoleCreateRequest

cancellationToken CancellationToken

Returns

Task<OrganizationSmAdminsRole>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationSmAdminsRoleAsync(string, string, CancellationToken)

Delete a Limited Access Role

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

Parameters

organizationId string

roleId string

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationSmAdminsRoleAsync(string, string, CancellationToken)

Return a Limited Access Role

[Get("/organizations/{organizationId}/sm/admins/roles/{roleId}")]
Task<OrganizationSmAdminsRole> GetOrganizationSmAdminsRoleAsync(string organizationId, string roleId, CancellationToken cancellationToken = default)

Parameters

organizationId string

roleId string

cancellationToken CancellationToken

Returns

Task<OrganizationSmAdminsRole>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationsSmAdminsRolesAsync(string, CancellationToken)

List the Limited Access Roles for an organization

[Get("/organizations/{organizationId}/sm/admins/roles")]
Task<OrganizationSmAdminsRolesResponse> GetOrganizationsSmAdminsRolesAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

cancellationToken CancellationToken

Returns

Task<OrganizationSmAdminsRolesResponse>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationSmAdminsRoleAsync(string, string, OrganizationSmAdminsRoleUpdateRequest, CancellationToken)

Update a Limited Access Role

[Put("/organizations/{organizationId}/sm/admins/roles/{roleId}")]
Task<OrganizationSmAdminsRole> UpdateOrganizationSmAdminsRoleAsync(string organizationId, string roleId, OrganizationSmAdminsRoleUpdateRequest organizationSmAdminsRole, CancellationToken cancellationToken = default)

Parameters

organizationId string

roleId string

organizationSmAdminsRole OrganizationSmAdminsRoleUpdateRequest

cancellationToken CancellationToken

Returns

Task<OrganizationSmAdminsRole>

Exceptions

ApiException

Thrown when fails to make API call