/assoc-target-item

post

https://api.akeyless.io/assoc-target-item

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

assocTargetItem is a command that creates an association between target
and item.

bind-ssl-profiles

array of strings

Bind the provisioned certificate to an existing client-ssl/server-ssl profile, in the format :: (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.

bind-ssl-profiles

certificate-format

string

Defaults to pem

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

certificate-path

string

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

chain-path

string

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

disable-previous-key-version

boolean

Defaults to false

Automatically disable previous key version (required for azure targets)

external-key-name

string

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

json

boolean

Defaults to false

Set output format to JSON

key-operations

array of strings

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

key-operations

keyring-name

string

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

kms-algorithm

string

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

location-id

string

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

multi-region

string

Defaults to false

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

name

string

required

The item to associate

pfx-password

string

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

post-provision-command

string

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-path

string

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

project-id

string

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

protection-level

string

Defaults to software

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

purpose

string

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

regions

array of strings

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

regions

sra-association

boolean

Defaults to false

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

target-name

string

required

The target to associate

tenant-secret-type

string

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

token

string

Authentication token (see /auth and /configure)

uid-token

string

The universal identity token, Required only for universal_identity authentication

vault-name

string

Name of the vault used (required for azure targets)

Responses

200assocTargetItemResponse wraps response body.

defaulterrorResponse wraps any error to return it as a JSON object with one "error" field.