Your suggested change has been received. Thank you.

close
Thales Logo

All

  • All
  • CipherTrust Manager
  • CipherTrust Application Data Protection (CADP)
  • CipherTrust Application Key Management (CAKM)
  • CipherTrust Batch Data Transformation (BDT)
  • CipherTrust Cloud Key Management (CCKM)
  • CipherTrust Data Discovery and Classification (DDC)
  • CipherTrust Data Protection Gateway (DPG)
  • CipherTrust Database Protection (CDP)
  • CipherTrust Intelligent Protection (CIP)
  • CipherTrust Integrations
  • CipherTrust Migrations
  • CipherTrust RESTful Data Protection (CRDP)
  • CipherTrust Transparent Encryption (CTE)
  • CipherTrust Transparent Encryption Userspace (CTE-U)
  • CipherTrust Secrets Management (CSM)
  • CipherTrust Vaulted Tokenization (CTE-V)
  • CipherTrust Vaultless Tokenization (CT-VL)
  • CTE-Linux
  • CTE-Windows
  • CTE-AIX
  • CTE-K8s
  • CTE-U
  • Data Protection on Demand
  • Luna Cloud HSM
  • Luna Network HSM
  • Luna PCIe HSM
  • Luna USB HSM
  • OneWelcome Identity Platform
  • ProtectApp LUKS
  • ProtectServer 2 HSM
  • ProtectServer 3 HSM
  • SafeNet Trusted Access (STA)
  • SafeNet MobilePASS+
  • SafeNet MobilePASS+ for Android
  • SafeNet MobilePASS+ for Chrome
  • SafeNet MobilePASS+ for macOS
  • SafeNet MobilePASS+ for iOS
  • SafeNet MobilePASS+ for WatchOS
  • SafeNet MobilePASS+ for Widows
  • SafeNet Synchronization Agent
  • SafeNet Logging Agent
  • SafeNet Agent for FreeRADIUS
  • SafeNet Agent for NPS
  • SafeNet Agent for Windows Logon
  • SafeNet Authentication Service Private Cloud Edition (SAS PCE)
  • SafeNet Remote Logging Agent
  • SafeNet Keycloak Agent
  • SafeNet IDPrime Virtual (IDPV)
  • SafeNet FIDO Key Manager
  • SafeNet FIDO Key Manager for Android
  • SafeNet FIDO Key Manager for iOS
  • SafeNet FIDO Key Manager for Windows
back

Stateless APIs

ModifyCustomAttributes

search

Please Note:

printsuggest an edit

ModifyCustomAttributes

This API modifies the attributes of a key.

copy link to clipboardURL

<http/https>://<host-name>:<Port>/protectappws/services/rest/key/modifyCustomAttributes

copy link to clipboardInput Parameters

ParametersDescription
usernameUse name.
passwordPassword associate with the user.
keyNameName of the key for which attributes are to be modified.
AttributeList of attribute names and values. The type parameter lets you optionally specify the type for attribute. The default attribute type is String. The supported attribute types are:
— Date/Time
— Byte String
— Integer
— Long Integer
— Big Integer
— String
— Interval
— Enumeration
— Boolean

copy link to clipboardSample REST call

request

{
    "ModifyCustomAttributes": {
        "username": "username",
        "password": "password",
        "KeyName": "TestKey",
        "Attributes": {
            "Attribute": [
                {
                    "name": "custom32",
                    "value": "12334",
                    "type": "Integer"
                }
            ]
        }
    }
}

response

{
    "ModifyCustomAttributesResponse": {
        "result": "Attributes added successfully."
    }
}

copy link to clipboardSample SOAP Parameters

<prot:ModifyCustomAttributes>
    <username>username</username>
    <password>password</password>
    <KeyName>testaeskey</KeyName>
    <!--1 or more repetitions:-->
    <Attribute>
    <name>k1</name>
    <value>123467</value>
    <!--Optional:-->
    <type>Integer</type>
    </Attribute>
    <Attribute>
    <name>k2</name>
    <value>7468616c657367656d616c746f</value>
    <!--Optional:-->
    <type>Byte String</type>
    </Attribute>
</prot:ModifyCustomAttributes>

copy link to clipboardOutput

<ns2:Session_ModifyCustomAttributesResponse xmlns:ns2="http://dsws.org/protectappws/">Attributes added successfully.</ns2:Session_ModifyCustomAttributesResponse>

Note

The list of attributes that we get in response is comma separated so any attribute (name and value) having special characters (particularly , and {} and “” and =) will be displayed as it is and will make the attribute difficult to read. So, it is recommended NOT to use special characters (particularly , and {} and “” and =) in the input.

On this page