---
title: SamlV2ServiceConfiguration
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-samlv2serviceconfiguration
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-samlv2serviceconfiguration.html
section_ids:
  sec-amster-entity-samlv2serviceconfiguration-global-ops: Global Operations
  sec-amster-entity-samlv2serviceconfiguration-global-ops-getalltypes: getAllTypes
  sec-amster-entity-samlv2serviceconfiguration-global-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-samlv2serviceconfiguration-global-ops-nextdescendents: nextdescendents
  sec-amster-entity-samlv2serviceconfiguration-global-ops-read: read
  sec-amster-entity-samlv2serviceconfiguration-global-ops-update: update
---

# SamlV2ServiceConfiguration

## Global Operations

Resource path:

```
/global-config/services/saml2
```

Resource version: `1.0`

### getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

**Usage**

```
am> action SamlV2ServiceConfiguration --global --actionName getAllTypes
```

### getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action SamlV2ServiceConfiguration --global --actionName getCreatableTypes
```

### nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action SamlV2ServiceConfiguration --global --actionName nextdescendents
```

### read

**Usage**

```
am> read SamlV2ServiceConfiguration --global
```

### update

**Usage**

```
am> update SamlV2ServiceConfiguration --global --body body
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "nameIDInfoKeyAttribute" : {
        "title" : "Attribute name for Name ID information key",
        "description" : "User entry attribute to store the name identifier key.",
        "propertyOrder" : 300,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "xmlSigningClass" : {
        "title" : "XML Signing SPI implementation class",
        "description" : "Used by the SAML2 engine to <em>sign</em> documents.",
        "propertyOrder" : 900,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "cacheCleanupInterval" : {
        "title" : "Cache cleanup interval (in seconds)",
        "description" : "Time between cache cleanup operations, in seconds.",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      },
      "signingCertValidation" : {
        "title" : "XML Signing Certificate Validation",
        "description" : "If enabled, then validate certificates used to sign documents.",
        "propertyOrder" : 1000,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "xmlEncryptionClass" : {
        "title" : "XML Encryption SPI implementation class",
        "description" : "Used by the SAML2 engine to <em>encrypt</em> and <em>decrypt</em> documents.",
        "propertyOrder" : 700,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "caCertValidation" : {
        "title" : "CA Certificate Validation",
        "description" : "If enabled, then validate CA certificates.",
        "propertyOrder" : 1100,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "idpDiscoveryCookieDomain" : {
        "title" : "Cookie domain for IdP Discovery Service",
        "description" : "Specifies the cookie domain for the IDP discovery service.",
        "propertyOrder" : 400,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "encryptedKeyInKeyInfo" : {
        "title" : "Include xenc:EncryptedKey inside ds:KeyInfo Element",
        "description" : "Specify whether to include the <code>xenc:EncryptedKey</code> property inside the <code>ds:KeyInfo</code> element.",
        "propertyOrder" : 800,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "bufferLength" : {
        "title" : "Buffer length (in bytes) to decompress request",
        "description" : "Specify the size of the buffer used for decompressing requests, in bytes.",
        "propertyOrder" : 1300,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      },
      "nameIDInfoAttribute" : {
        "title" : "Attribute name for Name ID information",
        "description" : "User entry attribute to store name identifier information.",
        "propertyOrder" : 200,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "idpDiscoveryCookieType" : {
        "title" : "Cookie type for IdP Discovery Service",
        "description" : "Specifies the cookie type to use.",
        "propertyOrder" : 500,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "idpDiscoveryUrlSchema" : {
        "title" : "URL scheme for IdP Discovery Service",
        "description" : "Specifies the URL scheme to use.",
        "propertyOrder" : 600,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      }
    }
  }
  ```