Allows management of the SAML Service Providers. API Reference

Allows the management of the SAML Service Providers.

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

Paths

SamlServiceProvider

Returns a list of all Service Providers.

GET /api/saml/serviceproviders

Returns a list of all Service Providers.

200 OK
IQueryable

The list of Service Providers.

type
IQueryable
401 Unauthorized

The user is not authorized to access this operation.

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

Save a Service Provider.

POST /api/saml/serviceproviders

Saves a new Service Provider with the model information provided.

AddEditSamlServiceProviderViewModel

The service provider to save.

Request Example
{
  "SamlServiceProviderId": "integer",
  "Name": "string",
  "ServiceProviderName": "string"
}
200 OK
SamlServiceProviderCollectionItemModel

The service provider model that was saved.

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

Return a Service Provider.

GET /api/saml/serviceproviders/{samlserviceproviderid}

Returns a Service Provider by it's ID.

samlserviceproviderid: integer
in path

The ID of the Service Provider to return.

200 OK
AddEditSamlServiceProviderViewModel

The Service Provider model.

401 Unauthorized

The user is not authorized to access this operation.

Response Example (200 OK) 
{
  "SamlServiceProviderId": "integer",
  "Name": "string",
  "ServiceProviderName": "string"
}
SamlServiceProvider

Delete a Service Provider.

DELETE /api/saml/serviceproviders/{samlserviceproviderid}

Deletes a Service Provider with the given ID.

samlserviceproviderid: integer
in path

The ID of the service provider to delete.

200 OK

The service provider model that was saved.

SamlServiceProvider

Download the Service Provider metadata.

GET /api/saml/serviceproviders/{samlserviceproviderid}/download

Download a Service Provider with the given ID.

samlserviceproviderid: integer
in path

The ID of the service provider to download.

200 OK
HttpResponseMessage

OK

Response Example (200 OK) 
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}

Schema Definitions

IQueryable: object

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

AddEditSamlServiceProviderViewModel: object

SamlServiceProviderId: integer
Name: string
ServiceProviderName: string
Example
{
  "SamlServiceProviderId": "integer",
  "Name": "string",
  "ServiceProviderName": "string"
}

SamlServiceProviderCollectionItemModel: object

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

IHttpActionResult: object

Example
"object"

HttpResponseMessage: object

Version: string
Content: string
StatusCode: string
ReasonPhrase: string
Headers: string
RequestMessage: string
IsSuccessStatusCode: boolean
Example
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}
Documentation by Spectacle