access_schemas-scim_config

Configuration for provisioning to this application via SCIM. This is currently in closed beta.

APIs.ioEngineeringPlatform

Properties

Name Type Description
authentication object
deactivate_on_delete boolean If false, we propagate DELETE requests to the target application for SCIM resources. If true, we only set `active` to false on the SCIM resource. This is useful because some targets do not support DEL
enabled boolean Whether SCIM provisioning is turned on for this application.
idp_uid string The UID of the IdP to use as the source for SCIM resources to provision to this application.
mappings array A list of mappings to apply to SCIM resources before provisioning them in this application. These can transform or filter the resources to be provisioned.
remote_uri string The base URI for the application's SCIM-compatible API.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-access-schemas-scim-config-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/access_schemas-scim_config",
  "title": "access_schemas-scim_config",
  "description": "Configuration for provisioning to this application via SCIM. This is currently in closed beta.",
  "properties": {
    "authentication": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/access_scim_config_authentication_http_basic"
        },
        {
          "$ref": "#/components/schemas/access_scim_config_authentication_oauth_bearer_token"
        },
        {
          "$ref": "#/components/schemas/access_scim_config_authentication_oauth2"
        }
      ]
    },
    "deactivate_on_delete": {
      "description": "If false, we propagate DELETE requests to the target application for SCIM resources. If true, we only set `active` to false on the SCIM resource. This is useful because some targets do not support DELETE operations.",
      "type": "boolean"
    },
    "enabled": {
      "description": "Whether SCIM provisioning is turned on for this application.",
      "type": "boolean"
    },
    "idp_uid": {
      "description": "The UID of the IdP to use as the source for SCIM resources to provision to this application.",
      "type": "string"
    },
    "mappings": {
      "description": "A list of mappings to apply to SCIM resources before provisioning them in this application. These can transform or filter the resources to be provisioned.",
      "items": {
        "$ref": "#/components/schemas/access_scim_config_mapping"
      },
      "type": "array"
    },
    "remote_uri": {
      "description": "The base URI for the application's SCIM-compatible API.",
      "type": "string"
    }
  },
  "required": [
    "remote_uri",
    "idp_uid"
  ],
  "type": "object"
}