# openstack.identity.v3.federation_protocol

## The FederationProtocol Class

The `FederationProtocol` class inherits from `Resource`.

class openstack.identity.v3.federation_protocol.FederationProtocol(_synchronized=False, connection=None, **attrs)

  The base resource

  Parameters:

    - _synchronized (bool) – This is not intended to be used directly. See `new()` and `existing()`.

    - connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of `self._connection` in Resource code should protect itself with a check for None.

  resource_key = 'protocol'

    Singular form of key for resource.

  resources_key = 'protocols'

    Plural form of key for resource.

  base_path = '/OS-FEDERATION/identity_providers/%(idp_id)s/protocols'

    The base part of the URI for this resource.

  allow_create = True

    Allow create operation for this resource.

  allow_fetch = True

    Allow get operation for this resource.

  allow_commit = True

    Allow update operation for this resource.

  allow_delete = True

    Allow delete operation for this resource.

  allow_list = True

    Allow list operation for this resource.

  create_exclude_id_from_body = True

    Whether create should exclude ID in the body of the request.

  create_method = 'PUT'

    Method for creating a resource (POST, PUT)

  commit_method = 'PATCH'

    Method for committing a resource (PUT, PATCH, POST)

  name

    name of the protocol (read only) Type: string

this page last updated: 2026-01-16 23:06:19

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.