access_identity-provider

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/access_identity-provider",
  "title": "access_identity-provider",
  "properties": {
    "config": {
      "description": "The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).",
      "type": "object"
    },
    "id": {
      "$ref": "#/components/schemas/access_uuid"
    },
    "name": {
      "$ref": "#/components/schemas/access_components-schemas-name"
    },
    "scim_config": {
      "description": "The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.",
      "properties": {
        "enabled": {
          "description": "A flag to enable or disable SCIM for the identity provider.",
          "type": "boolean"
        },
        "group_member_deprovision": {
          "description": "A flag to revoke a user's session in Access and force a reauthentication on the user's Gateway session when they have been added or removed from a group in the Identity Provider.",
          "type": "boolean"
        },
        "seat_deprovision": {
          "description": "A flag to remove a user's seat in Zero Trust when they have been deprovisioned in the Identity Provider.  This cannot be enabled unless user_deprovision is also enabled.",
          "type": "boolean"
        },
        "secret": {
          "description": "A read-only token generated when the SCIM integration is enabled for the first time.  It is redacted on subsequent requests.  If you lose this you will need to refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.",
          "type": "string"
        },
        "user_deprovision": {
          "description": "A flag to enable revoking a user's session in Access and Gateway when they have been deprovisioned in the Identity Provider.",
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "type": {
      "description": "The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).",
      "enum": [
        "onetimepin",
        "azureAD",
        "saml",
        "centrify",
        "facebook",
        "github",
        "google-apps",
        "google",
        "linkedin",
        "oidc",
        "okta",
        "onelogin",
        "pingone",
        "yandex"
      ],
      "example": "onetimepin",
      "type": "string"
    }
  },
  "required": [
    "name",
    "type",
    "config"
  ],
  "type": "object"
}