registered_identity – Manage a registered Hyperledger Fabric identity
Synopsis
Register, update, or revoke an 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
- api_endpoint (required)
The URL for the IBM Blockchain Platform console.
Type: str- api_authtype (required)
ibmcloud- Authenticate to the IBM Blockchain Platform console using IBM Cloud authentication. You must provide a valid API key using api_key.
basic- Authenticate to the IBM Blockchain Platform console using basic authentication. You must provide both a valid API key using api_key and API secret using api_secret.Type: str- api_key (required)
The API key for the IBM Blockchain Platform console.
Type: str- api_secret
The API secret for the IBM Blockchain Platform console.
Only required when api_authtype is
basic.Type: str- api_timeout
The timeout, in seconds, to use when interacting with the IBM Blockchain Platform console.
Type: intDefault value:60- api_token_endpoint
The IBM Cloud IAM token endpoint to use when using IBM Cloud authentication.
Only required when api_authtype is
ibmcloud, and you are using IBM internal staging servers for testing.Type: strDefault value:https://iam.cloud.ibm.com/identity/token- state
absent- If an identity is registered matching the specified enrollment ID, the identity will be removed. Note that this operation is unsupported by default and must be enabled by the certificate authority.
present- Asserts that an identity matching the specified enrollment ID and configuration is registered. If no identity matches the specified enrollment ID, the identity will be created. If an identity matches the specified enrollment ID but the configuration does not match, then the identity will be updated, if it can be. If it cannot be updated, it will be removed and re-created with the specified configuration.Type: strDefault value:present- certificate_authority (required)
The certificate authority to use to register this identity.
You can pass a string, which is the display name of a certificate authority registered with the IBM Blockchain Platform console.
You can also pass a dictionary, which must match the result format of one of the ERROR while parsing: While parsing “M(certificate_authority_info)” at index 82: Module name “certificate_authority_info” is not a FQCN or ERROR while parsing: While parsing “M(certificate_authority)” at index 115: Module name “certificate_authority” is not a FQCN modules.
Type: raw- registrar (required)
The identity to use when interacting with the certificate authority.
You can pass a string, which is the path to the JSON file where the enrolled identity is stored.
You can also pass a dict, which must match the result format of one of the ERROR while parsing: While parsing “M(enrolled_identity_info)” at index 76: Module name “enrolled_identity_info” is not a FQCN or ERROR while parsing: While parsing “M(enrolled_identity)” at index 105: Module name “enrolled_identity” is not a FQCN modules.
Type: raw- hsm
The PKCS #11 compliant HSM configuration to use for digital signatures.
Only required if the identity specified in registrar was enrolled using an HSM.
Type: dict
- pkcs11library
The PKCS #11 library that should be used for digital signatures.
Type: str- label
The HSM label that should be used for digital signatures.
Type: str- pin
The HSM pin that should be used for digital signatures.
Type: str- enrollment_id (required)
The enrollment ID, or user name, of the identity to register on the certificate authority.
Type: str- enrollment_secret
The enrollment secret, or password, of an identity to register on the certificate authority.
Only required when state is
present.Type: str- max_enrollments
The maximum number of times that this identity can be enrolled.
Type: intDefault value:-1- type
The type of this identity.
Type: strDefault value:client- affiliation
The affiliation of this identity.
Type: str- attributes
The attributes for this identity.
Type: listElements: dict
- name
The name of the attribute.
Type: str- value
The value of the attribute.
Type: str- ecert
Whether or not the attribute and its value will be in the enrollment certificate.
Type: bool
Examples
- name: Register a new identity
ibm.blockchain_platform.registered_identity:
state: present
api_endpoint: https://ibp-console.example.org:32000
api_authtype: basic
api_key: xxxxxxxx
api_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
certificate_authority: Org1 CA
registrar: Org1 CA Admin.json
enrollment_id: org1app
enrollment_secret: org1apppw
max_enrollments: 10
type: client
attributes:
- name: "fabcar.admin"
value: "true"
- name: Delete an existing identity
ibm.blockchain_platform.registered_identity:
state: absent
api_endpoint: https://ibp-console.example.org:32000
api_authtype: basic
api_key: xxxxxxxx
api_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
certificate_authority: Org1 CA
registrar: Org1 CA Admin.json
enrollment_id: org1app
Return Values
- registered_identity
The registered identity.
Returned: when state ispresentType: dict
- enrollment_id
The enrollment ID, or user name, of the identity.
Type: strSample:org1admin- enrollment_secret
The enrollment secret, or password, of an identity.
Type: strSample:org1adminpw- max_enrollments
The maximum number of times that this identity can be enrolled.
Type: intSample:-1- type
The type of this identity.
Type: strSample:admin- affiliation
The affiliation of this identity.
Type: strSample:org1.department- attributes
The attributes for this identity.
Type: listElements: dict
- name
The name of the attribute.
Type: strSample:fabcar.admin- value
The value of the attribute.
Type: strSample:True- ecert
Whether or not the attribute and its value will be in the enrollment certificate.
Type: boolSample:True