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

Toggle Pane

• ApiKey
  • getRetrieves a specific API key by identifier
  • putUpdates an existing API key configuration
  • delDeletes an API key and revokes its access
  • getRetrieves all API keys for the current user
  • postCreates a new API key for programmatic access

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.

ApiKey

Retrieves a specific API key by identifier

Returns detailed API key configuration including name, permissions, and expiration settings.

Authorizations:

ApiKeyBearer

query Parameters

id	string Unique identifier of the API key to retrieve

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	string or null
enabled	boolean
keyName	string or null
tenantId	integer <int32>
allowedApis	string or null
allowedOrgs	string or null
expirationDate	string or null <date-time>
createdDate	string <date-time>
createdBy	string or null
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
name	string or null

https://us.thruinc.com/api/ApiKey

https://uk.thruinc.com/api/ApiKey

https://eu.thruinc.com/api/ApiKey

https://au.thruinc.com/api/ApiKey

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing API key configuration

Modifies existing API key configuration including enabled status and allowed APIs.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated API key configuration

id	string or null
enabled	boolean
keyName	string or null
tenantId	integer <int32>
allowedApis	string or null
allowedOrgs	string or null
expirationDate	string or null <date-time>
createdDate	string <date-time>
createdBy	string or null
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	string or null
enabled	boolean
keyName	string or null
tenantId	integer <int32>
allowedApis	string or null
allowedOrgs	string or null
expirationDate	string or null <date-time>
createdDate	string <date-time>
createdBy	string or null
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
name	string or null

https://us.thruinc.com/api/ApiKey

https://uk.thruinc.com/api/ApiKey

https://eu.thruinc.com/api/ApiKey

https://au.thruinc.com/api/ApiKey

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": "string",
• "enabled": true,
• "keyName": "string",
• "tenantId": 0,
• "allowedApis": "string",
• "allowedOrgs": "string",
• "expirationDate": "2019-08-24T14:15:22Z",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdBy": "string",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes an API key and revokes its access

Revokes and removes an API key from the system.

Authorizations:

ApiKeyBearer

query Parameters

id	string Unique identifier of the API key to delete

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

recordsAffected

integer <int32>

https://us.thruinc.com/api/ApiKey

https://uk.thruinc.com/api/ApiKey

https://eu.thruinc.com/api/ApiKey

https://au.thruinc.com/api/ApiKey

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves all API keys for the current user

Returns list of all API keys for the current user with configuration details.

Authorizations:

ApiKeyBearer

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	string or null
enabled	boolean
keyName	string or null
tenantId	integer <int32>
allowedApis	string or null
allowedOrgs	string or null
expirationDate	string or null <date-time>
createdDate	string <date-time>
createdBy	string or null
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
name	string or null

https://us.thruinc.com/api/ApiKey/list

https://uk.thruinc.com/api/ApiKey/list

https://eu.thruinc.com/api/ApiKey/list

https://au.thruinc.com/api/ApiKey/list

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new API key for programmatic access

Generates new API key with specified permissions, expiration, and access restrictions.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

API key configuration including name, permissions, and expiration

id	string or null
enabled	boolean
keyName	string or null
tenantId	integer <int32>
allowedApis	string or null
allowedOrgs	string or null
expirationDate	string or null <date-time>
createdDate	string <date-time>
createdBy	string or null
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	string or null
enabled	boolean
keyName	string or null
tenantId	integer <int32>
allowedApis	string or null
allowedOrgs	string or null
expirationDate	string or null <date-time>
createdDate	string <date-time>
createdBy	string or null
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
name	string or null

https://us.thruinc.com/api/ApiKey/createApiKey

https://uk.thruinc.com/api/ApiKey/createApiKey

https://eu.thruinc.com/api/ApiKey/createApiKey

https://au.thruinc.com/api/ApiKey/createApiKey

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": "string",
• "enabled": true,
• "keyName": "string",
• "tenantId": 0,
• "allowedApis": "string",
• "allowedOrgs": "string",
• "expirationDate": "2019-08-24T14:15:22Z",
• "createdDate": "2019-08-24T14:15:22Z",
• "createdBy": "string",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample