NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
IBM X-Force Exchange connects to a Nagent workspace with an API key. Once it is connected, agents can call 7 IBM X-Force Exchange actions, such as "Get Latest Public Collections", "Get Public Collections Paginated" and "Get IPR Category List". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against IBM X-Force Exchange, with input parameters and output schema.
IBM_X_FORCE_EXCHANGE_GET_CASEFILES_PUBLICTool to retrieve latest public Collections from IBM X-Force Exchange. Use when you need to access publicly available collections without pagination. For fetching all public collections, consider using the paginated endpoint instead.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IBM_X_FORCE_EXCHANGE_GET_CASEFILES_PUBLIC_PAGINATEDTool to retrieve all public Collections using pagination from IBM X-Force Exchange. Use when you need to access publicly available collections with pagination support. Returns a list of publicly accessible case files with pagination metadata.
Input parameters
Number of records to skip for pagination. Must be non-negative. Defaults to 0.
Maximum number of records to return per page. Must be between 1 and 1000. Defaults to 100.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IBM_X_FORCE_EXCHANGE_GET_IPR_CATEGORIESTool to retrieve the complete list of IP reputation categories from IBM X-Force Exchange. Use when you need to understand available IPR classification categories used by XFE.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IBM_X_FORCE_EXCHANGE_GET_URL_CATEGORIESTool to retrieve the complete list of URL categories from IBM X-Force Exchange. Use when you need to understand available URL classification categories used by XFE.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IBM_X_FORCE_EXCHANGE_GET_USERPROFILETool to retrieve authenticated user's profile information from IBM X-Force Exchange. Use when you need to access user account details, membership statistics, or integration configurations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IBM_X_FORCE_EXCHANGE_GET_VERSIONTool to retrieve current running API version information from IBM X-Force Exchange. Use when you need to check the API version, build number, or creation date.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IBM_X_FORCE_EXCHANGE_POST_AUTH_API_KEYTool to generate a new API key and password pair for IBM X-Force Exchange authentication. Use when you need to create new credentials for API access. The generated credentials do not expire and can be used with Basic Authentication.
Input parameters
Optional name for the API key to help identify it. This is a label for organizational purposes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 7 IBM X-Force Exchange actions on Nagent, including "Get Latest Public Collections", "Get Public Collections Paginated" and "Get IPR Category List". Get Latest Public Collections: Retrieve latest public Collections from IBM X-Force Exchange. Each action is listed on this page with its input parameters and its output.
IBM X-Force Exchange connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
It returns data, error and successful.