381 lines
14 KiB
JSON
381 lines
14 KiB
JSON
{
|
|
"name": "RetrieveAuditLogEvents",
|
|
"fully_qualified_name": "AsanaApi.RetrieveAuditLogEvents@0.1.0",
|
|
"description": "Retrieve audit log events from your Asana domain.\n\nUse this tool to get a list of audit log events captured in your Asana domain. It supports various query parameters for filtering events and provides paginated results. Useful for tracking and auditing activities since October 8th, 2021.",
|
|
"toolkit": {
|
|
"name": "AsanaApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "workspace_unique_id",
|
|
"required": true,
|
|
"description": "Globally unique identifier for the workspace or organization to filter the audit log events.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Globally unique identifier for the workspace or organization."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "workspace_gid"
|
|
},
|
|
{
|
|
"name": "start_time_filter",
|
|
"required": false,
|
|
"description": "Filter events created on or after this time (inclusive). Provide in ISO 8601 format.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Filter to events created after this time (inclusive)."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "start_at"
|
|
},
|
|
{
|
|
"name": "filter_events_end_time",
|
|
"required": false,
|
|
"description": "Filter events to include only those created before this date and time (exclusive).",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Filter to events created before this time (exclusive)."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "end_at"
|
|
},
|
|
{
|
|
"name": "event_type_filter",
|
|
"required": false,
|
|
"description": "Specify the type of events to filter. Refer to the supported audit log events for valid types.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Filter to events of this type.\nRefer to the [supported audit log events](/docs/audit-log-events#supported-audit-log-events) for a full list of values."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "event_type"
|
|
},
|
|
{
|
|
"name": "actor_type_filter",
|
|
"required": false,
|
|
"description": "Specify the actor type to filter events. Use only if not querying by actor ID.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"user",
|
|
"asana",
|
|
"asana_support",
|
|
"anonymous",
|
|
"external_administrator"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Filter to events with an actor of this type.\nThis only needs to be included if querying for actor types without an ID. If `actor_gid` is included, this should be excluded."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "actor_type"
|
|
},
|
|
{
|
|
"name": "actor_id_filter",
|
|
"required": false,
|
|
"description": "Filter events to those triggered by the actor with this unique ID.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Filter to events triggered by the actor with this ID."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "actor_gid"
|
|
},
|
|
{
|
|
"name": "filter_by_resource_id",
|
|
"required": false,
|
|
"description": "Filter events based on the specific resource ID to retrieve only those associated with this ID.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Filter to events with this resource ID."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "resource_gid"
|
|
},
|
|
{
|
|
"name": "results_per_page",
|
|
"required": false,
|
|
"description": "Set the number of audit log events to return per page of results, between 1 and 100.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "limit"
|
|
},
|
|
{
|
|
"name": "pagination_offset",
|
|
"required": false,
|
|
"description": "Offset token to specify the starting point for retrieving the next page of results. Use the token from the previous response to continue paging through results. Leaving this unset will fetch the first page.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Offset token.\nAn offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*"
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "offset"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'getAuditLogEvents'.",
|
|
"available_modes": [
|
|
"value",
|
|
"error",
|
|
"null"
|
|
],
|
|
"value_schema": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": null
|
|
}
|
|
},
|
|
"requirements": {
|
|
"authorization": {
|
|
"provider_id": "arcade-asana",
|
|
"provider_type": "oauth2",
|
|
"id": null,
|
|
"oauth2": null
|
|
},
|
|
"secrets": null,
|
|
"metadata": null
|
|
},
|
|
"deprecation_message": null,
|
|
"metadata": {
|
|
"object_type": "api_wrapper_tool",
|
|
"version": "1.1.0",
|
|
"description": "Tools that enable LLMs to interact directly with the asana API."
|
|
},
|
|
"http_endpoint": {
|
|
"metadata": {
|
|
"object_type": "http_endpoint",
|
|
"version": "1.2.0",
|
|
"description": ""
|
|
},
|
|
"url": "https://app.asana.com/api/1.0/workspaces/{workspace_gid}/audit_log_events",
|
|
"http_method": "GET",
|
|
"headers": {},
|
|
"parameters": [
|
|
{
|
|
"name": "start_at",
|
|
"tool_parameter_name": "start_time_filter",
|
|
"description": "Filter to events created after this time (inclusive).",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Filter to events created after this time (inclusive)."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "end_at",
|
|
"tool_parameter_name": "filter_events_end_time",
|
|
"description": "Filter to events created before this time (exclusive).",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Filter to events created before this time (exclusive)."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "event_type",
|
|
"tool_parameter_name": "event_type_filter",
|
|
"description": "Filter to events of this type.\nRefer to the [supported audit log events](/docs/audit-log-events#supported-audit-log-events) for a full list of values.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Filter to events of this type.\nRefer to the [supported audit log events](/docs/audit-log-events#supported-audit-log-events) for a full list of values."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "actor_type",
|
|
"tool_parameter_name": "actor_type_filter",
|
|
"description": "Filter to events with an actor of this type.\nThis only needs to be included if querying for actor types without an ID. If `actor_gid` is included, this should be excluded.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"user",
|
|
"asana",
|
|
"asana_support",
|
|
"anonymous",
|
|
"external_administrator"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Filter to events with an actor of this type.\nThis only needs to be included if querying for actor types without an ID. If `actor_gid` is included, this should be excluded."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "actor_gid",
|
|
"tool_parameter_name": "actor_id_filter",
|
|
"description": "Filter to events triggered by the actor with this ID.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Filter to events triggered by the actor with this ID."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "resource_gid",
|
|
"tool_parameter_name": "filter_by_resource_id",
|
|
"description": "Filter to events with this resource ID.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Filter to events with this resource ID."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"tool_parameter_name": "results_per_page",
|
|
"description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"tool_parameter_name": "pagination_offset",
|
|
"description": "Offset token.\nAn offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Offset token.\nAn offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*"
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "workspace_gid",
|
|
"tool_parameter_name": "workspace_unique_id",
|
|
"description": "Globally unique identifier for the workspace or organization.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Globally unique identifier for the workspace or organization."
|
|
},
|
|
"accepted_as": "path",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
}
|
|
],
|
|
"documentation_urls": [],
|
|
"secrets": [
|
|
{
|
|
"arcade_key": "auth_token",
|
|
"parameter_name": "Authorization",
|
|
"accepted_as": "header",
|
|
"formatted_value": "Bearer {authorization}",
|
|
"description": "The OAuth token to use for authentication.",
|
|
"is_auth_token": true
|
|
}
|
|
],
|
|
"request_body_spec": null,
|
|
"use_request_body_schema_mode": false,
|
|
"validate_request_body_schema": false
|
|
}
|
|
}
|