SAML group

Matches a SAML group. Requires a SAML identity provider.

APIs.ioEngineeringPlatform

Properties

Name Type Description
saml object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-access-saml-group-rule-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/access_saml_group_rule",
  "title": "SAML group",
  "description": "Matches a SAML group.\nRequires a SAML identity provider.",
  "properties": {
    "saml": {
      "properties": {
        "attribute_name": {
          "description": "The name of the SAML attribute.",
          "example": "group",
          "type": "string"
        },
        "attribute_value": {
          "description": "The SAML attribute value to look for.",
          "example": "[email protected]",
          "type": "string"
        },
        "identity_provider_id": {
          "description": "The ID of your SAML identity provider.",
          "example": "ea85612a-29c8-46c2-bacb-669d65136971",
          "type": "string"
        }
      },
      "required": [
        "attribute_name",
        "attribute_value",
        "identity_provider_id"
      ],
      "type": "object"
    }
  },
  "required": [
    "saml"
  ],
  "type": "object"
}