Boomi MFT - AFT Management API Reference (v1) - SSHKey

Toggle Pane

• SSHKey
  • putMigrates existing certificates to SSH key format
  • postGenerates a new SSH key pair for the organization
  • postImports an existing SSH key into the organization
  • putUpdates an existing SSH key configuration
  • getRetrieves all SSH keys for a specific organization
  • getRetrieves detailed information for a specific SSH key
  • delDeletes a specific SSH key from the organization

API docs by Redocly

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

SSHKey

Migrates existing certificates to SSH key format

Converts existing certificate records to SSH key format for system upgrade.

Authorizations:

ApiKeyBearer

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

any

https://us.thruinc.com/api/SSHKey/migrateCertificates

https://uk.thruinc.com/api/SSHKey/migrateCertificates

https://eu.thruinc.com/api/SSHKey/migrateCertificates

https://au.thruinc.com/api/SSHKey/migrateCertificates

Response samples

• 200
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Generates a new SSH key pair for the organization

Generates new SSH key pair with specified algorithm and key strength.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

SSH key configuration including key type and metadata (username is required)

username	string or null
id	integer <int32>
organizationId	integer <int32>
name	string or null
publicKeyText	string or null
privateKeyText	string or null
algorithmId	integer or null <int32>
keyStrengthId	integer or null <int32>
passPhrase	string or null
description	string or null
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

username	string or null
id	integer <int32>
organizationId	integer <int32>
name	string or null
publicKeyText	string or null
privateKeyText	string or null
algorithmId	integer or null <int32>
keyStrengthId	integer or null <int32>
passPhrase	string or null
description	string or null
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/SSHKey/generateKey

https://uk.thruinc.com/api/SSHKey/generateKey

https://eu.thruinc.com/api/SSHKey/generateKey

https://au.thruinc.com/api/SSHKey/generateKey

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "username": "string",
• "id": 0,
• "organizationId": 0,
• "name": "string",
• "publicKeyText": "string",
• "privateKeyText": "string",
• "algorithmId": 0,
• "keyStrengthId": 0,
• "passPhrase": "string",
• "description": "string",
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Imports an existing SSH key into the organization

Imports existing SSH key into organization from provided key material.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

SSH key data including the key material and associated metadata

username	string or null
id	integer <int32>
organizationId	integer <int32>
name	string or null
publicKeyText	string or null
privateKeyText	string or null
algorithmId	integer or null <int32>
keyStrengthId	integer or null <int32>
passPhrase	string or null
description	string or null
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
username	string or null
organizationId	integer <int32>
name	string or null
publicKeyText	string or null
hasPrivateKey	boolean
algorithmId	integer or null <int32>
keyStrengthId	integer or null <int32>
description	string or null
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/SSHKey/importKey

https://uk.thruinc.com/api/SSHKey/importKey

https://eu.thruinc.com/api/SSHKey/importKey

https://au.thruinc.com/api/SSHKey/importKey

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "username": "string",
• "id": 0,
• "organizationId": 0,
• "name": "string",
• "publicKeyText": "string",
• "privateKeyText": "string",
• "algorithmId": 0,
• "keyStrengthId": 0,
• "passPhrase": "string",
• "description": "string",
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing SSH key configuration

Modifies SSH key metadata including name and description.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated SSH key configuration including metadata and settings

username	string or null
id	integer <int32>
organizationId	integer <int32>
name	string or null
publicKeyText	string or null
privateKeyText	string or null
algorithmId	integer or null <int32>
keyStrengthId	integer or null <int32>
passPhrase	string or null
description	string or null
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
username	string or null
organizationId	integer <int32>
name	string or null
publicKeyText	string or null
hasPrivateKey	boolean
algorithmId	integer or null <int32>
keyStrengthId	integer or null <int32>
description	string or null
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/SSHKey/updateKey

https://uk.thruinc.com/api/SSHKey/updateKey

https://eu.thruinc.com/api/SSHKey/updateKey

https://au.thruinc.com/api/SSHKey/updateKey

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "username": "string",
• "id": 0,
• "organizationId": 0,
• "name": "string",
• "publicKeyText": "string",
• "privateKeyText": "string",
• "algorithmId": 0,
• "keyStrengthId": 0,
• "passPhrase": "string",
• "description": "string",
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves all SSH keys for a specific organization

Returns list of SSH keys configured for an organization.

Authorizations:

ApiKeyBearer

query Parameters

organizationId

integer <int32> Unique identifier of the organization to retrieve SSH keys for

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
username	string or null
organizationId	integer <int32>
name	string or null
publicKeyText	string or null
hasPrivateKey	boolean
algorithmId	integer or null <int32>
keyStrengthId	integer or null <int32>
description	string or null
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/SSHKey/listKeys

https://uk.thruinc.com/api/SSHKey/listKeys

https://eu.thruinc.com/api/SSHKey/listKeys

https://au.thruinc.com/api/SSHKey/listKeys

Response samples

• 200
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves detailed information for a specific SSH key

Returns detailed SSH key information including algorithm, strength, and public key data.

Authorizations:

ApiKeyBearer

query Parameters

sshKeyId

integer <int32> Unique identifier of the SSH key to retrieve

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
username	string or null
organizationId	integer <int32>
name	string or null
publicKeyText	string or null
hasPrivateKey	boolean
algorithmId	integer or null <int32>
keyStrengthId	integer or null <int32>
description	string or null
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/SSHKey/getKey

https://uk.thruinc.com/api/SSHKey/getKey

https://eu.thruinc.com/api/SSHKey/getKey

https://au.thruinc.com/api/SSHKey/getKey

Response samples

• 200
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes a specific SSH key from the organization

Removes SSH key from organization configuration.

Authorizations:

ApiKeyBearer

query Parameters

sshKeyId

integer <int32> Unique identifier of the SSH key to delete

Responses

https://us.thruinc.com/api/SSHKey/deleteKey

https://uk.thruinc.com/api/SSHKey/deleteKey

https://eu.thruinc.com/api/SSHKey/deleteKey

https://au.thruinc.com/api/SSHKey/deleteKey

Response samples

• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample