thalesgroup.ciphertrust.connection_manager_salesforce module – Manage connections to the Salesforce cloud

Note

This module is part of the thalesgroup.ciphertrust collection (version 1.0.0).

To install it, use: ansible-galaxy collection install thalesgroup.ciphertrust.

To use it in a playbook, specify: thalesgroup.ciphertrust.connection_manager_salesforce.

New in thalesgroup.ciphertrust 1.0.0

Synopsis

  • This is a Thales CipherTrust Manager module for working with the CipherTrust Manager APIs, more specifically with Connection Manager API for AWS

Parameters

Parameter

Comments

cert_duration

integer

Duration in days for which the salesforce server certificate is valid, default (730 i.e. 2 Years)

Default: 730

certificate

string

User has the option to upload external certificate for Salesforce Cloud connection. This option cannot be used with option is_certificate_used and client_secret. User first has to generate a new Certificate Signing Request (CSR) in POST /v1/connectionmgmt/connections/csr. The generated CSR can be signed with any internal or external CA. The Certificate must have an RSA key strength of 1024, 2048 or 4096. User can also update the new external certificate in the existing connection in Update (PATCH) API call. Any unused certificate will automatically deleted in 24 hours.

Default: "none"

client_id

string

Unique Identifier (client ID/consumer key) for the Salesforce Application

Default: "none"

client_secret

string

Consumer Secret for the Salesforce application. This a mandatory parameter for a connection with Client Credential Authentication method. This parameter is not needed for Certificate Authentication

Default: "none"

cloud_name

string

Name or Type of the Salesforce cloud

Default: "none"

connection_id

string

Unique ID of the connection to be updated

Default: "none"

description

string

Description about the connection

Default: "none"

is_certificate_used

boolean

User has the option to choose the Certificate Authentication method instead of Client Credentials (password and client_secret) Authentication for Salesforce Cloud connection. In order to use the Certificate, set this field to true. Once the connection is created, in the response user will get a certificate

Choices:

  • false

  • true

localNode

dictionary / required

this holds the connection parameters required to communicate with an instance of CipherTrust Manager (CM)

holds IP/FQDN of the server, username, password, and port

password

string / required

admin password of CM

server_ip

string / required

CM Server IP or FQDN

server_port

integer / required

Port on which CM server is listening

Default: 5432

server_private_ip

string / required

internal or private IP of the CM Server, if different from the server_ip

user

string / required

admin username of CM

verify

boolean / required

if SSL verification is required

Choices:

  • false ← (default)

  • true

meta

dictionary

Optional end-user or service data stored with the connection

name

string / required

Unique connection name

Default: "none"

op_type

string / required

Operation to be performed

Choices:

  • "create"

  • "patch"

products

list / elements=string

Array of the CipherTrust products associated with the connection.

username

string

Username of the Salesforce account

Default: "none"

Examples

- name: "Create Salesforce Connection"
  thalesgroup.ciphertrust.connection_manager_salesforce:
    localNode:
        server_ip: "IP/FQDN of CipherTrust Manager"
        server_private_ip: "Private IP in case that is different from above"
        server_port: 5432
        user: "CipherTrust Manager Username"
        password: "CipherTrust Manager Password"
        verify: false
    op_type: create
    name: salesforce-1
    products:
      - cckm
    cloud_name: "Salesforce Sandbox Cloud"
    client_id: 3bf0dbe6-a2c7-431d-9a6f-4843b74c7e12
    client_secret: BC0556E7A0B4C96E218EF91370C5B
    username: abc@xyz.com
    password: password
    is_certificate_used: false
    certificate: "cert"

- name: "Update Salesforce Connection"
  thalesgroup.ciphertrust.connection_manager_salesforce:
    localNode:
        server_ip: "IP/FQDN of CipherTrust Manager"
        server_private_ip: "Private IP in case that is different from above"
        server_port: 5432
        user: "CipherTrust Manager Username"
        password: "CipherTrust Manager Password"
        verify: false
    op_type: patch

Authors

  • Anurag Jain, Developer Advocate Thales Group