Interface IOrganizationsSamlIdp

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

public interface IOrganizationsSamlIdp

Methods

CreateOrganizationSamlIdpAsync(string, SamlIdpsCreateRequest, CancellationToken)

Create a SAML IdP for your organization.

[Post("/organizations/{organizationId}/saml/idps")]
Task<List<SamlIdp>> CreateOrganizationSamlIdpAsync(string organizationId, SamlIdpsCreateRequest createOrganizationSamlIdp, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

createOrganizationSamlIdp SamlIdpsCreateRequest

Body for creating a SAML IdP

cancellationToken CancellationToken

Returns

Task<List<SamlIdp>>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationSamlIdpAsync(string, string, CancellationToken)

Remove a SAML IdP in your organization.

[Delete("/organizations/{organizationId}/saml/idps/{idpId}")]
Task DeleteOrganizationSamlIdpAsync(string organizationId, string idpId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

idpId string

The IdP id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationSamlIdpAsync(string, string, CancellationToken)

Get a SAML IdP from your organization.

[Get("/organizations/{organizationId}/saml/idps/{idpId}")]
Task<SamlIdp> GetOrganizationSamlIdpAsync(string organizationId, string idpId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

idpId string

The IdP id

cancellationToken CancellationToken

Returns

Task<SamlIdp>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationSamlIdpsAsync(string, CancellationToken)

List the SAML IdPs in your organization.

[Get("/organizations/{organizationId}/saml/idps")]
Task<List<SamlIdp>> GetOrganizationSamlIdpsAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

cancellationToken CancellationToken

Returns

Task<List<SamlIdp>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationSamlIdpAsync(string, string, SamlIdpsCreateRequest, CancellationToken)

Update a SAML IdP in your organization

[Put("/organizations/{organizationId}/saml/idps/{idpId}")]
Task<List<SamlIdp>> UpdateOrganizationSamlIdpAsync(string organizationId, string idpId, SamlIdpsCreateRequest updateOrganizationSamlIdp, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

idpId string

The IdP id

updateOrganizationSamlIdp SamlIdpsCreateRequest

Body for updating a SAML IdP

cancellationToken CancellationToken

Returns

Task<List<SamlIdp>>

Exceptions

ApiException

Thrown when fails to make API call