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

Toggle Pane

• Certificates
  • getRetrieves all certificates associated with a specific organization
  • getRetrieves detailed information for a specific certificate
  • getRetrieves available certificate configuration options and metadata
  • putUpdates an existing certificate configuration
  • postCreates a new certificate for secure file transfer operations
  • delDeletes a certificate from the organization

API docs by Redocly

Download OpenAPI Specification: Download

Certificates

Retrieves all certificates associated with a specific organization

Authorizations:

ApiKeyBearer

query Parameters

organizationId

integer <int32> Organization identifier to retrieve certificates for

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
organizationId	integer <int32>
name	string or null
fileName	string or null
certificateTypeId	integer <int32>
type	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/Certificates/getOrganizationCertificatesList

https://uk.thruinc.com/api/Certificates/getOrganizationCertificatesList

https://eu.thruinc.com/api/Certificates/getOrganizationCertificatesList

https://au.thruinc.com/api/Certificates/getOrganizationCertificatesList

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves detailed information for a specific certificate

Authorizations:

ApiKeyBearer

query Parameters

certificateId

integer <int32> Unique identifier of the certificate to retrieve

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
organizationId	integer <int32>
name	string or null
fileName	string or null
certificateTypeId	integer <int32>
type	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/Certificates/getCertificate

https://uk.thruinc.com/api/Certificates/getCertificate

https://eu.thruinc.com/api/Certificates/getCertificate

https://au.thruinc.com/api/Certificates/getCertificate

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves available certificate configuration options and metadata

Authorizations:

ApiKeyBearer

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
name	string or null
description	string or null

https://us.thruinc.com/api/Certificates/getCertificateOptions

https://uk.thruinc.com/api/Certificates/getCertificateOptions

https://eu.thruinc.com/api/Certificates/getCertificateOptions

https://au.thruinc.com/api/Certificates/getCertificateOptions

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing certificate configuration

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated certificate configuration details and metadata

id	integer <int32>
organizationId	integer <int32>
name	string or null
certificateTypeId	integer <int32>
file	string or null
fileName	string or null
certificateData	string or null <byte>
password	string or null
description	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
organizationId	integer <int32>
name	string or null
fileName	string or null
certificateTypeId	integer <int32>
type	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/Certificates/updateCertificate

https://uk.thruinc.com/api/Certificates/updateCertificate

https://eu.thruinc.com/api/Certificates/updateCertificate

https://au.thruinc.com/api/Certificates/updateCertificate

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "certificateTypeId": 0,
• "file": "string",
• "fileName": "string",
• "certificateData": "string",
• "password": "string",
• "description": "string"

}

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new certificate for secure file transfer operations

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Certificate configuration details including name, file data, and metadata

id	integer <int32>
organizationId	integer <int32>
name	string or null
certificateTypeId	integer <int32>
file	string or null
fileName	string or null
certificateData	string or null <byte>
password	string or null
description	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
organizationId	integer <int32>
name	string or null
fileName	string or null
certificateTypeId	integer <int32>
certificateData	string or null <byte>
password	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/Certificates/createCertificate

https://uk.thruinc.com/api/Certificates/createCertificate

https://eu.thruinc.com/api/Certificates/createCertificate

https://au.thruinc.com/api/Certificates/createCertificate

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "certificateTypeId": 0,
• "file": "string",
• "fileName": "string",
• "certificateData": "string",
• "password": "string",
• "description": "string"

}

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes a certificate from the organization

Authorizations:

ApiKeyBearer

query Parameters

id	integer <int32> Unique identifier of the certificate to delete

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

any

https://us.thruinc.com/api/Certificates/deleteCertificate

https://uk.thruinc.com/api/Certificates/deleteCertificate

https://eu.thruinc.com/api/Certificates/deleteCertificate

https://au.thruinc.com/api/Certificates/deleteCertificate

Response samples

• 200
• 400
• 401
• 403
• 409

Content type

text/plainapplication/jsontext/jsontext/plain

No sample