Create or update an LTPA profile

Purpose

Creates or updates an LTPA profile. An LTPA profile defines the LTPA key file and password to use for single sign-on authentication.

URI

Use the Eclipse Amlen REST API POST method with the followingEclipse Amlen configuration URI:

http://<admin-endpoint-IP:Port>/ima/v1/configuration/

Object configuration data

Provide LTPAProfile object configuration data in the payload of the POST method by using the following schema. Content-type is set to application/json:


{    
  "LTPAProfile": {
    "<NameOfLTPAProfile>": {
      "KeyFileName": "string",
      "Password": "string", 
      "Overwrite": true|false
     }
   }
}

Where:

NameOfLTPAProfile: Required.; Specifies a name for the LTPA profile.; The name can be a maximum of 256 alphanumeric characters.; The name must not have leading or trailing spaces and cannot contain control characters, commas, double quotation marks, backslashes, or equal signs. The first character must not be a number.; After the profile is created, this name cannot be changed.
KeyFileName: Required if you are creating an LTPA profile.; Specifies the name of the key file to use with this LTPA profile. The key file must exist on Eclipse Amlen.; The name can be a maximum of 255 alphanumeric characters. The first character must not be a number.
Password: Required if you are creating an LTPA profile.; Specifies the LTPA password that is associated with the key file used in the LTPA profile.; The value of this parameter is not returned on the REST API GET method.
Overwrite: true|false: Specifies whether an existing key is overwritten if it has the same name.; The default value is false which means that an existing key is not overwritten if it has the same name.

Usage Notes®

The LTPA key file must be copied to Eclipse Amlen before it can be used in an LTPA profile. Copy a file from the local machine to Eclipse Amlen command to copy the LTPA key file.
After you create an LTPA profile, you must associate it with a security profile.
Capitalization and double quotation marks must be used as shown.

Related REST Administration APIs

Example

Copy a key called certificateKey.pem by using cURL:

curl -X PUT -T certificate.pem http://10.10.2.149:9089/ima/v1/file/ltpa.key

Create an LTPA profile called "MyLTPAProfile" by using cURL:

 
curl -X POST \
   -H 'Content-Type: application/json'  \
   -d  '{ 
         "LTPAProfile": {   
           "MyLTPAProfile": {
             "KeyFileName": "ltpa.key",
             "Password": "ltpakeypassword"
          }
        }
    }
 '  \
http://127.0.0.1:9089/ima/v1/configuration/

An example response to the POST method:


{        
  "Version": "v1",
  "Code": "CWLNA6011",
  "Message": "The requested configuration change has completed successfully."
}