Targets

POST /assoc-target-item

Request

  • Base URL
    https://api.akeyless.io
  • URL
    https://api.akeyless.io/assoc-target-item
  • Auth
    none declared

Request body

bind-ssl-profilesstring[]

Bind the provisioned certificate to an existing client-ssl/server-ssl profile, in the format <type>:<partition>:<name> (relevant only for F5 BIG-IP certificate provisioning). Leave the partition empty to use the certificate's partition. For a profile in a folder, add the folder to the partition, for example client-ssl:Common/Shared:my-profile. Repeat the parameter to bind several profiles.

certificate-arnstring

The ARN of an existing imported ACM certificate to re-import into, which replaces its certificate and key; if empty, a new ACM certificate is created on every provisioning, including after renewal (relevant only for AWS certificate provisioning)

certificate-formatstring

The format the certificate will be provisioned with, available options: pem,pfx (relevant only for certificate provisioning)

certificate-namestring

The name of the certificate object in the cloud provider (relevant only for AWS, Azure, and GCP certificate provisioning)

certificate-pathstring

A path on the target to store the certificate pem file (relevant only for certificate provisioning)

chain-pathstring

A path on the target to store the full chain pem file (relevant only for certificate provisioning)

disable-previous-key-versionboolean

Automatically disable previous key version (required for azure targets)

external-key-namestring

The external key name to associate with the classic key (Relevant only for Classic Key AWS/Azure/GCP targets)

f5-save-configboolean

Save the F5 running configuration after each successful provisioning, so the certificate survives a reboot. This also saves any other unsaved change on the device (relevant only for F5 BIG-IP certificate provisioning)

f5-sync-device-groupstring

Sync the F5 configuration to this device group after each successful provisioning, so the HA peer serves the same certificate. This overwrites unsynced changes on the other members of the group. Implies f5-save-config (relevant only for F5 BIG-IP certificate provisioning)

jsonboolean

Set output format to JSON

key-operationsstring[]

A list of allowed operations for the key (required for azure targets)

key-vaultstring

The Azure Key Vault name to provision the certificate to (relevant only for Azure certificate provisioning)

keyring-namestring

Keyring name of the GCP KMS (required for gcp targets)

kms-algorithmstring

Algorithm of the key in GCP KMS (required for gcp targets)

location-idstring

Location id of the GCP KMS (required for gcp targets)

location-scopestring

The GCP Certificate Manager location to provision the certificate to: global or a region such as us-central1 (relevant only for GCP certificate provisioning)

multi-regionstring

Set to 'true' to create a multi-region managed key. (Relevant only for Classic Key AWS targets)

namestring required

The item to associate

pfx-passwordstring

Password used to protect the provisioned PFX file. Required when --certificate-format=pfx (relevant only for certificate provisioning)

post-provision-commandstring

A custom command to run on the remote target after successful provisioning (relevant only for SSH and Windows certificate provisioning, not supported for F5 BIG-IP)

private-key-pathstring

A path on the target to store the private key (relevant only for certificate provisioning)

project-idstring

Project id of the GCP KMS (required for gcp targets)

protection-levelstring

Protection level of the key [software/hardware] (relevant for gcp targets)

purposestring

Purpose of the key in GCP KMS (required for gcp targets)

regionsstring[]

The list of regions to create a copy of the key in (relevant for aws targets)

sra-associationboolean

Is the target to associate is for sra, relevant only for linked target association for ldap rotated secret

target-namestring required

The target to associate

tenant-secret-typestring

The tenant secret type [Data/SearchIndex/Analytics] (required for salesforce targets)

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

vault-namestring

Name of the vault used (required for azure targets)

Response

assocTargetItemResponse wraps response body.

assoc_idstring

Changes

No recorded changes to this operation across all 1 revision of this API.