Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Calyptia saml_mapping API

The saml_mapping API from Calyptia — 2 operation(s) for saml_mapping.

Calyptia saml_mapping API is one of 41 APIs that Calyptia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include saml_mapping. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.0.4, at version 1.0.

Requests are made against 4 base URLs: https://cloud-api.calyptia.com, https://cloud-api-dev.calyptia.com, https://cloud-api-staging.calyptia.com, http://localhost:{port}.

4 operations 2 paths 8 schemas 1 DELETE1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
1.0
Base URL
https://cloud-api.calyptia.com
Authentication
HTTP Bearer, API Key, OAuth 2.0
Contact
Terms of Service
Resource Areas
1

Authentication & Security 3

Calyptia saml_mapping API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (user). An API key is passed in the header as X-Project-Token (project). It supports OAuth 2.0 (auth0) using the clientCredentials and authorizationCode flows.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

saml_mapping 4
GET
/v1/projects/{projectID}/saml_mappings
SAML Mappings
samlMappings 1 param → 200
POST
/v1/projects/{projectID}/saml_mappings
Create SAML Mapping
createSAMLMapping 1 param body → 201
PATCH
/v1/saml_mappings/{id}
Update SAML Mapping
updateSAMLMapping 1 param body → 200
DELETE
/v1/saml_mappings/{id}
Delete SAML Mapping
deleteSAMLMapping 1 param → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are SAMLMapping (7 properties), UpdateSAMLMapping (3 properties), SAMLMappings (3 properties), CreateSAMLMapping (3 properties). Each schema is shown below with its type and property counts.

Role
string
SAMLMapping
object
SAML Mapping required for IDP
7 properties 7 required
SAMLMappings
object
3 properties 3 required
Created
object
2 properties 2 required
UpdateSAMLMapping
object
SAML Mapping to update.
3 properties
Deleted
object
2 properties 2 required
Updated
object
1 property 1 required
CreateSAMLMapping
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calyptia-saml-mapping-api-openapi.yml Raw ↑

Other APIs Calyptia publishes across the network.

Calyptia agent API
Calyptia agent_config API
Calyptia agent_error API
Calyptia aggregator API
Calyptia audit_log API
Calyptia aws_marketplace API
Calyptia cluster_object API
Calyptia cluster_object_regex API
Calyptia config_section API
Calyptia config_validator API
Calyptia config_validator_v2 API
Calyptia core_instance API