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

# MultiFederationProtocol

## Global Operations

Resource path:

```
/global-config/services/federation/multi
```

Resource version: `1.0`

### getAllTypes

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

**Usage**

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

### getCreatableTypes

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

**Usage**

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

### nextdescendents

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

**Usage**

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

### read

**Usage**

```
am> read MultiFederationProtocol --global
```

### update

**Usage**

```
am> update MultiFederationProtocol --global --body body
```

**Parameters**

* *\--body*

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

  ```json
  {
    "type" : "object",
    "properties" : {
      "singleLogoutHandlerList" : {
        "title" : "Single Logout Handler List",
        "description" : "List of Logout handlers for each supported federation protocol<br><br>The multi-federation protocol engine supports Single Logout. Each federation protocol requires a different single logout handler. Logout handler must implement the <code>com.sun.identity.multiprotocol.SingleLogoutHandler</code> interface.",
        "propertyOrder" : 100,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      }
    }
  }
  ```