Pivotal Greenplum Record
Click here to see this page in full context


Pivotal Greenplum Record

GET POST/api/2.0/fo/auth/greenplum/

List, create, update, and delete Pivotal Greenplum records for authenticated scans of Pivotal Greenplum 5.x and 6.x instances running on Unix. Compliance scans are supported (using PC).

Input ParametersInput Parameters

Parameter

Required/Optional

Data Type

Description

action={action}

 Required String 

Specify create, update, delete (using POST) or list (using GET or POST).

details={value}

 Optional Boolean 

Default value is Basic. You can choose from None, Basic, and All.

echo_request={0|1}

 Optional Integer 

Specify 1 to view (echo) input parameters in the XML output. By default these are not included.

ids={value}

 Required only for update or delete record Integer 

Record IDs to update/delete. Specify record IDs and/or ID ranges (for example, 1359-1407). Multiple entries are comma separated.

title={value}

 

 Required to create record  String

A title for the record. The title must be unique. Maximum 255 characters (ascii).

comments={value}

 

 Optional to create or update record String 

User defined comments. Maximum of 1999 characters.

Greenplum

greenplum_unix_conf_file={value}

 

 Required for create request Path 

The full path to the configuration file (postgresql.conf) on your Unix assets (IP addresses). The file must be in the same location on all assets for this record.

greenplum_db_name={value}

 Required for create request String 

The database instance you want to authenticate to.

port={value}

 Optional Integer 

The port where the database instance is running. Default is 5432.

ssl_verify={0|1}

 Optional Integer 

SSL verification is skipped by default. Set to 1 if you want to verify the server’s certificate is valid and trusted.

hosts={value}

 Required if ssl_verify=1 Integer 

A list of FQDNs for all host IP addresses on which a custom SSL certificate signed by a trusted root CA is installed.

Login credentials

username={value}

 Required for create request String 

The username of the account to be used for authentication. If password is specified this is the username of a Greenplum account. If login_type=vault is specified, this is the username of a vault account. Maximum 255 characters (ascii).

password={value}

 For create request, password or login_type=vault is required Alphanumeric 

The password of the Greenplum account to be used for authentication. Maximum 100 characters (ascii).

login_type={value}

 For create request, password or login_type=vault is required Boolean 

Login type can be basic (default) or vault. Set to vault if a third party vault will be used to retrieve the password. Vault parameters need to be provided in the record. See “Vault Definition” in the API user guide.

vault_id={value}

 Required if login_type=vault Integer 

 The ID of the vault to be used to retrieve the password for login.

vault_type={value}

 Required if login_type=vault Integer 

The third party vault to be used to retrieve the password for login. Certain vaults support this capability. See “Vault Support Matrix” in the API user guide.

Keys, Passphrase

client_key_type={value}

 Optional Boolean 

Client key type basic (default) or vault.

client_key={value}

 Optional if client_key_type=basic Integer 

Client key content, if private key not in vault.

client_key_vault_type={value}

 Required if client_key_type=vault String 

The third party vault to be used to retrieve the private key. Certain vaults support this capability. See “Vault Support Matrix” in the API user guide.

client_key_vault_id={value}

 Required if client_key_type=vault Integer 

The ID of the vault to get the private key from.

passphrase_type={value}

 Optional Boolean 

Passphrase type can be basic (default) or vault.

passphrase={value}

 Optional if passphrase_type=basic Integer 

The passphrase value.

client_cert={value}

 Optional if passphrase_type=basic Certificate

The passphrase certificate content.

passphrase_vault_type= {value}

 Required if passphrase_type=vault String 

The vault where the private key passphrase is stored. For example CA Access Control, CyberArk AIM, Thycotic Secret Server.

passphrase_vault_id= {value}

 Required if passphrase_type=vault Integer

The ID of the vault to get the passphrase from.

Target Hosts

ips={value}

Required to create record

 

 

 

 

 

Optional to update record

 Integer 

The IP address(es) the server will log into using the record’s credentials. Multiple entries are comma separated.

IPs specified will overwrite existing IPs in the record, and existing IPs will be removed.

This parameter and the add_ips parameter or the remove_ips parameter cannot be specified in the same request.

add_ips={value}

 Optional to update record Integer

 Add IPs and/or ranges to the IPs list for this record. Multiple IPs/ranges are comma separated.

This parameter and the ips parameter cannot be specified in the same request.

remove_ips={value}

 Optional to update record Integer 

IPs to be removed from your record. You may enter a combination of IPs and ranges. Multiple entries are comma separated.

This parameter and the ips parameter cannot be specified in the same request.

network_id={value}

 Optional to create or update record, and valid only when the networks feature is enabled Integer 

The network ID for the record.

Sample: List All Record TypesSample: List All Record Types

API Request

