..
.. SPDX-License-Identifier: Apache-2.0
..

:github_url: https://github.com/IBM-Blockchain/ansible-collection/edit/main/plugins/modules/enrolled_identity_info.py


enrolled_identity_info -- Get information about an enrolled Hyperledger Fabric identity
=======================================================================================

.. contents::
   :local:
   :depth: 1


Synopsis
--------

Get information about an enrolled Hyperledger Fabric identity by using the IBM Blockchain Platform.

This module works with the IBM Blockchain Platform managed service running in IBM Cloud, or the IBM Blockchain Platform software running in a Red Hat OpenShift or Kubernetes cluster.






Parameters
----------

  path (required)
    The path to the JSON file where the enrolled identity is stored.









Examples
--------

.. code-block:: yaml+jinja

    
    - name: Get enrolled identity
      ibm.blockchain_platform.enrolled_identity_info:
        path: Org1 Admin.json



Return Values
-------------

  exists
    True if the enrolled identity exists, false otherwise.

    | **Type**: boolean

  enrolled_identity
    The enrolled identity.

    | **Returned**: if enrolled identity exists
    | **Type**: dict

    name
      The name of the enrolled identity.

      | **Type**: str
      | **Sample**: ``Org1 Admin``

    cert
      The base64 encoded certificate of the enrolled identity.

      | **Type**: str
      | **Sample**: ``LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...``

    private_key
      The base64 encoded private key of the enrolled identity.

      | **Type**: str
      | **Sample**: ``LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0t...``

    ca
      The base64 encoded CA certificate chain of the enrolled identity.

      | **Type**: str
      | **Sample**: ``LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...``

    hsm
      True if the private key is stored in a PKCS

      | **Type**: boolean



