Allows management of the SAML Identity Providers. API Reference

Allows the management of the SAML Identity Providers.

API Endpoint
https://app.memberzone.org
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0

Paths

SamlIdentityProvider

Returns a list of all Identity Providers.

GET /api/saml/identityproviders

Returns a list of all Identity Providers.

200 OK
IQueryable

The list of Identity Providers.

type
IQueryable
401 Unauthorized

The user is not authorized to access this operation.

Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
SamlIdentityProvider

Save an Identity Provider.

POST /api/saml/identityproviders

Saves a new Identity Provider with the model information provided.

AddEditSamlIdentityProviderViewModel

The identity provider to save.

Request Example
{
  "SamlIdentityProviderId": "integer",
  "Name": "string",
  "Label": "string",
  "ProviderSingleSignOnServiceUrl": "string",
  "ProviderSingleLogoutServiceUrl": "string",
  "UseCertificateForSigningAndEncryption": "boolean",
  "ProviderPartnerCertificate": "string",
  "ProviderPartnerSigningCertificate": "string",
  "ProviderPartnerEncryptionCertificate": "string",
  "ProviderSignatureMethod": "string",
  "ProviderSingleSignOnServiceBinding": "string",
  "ProviderSingleLogoutServiceBinding": "string",
  "ProviderNameIDFormat": "string",
  "ProviderSignAuthnRequest": "boolean",
  "ProviderSignLogoutRequest": "boolean",
  "ProviderSignLogoutResponse": "boolean",
  "ProviderWantSAMLResponseSigned": "boolean",
  "ProviderWantLogoutRequestSigned": "boolean",
  "ProviderWantLogoutResponseSigned": "boolean",
  "ProviderWantAssertionOrResponseSigned": "boolean",
  "ProviderWantAssertionSigned": "boolean",
  "ProviderWantAssertionEncrypted": "boolean",
  "ProviderDisableAuthnContextCheck": "boolean",
  "ProviderDisableDestinationCheck": "boolean",
  "ProviderDisableRecipientCheck": "boolean",
  "ContactMatching": "string"
}
200 OK
SamlIdentityProviderCollectionItemModel

The identity provider model that was saved.

Response Example (200 OK) 
{
  "SamlIdentityProviderId": "integer",
  "Name": "string",
  "Actions": "string"
}
SamlIdentityProvider

Return a Identity Provider.

GET /api/saml/identityproviders/{samlidentityproviderid}

Returns an Identity Provider by it's ID.

samlidentityproviderid: integer
in path

The ID of the Identity Provider to return.

200 OK
AddEditSamlIdentityProviderViewModel

The Identity Provider model.

401 Unauthorized

The user is not authorized to access this operation.

Response Example (200 OK) 
{
  "SamlIdentityProviderId": "integer",
  "Name": "string",
  "Label": "string",
  "ProviderSingleSignOnServiceUrl": "string",
  "ProviderSingleLogoutServiceUrl": "string",
  "UseCertificateForSigningAndEncryption": "boolean",
  "ProviderPartnerCertificate": "string",
  "ProviderPartnerSigningCertificate": "string",
  "ProviderPartnerEncryptionCertificate": "string",
  "ProviderSignatureMethod": "string",
  "ProviderSingleSignOnServiceBinding": "string",
  "ProviderSingleLogoutServiceBinding": "string",
  "ProviderNameIDFormat": "string",
  "ProviderSignAuthnRequest": "boolean",
  "ProviderSignLogoutRequest": "boolean",
  "ProviderSignLogoutResponse": "boolean",
  "ProviderWantSAMLResponseSigned": "boolean",
  "ProviderWantLogoutRequestSigned": "boolean",
  "ProviderWantLogoutResponseSigned": "boolean",
  "ProviderWantAssertionOrResponseSigned": "boolean",
  "ProviderWantAssertionSigned": "boolean",
  "ProviderWantAssertionEncrypted": "boolean",
  "ProviderDisableAuthnContextCheck": "boolean",
  "ProviderDisableDestinationCheck": "boolean",
  "ProviderDisableRecipientCheck": "boolean",
  "ContactMatching": "string"
}
SamlIdentityProvider