curl -u "USERNAME:PASSWORD" -H 'X-Requested-With:curl' -d"action=list" "https://<qualys_base_url>/api/2.0/fo/auth/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE AUTH_RECORDS_OUTPUT SYSTEM "https://<qualys_base_url>/api/2.0/fo/auth/auth_records.dtd">
<AUTH_RECORDS_OUTPUT>
  <RESPONSE>
    <DATETIME>2019-10-04T09:24:19Z</DATETIME>
    <AUTH_RECORDS>
      <AUTH_UNIX_IDS>
        <ID_SET>
          <ID>1029116</ID>
          <ID>1296290</ID>
          <ID_RANGE>1375563-1375564</ID_RANGE>
          <ID>1505926</ID>
        </ID_SET>
      </AUTH_UNIX_IDS>
      <AUTH_GREENPLUM_IDS>
        <ID_SET>
          <ID>1505929</ID>
        </ID_SET>
      </AUTH_GREENPLUM_IDS>
    </AUTH_RECORDS>
  </RESPONSE>
</AUTH_RECORDS_OUTPUT>

Sample - List Greenplum Records With All DetailsSample - List Greenplum Records With All Details

API Request

curl -u "USERNAME:PASSWORD" -H 'X-Requested-With: curl' -d"action=list&details=All""https://<qualys_base_url>/api/2.0/fo/auth/greenplum/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE AUTH_GREENPLUM_LIST_OUTPUT SYSTEM "https://<qualys_base_url>/api/2.0/fo/auth/greenplum/auth_greenplum_list_output.dtd">
<AUTH_GREENPLUM_LIST_OUTPUT>
    <RESPONSE>
        <DATETIME>2020-01-05T11:41:28Z</DATETIME>
        <AUTH_GREENPLUM_LIST>
            <AUTH_GREENPLUM>
                <ID>66186</ID>
                <TITLE>
                    <![CDATA[greenplum auth]]>
                </TITLE>
                <USERNAME>
                    <![CDATA[root]]>
                </USERNAME>
                <DATABASE>
                    <![CDATA[postgres]]>
                </DATABASE>
                <PORT>5432</PORT>
                <SSL_VERIFY>
                    <![CDATA[0]]>
                </SSL_VERIFY>
                <IP_SET>
                    <IP>10.20.32.111</IP>
                </IP_SET>
                <UNIX_CONF_FILE>
                    <![CDATA[/usr/local/greenplum-db/master/gpseg-1/postgresql.conf]]>
                </UNIX_CONF_FILE>
                <NETWORK_ID>0</NETWORK_ID>
                <CREATED>
                    <DATETIME>2019-12-31T10:51:10Z</DATETIME>
                    <BY>qualys_jd</BY>
                </CREATED>
                <LAST_MODIFIED>
                    <DATETIME>2019-12-31T10:51:10Z</DATETIME>
                </LAST_MODIFIED>
            </AUTH_GREENPLUM>
            <AUTH_GREENPLUM>
                <ID>66390</ID>
                <TITLE>
                    <![CDATA[my greenplum record]]>
                </TITLE>
                <USERNAME>
                    <![CDATA[root]]>
                </USERNAME>
                <DATABASE>
                    <![CDATA[postgres]]>
                </DATABASE>
                <PORT>5432</PORT>
                <SSL_VERIFY>
                    <![CDATA[0]]>
                </SSL_VERIFY>
                <IP_SET>
                    <IP>10.10.10.1</IP>
                </IP_SET>
                <UNIX_CONF_FILE>
                    <![CDATA[ /var/lib/pgsql/data/postgresql.conf]]>
                </UNIX_CONF_FILE>
                <NETWORK_ID>0</NETWORK_ID>
                <CREATED>
                    <DATETIME>2020-01-05T09:14:54Z</DATETIME>
                    <BY>qualys_jd</BY>
                </CREATED>
                <LAST_MODIFIED>
                    <DATETIME>2020-01-05T09:14:54Z</DATETIME>
                </LAST_MODIFIED>
            </AUTH_GREENPLUM>
        </AUTH_GREENPLUM_LIST>
        <GLOSSARY>
            <USER_LIST>
                <USER>
                    <USER_LOGIN>qualys_jd</USER_LOGIN>
                    <FIRST_NAME>John</FIRST_NAME>
                    <LAST_NAME>Doe</LAST_NAME>
                </USER>
            </USER_LIST>
        </GLOSSARY>
    </RESPONSE>
</AUTH_GREENPLUM_LIST_OUTPUT>

Sample - Create Greenplum RecordSample - Create Greenplum Record

API Request

curl -H 'X-Requested-With:curl demo2' -u "xxx:xxxxx" -d"action=create&title=pivotal_greenlpum_API_vault&login_type=vault&username=test&vault_type=Hitachi IDPAM&vault_id=1358790&resource_id=test&ips=1.1.1.1&port=333&greenplum_db_name=db" "<qualys_base_url>/api/2.0/fo/auth/greenplum/"

XML Output

