Interface IOrganizationsSamlRoles

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface IOrganizationsSamlRoles

Methods

CreateOrganizationSamlRoleAsync(string, SamlRoleCreateRequest, CancellationToken)

Create a SAML role

[Post("/organizations/{organizationId}/samlRoles")]
Task<SamlRole> CreateOrganizationSamlRoleAsync(string organizationId, SamlRoleCreateRequest createOrganizationSamlRole, CancellationToken cancellationToken)

Parameters

organizationId string

The organization id

createOrganizationSamlRole SamlRoleCreateRequest

Body for creating a SAML role

cancellationToken CancellationToken

Cancellation token

Returns

Task<SamlRole>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationSamlRoleAsync(string, string, CancellationToken)

Remove a SAML role

[Delete("/organizations/{organizationId}/samlRoles/{samlRoleId}")]
Task DeleteOrganizationSamlRoleAsync(string organizationId, string samlRoleId, CancellationToken cancellationToken)

Parameters

organizationId string

The organization id

samlRoleId string

The SAML role id

cancellationToken CancellationToken

Cancellation token

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationSamlRoleAsync(string, string, CancellationToken)

Return a SAML role

[Get("/organizations/{organizationId}/samlRoles/{samlRoleId}")]
Task<SamlRole> GetOrganizationSamlRoleAsync(string organizationId, string samlRoleId, CancellationToken cancellationToken)

Parameters

organizationId string

The organization id

samlRoleId string

The SAML role id

cancellationToken CancellationToken

Cancellation token

Returns

Task<SamlRole>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationSamlRolesAsync(string, CancellationToken)

List the SAML roles for this organization

[Get("/organizations/{organizationId}/samlRoles")]
Task<List<SamlRole>> GetOrganizationSamlRolesAsync(string organizationId, CancellationToken cancellationToken)

Parameters

organizationId string

The organization id

cancellationToken CancellationToken

Cancellation token

Returns

Task<List<SamlRole>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationSamlRoleAsync(string, string, SamlRoleUpdateRequest, CancellationToken)

Update a SAML role

[Put("/organizations/{organizationId}/samlRoles/{samlRoleId}")]
Task<SamlRole> UpdateOrganizationSamlRoleAsync(string organizationId, string samlRoleId, SamlRoleUpdateRequest updateOrganizationSamlRole, CancellationToken cancellationToken)

Parameters

organizationId string

The organization id

samlRoleId string

The SAML role id

updateOrganizationSamlRole SamlRoleUpdateRequest

Body for updating a SAML role

cancellationToken CancellationToken

Cancellation token

Returns

Task<SamlRole>

Exceptions

ApiException

Thrown when fails to make API call