Delete an Identity Provider.

DELETE /api/saml/identityproviders/{samlidentityproviderid}

Deletes an Identity Provider with the given ID.

samlidentityproviderid: integer
in path

The ID of the identity provider to delete.

200 OK

The identity provider model that was saved.

SamlIdentityProvider

GET /api/saml/identityproviders/import

200 OK
ImportSamlIdentityProviderViewModel

OK

Response Example (200 OK) 
{
  "Name": "string",
  "MetadataUrl": "string"
}
SamlIdentityProvider

POST /api/saml/identityproviders/import

ImportSamlIdentityProviderViewModel

undefined

Request Example
{
  "Name": "string",
  "MetadataUrl": "string"
}
200 OK
SamlIdentityProviderCollectionItemModel

OK

Response Example (200 OK) 
{
  "SamlIdentityProviderId": "integer",
  "Name": "string",
  "Actions": "string"
}

Schema Definitions

IQueryable: object

Expression: string
ElementType: string
Provider: string
Example
{
  "Expression": "string",
  "ElementType": "string",
  "Provider": "string"
}

AddEditSamlIdentityProviderViewModel: object

SamlIdentityProviderId: integer
Name: string
Label: string
ProviderSingleSignOnServiceUrl: string
ProviderSingleLogoutServiceUrl: string
UseCertificateForSigningAndEncryption: boolean
ProviderPartnerCertificate: string
ProviderPartnerSigningCertificate: string
ProviderPartnerEncryptionCertificate: string
ProviderSignatureMethod: string
ProviderSingleSignOnServiceBinding: string
ProviderSingleLogoutServiceBinding: string
ProviderNameIDFormat: string
ProviderSignAuthnRequest: boolean
ProviderSignLogoutRequest: boolean
ProviderSignLogoutResponse: boolean
ProviderWantSAMLResponseSigned: boolean
ProviderWantLogoutRequestSigned: boolean
ProviderWantLogoutResponseSigned: boolean
ProviderWantAssertionOrResponseSigned: boolean
ProviderWantAssertionSigned: boolean
ProviderWantAssertionEncrypted: boolean
ProviderDisableAuthnContextCheck: boolean
ProviderDisableDestinationCheck: boolean
ProviderDisableRecipientCheck: boolean
ContactMatching: string
Example
{
  "SamlIdentityProviderId": "integer",
  "Name": "string",
  "Label": "string",
  "ProviderSingleSignOnServiceUrl": "string",
  "ProviderSingleLogoutServiceUrl": "string",
  "UseCertificateForSigningAndEncryption": "boolean",
  "ProviderPartnerCertificate": "string",
  "ProviderPartnerSigningCertificate": "string",
  "ProviderPartnerEncryptionCertificate": "string",
  "ProviderSignatureMethod": "string",
  "ProviderSingleSignOnServiceBinding": "string",
  "ProviderSingleLogoutServiceBinding": "string",
  "ProviderNameIDFormat": "string",
  "ProviderSignAuthnRequest": "boolean",
  "ProviderSignLogoutRequest": "boolean",
  "ProviderSignLogoutResponse": "boolean",
  "ProviderWantSAMLResponseSigned": "boolean",
  "ProviderWantLogoutRequestSigned": "boolean",
  "ProviderWantLogoutResponseSigned": "boolean",
  "ProviderWantAssertionOrResponseSigned": "boolean",
  "ProviderWantAssertionSigned": "boolean",
  "ProviderWantAssertionEncrypted": "boolean",
  "ProviderDisableAuthnContextCheck": "boolean",
  "ProviderDisableDestinationCheck": "boolean",
  "ProviderDisableRecipientCheck": "boolean",
  "ContactMatching": "string"
}

SamlIdentityProviderCollectionItemModel: object

SamlIdentityProviderId: integer
Name: string
Actions: string
Example
{
  "SamlIdentityProviderId": "integer",
  "Name": "string",
  "Actions": "string"
}

IHttpActionResult: object

Example
"object"

ImportSamlIdentityProviderViewModel: object

Name: string
MetadataUrl: string
Example
{
  "Name": "string",
  "MetadataUrl": "string"
}
Documentation by Spectacle