"<?xml version=""1.0"" encoding=""UTF-8"" ?>
<!DOCTYPE BATCH_RETURN SYSTEM
""<qualys_base_url>/api/2.0/batch_return.dtd"">
<BATCH_RETURN>
 <RESPONSE>
 <DATETIME>2023-11-30T05:11:04Z</DATETIME>
 <BATCH_LIST>
 <BATCH>
 <TEXT>Successfully Created</TEXT>
 <ID_SET>
    <ID>3797413</ID>
 </ID_SET>
 </BATCH>
 </BATCH_LIST>
 </RESPONSE>
</BATCH_RETURN>"

Sample - Update Greenplum RecordSample - Update Greenplum Record

API Request

curl -H 'X-Requested-With:curl demo2' -u "xxx:xxxx" -d"action=update&title=pivotal_greenlpum_API_vault_update&resource_id=test_update&ids=3797413&login_type=vault&username=test&vault_type=Hitachi IDPAM&vault_id=1358790""<qualys_base_url>/api/2.0/fo/auth/greenplum/"

XML Output

"<?xml version=""1.0"" encoding=""UTF-8"" ?>
<!DOCTYPE BATCH_RETURN SYSTEM
""<qualys_base_url>/api/2.0/batch_return.dtd"">
<BATCH_RETURN>
 <RESPONSE>
 <DATETIME>2023-11-30T05:20:08Z</DATETIME>
 <BATCH_LIST>
 <BATCH>
 <TEXT>Successfully Updated</TEXT>
 <ID_SET>
 <ID>3797413</ID>
 </ID_SET>
 </BATCH>
 </BATCH_LIST>
 </RESPONSE>
</BATCH_RETURN>"

Sample - Delete Greenplum RecordsSample - Delete Greenplum Records

API Request 

curl -u "USERNAME:PASSWORD" -H 'X-Requested-With: curl' -d"action=delete&ids=66391""https://<qualys_base_url>/api/2.0/fo/auth/greenplum/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM "https://<qualys_base_url>/api/2.0/batch_return.dtd">
<BATCH_RETURN>
    <RESPONSE>
        <DATETIME>2020-01-05T12:10:16Z</DATETIME>
        <BATCH_LIST>
            <BATCH>
                <TEXT>Successfully Deleted</TEXT>
                <ID_SET>
                    <ID>66391</ID>
                </ID_SET>
            </BATCH>
        </BATCH_LIST>
    </RESPONSE>
</BATCH_RETURN>

Sample - List Pivotal Greenplum Record with Resource IDSample - List Pivotal Greenplum Record with Resource ID

API Request

curl -H 'X-Requested-With:curl demo2' -u "xxx:xxxx" -d"action=list&ids=3797413""<qualys_base_url>/api/2.0/fo/auth/greenplum/"

XML Output

"<?xml version=""1.0"" encoding=""UTF-8"" ?>
<!DOCTYPE AUTH_GREENPLUM_LIST_OUTPUT SYSTEM
""<qualys_base_url>/api/2.0/fo/auth/greenplum/auth_greenplum_list_output.
    dtd"">
    <AUTH_GREENPLUM_LIST_OUTPUT>
     <RESPONSE>
     <DATETIME>2023-11-30T05:23:36Z</DATETIME>
     <AUTH_GREENPLUM_LIST>
     <AUTH_GREENPLUM>
     <ID>3797413</ID>
     <TITLE><![CDATA[pivotal_greenlpum_API_vault_update]]></TITLE>
     <USERNAME><![CDATA[test]]></USERNAME>
     <DATABASE><![CDATA[db]]></DATABASE>
     <PORT>333</PORT>
     <SSL_VERIFY><![CDATA[0]]></SSL_VERIFY>
     <IP_SET>
     <IP>1.1.1.1</IP>
     </IP_SET>
     <LOGIN_TYPE><![CDATA[vault]]></LOGIN_TYPE>
     <DIGITAL_VAULT>
     <DIGITAL_VAULT_ID><![CDATA[1358790]]></DIGITAL_VAULT_ID>
     <DIGITAL_VAULT_TYPE><![CDATA[Hitachi ID
    PAM]]></DIGITAL_VAULT_TYPE>
     <DIGITAL_VAULT_TITLE><![CDATA[Hitachi ID PAM
    vault]]></DIGITAL_VAULT_TITLE>
     <VAULT_RESOURCE_ID><![CDATA[test_update]]></VAULT_RESOURCE_ID>
     </DIGITAL_VAULT>
     <UNIX_CONF_FILE><![CDATA[]]></UNIX_CONF_FILE>
     <CREATED>
     <DATETIME>2023-11-30T05:11:04Z</DATETIME>
     <BY>vsh_sm</BY>
     </CREATED>
     <LAST_MODIFIED>
     <DATETIME>2023-11-30T05:20:08Z</DATETIME>
     </LAST_MODIFIED>
     </AUTH_GREENPLUM>
     </AUTH_GREENPLUM_LIST>
     </RESPONSE>
    </AUTH_GREENPLUM_LIST_OUTPUT>

DTDs for Authentication Type "greenplum"

<platform API server>/api/2.0/fo/auth/auth_records.dtd

<platform API server>/api/2.0/fo/auth/greenplum/auth_greenplum_list_output.dtd