Track what was performed, who did it, and the results

Clarifai's Audit Logging feature helps you monitor platform activities for better visibility, security, and governance. It captures detailed logs of operations so you can know what was done, who did it, and the results.

With Audit Logging, you can assess the actions performed on users and their resources, track resource changes to identify potential security issues, and maintain comprehensive activity logs to meet regulatory requirements.

Supported Operations

The Audit Logging feature currently supports tracking the following critical resource operations ( we're planning to support more resources in the future):

• Organization and team membership activities — Includes creating, updating, or deleting organizations and teams, sending invitations, and managing team users and applications.
• Compute Orchestration – Cover creating, modifying, deleting clusters, nodepools, deployments
• Module activities — Tracks the creation, updating, and deletion of modules.
• Model activities — Tracks actions such as creating, training, publishing, and deleting models.
• Workflow activities — Covers the creation, publishing, updating, and deletion of workflows.
• Application activities — Includes creating, updating, duplicating, and deleting applications.
• Collaborator activities — Includes adding collaborators, editing their scopes, and removing them.

Here is a table that showcases the supported operations.

• Default
• Organization Memberships and Teams
• Compute Orchestration
• Modules
• Models
• Workflows
• Applications
• Collaborators
• Users

List Audit Log Events

Here is how you can list all the supported audit log events performed by a user on the Clarifai platform.

#########################################################################
# In this section, we set the user authentication and user ID.
# Change these strings to run your own example.
#########################################################################

# Your PAT (Personal Access Token) can be found in the Account's Security section
PAT = 'YOUR_PAT_HERE'
USER_ID = 'YOUR_USER_ID_HERE'

###########################################################################
# YOU DO NOT NEED TO CHANGE ANYTHING BELOW THIS LINE TO RUN THIS EXAMPLE
###########################################################################

from clarifai_grpc.channel.clarifai_channel import ClarifaiChannel
from clarifai_grpc.grpc.api import resources_pb2, service_pb2, service_pb2_grpc
from clarifai_grpc.grpc.api.status import status_code_pb2

channel = ClarifaiChannel.get_grpc_channel()
stub = service_pb2_grpc.V2Stub(channel)

metadata = (('authorization', 'Key ' + PAT),)

userDataObject = resources_pb2.UserAppIDSet(user_id=USER_ID)

post_audit_log_searches = stub.PostAuditLogSearches(
    service_pb2.PostAuditLogSearchesRequest(
        user_app_id=userDataObject # The userDataObject is created in the overview and is required when using a PAT
    ),
    metadata=metadata
)
if post_audit_log_searches.status.code != status_code_pb2.SUCCESS:
    print(post_audit_log_searches.status)
    raise Exception("Post audit log searches failed, status: " + post_audit_log_searches.status.description)

print(post_audit_log_searches)

<!-- index.html file -->

<script>
    ///////////////////////////////////////////////////////////////////////////////////
    // In this section, we set the user authentication and user ID.
    // Change these strings to run your own example.
    //////////////////////////////////////////////////////////////////////////////////

// Your PAT (Personal Access Token) can be found in the Account's Security section
    const PAT = 'YOUR_PAT_HERE';
    const USER_ID = 'YOUR_USER_ID_HERE';

//////////////////////////////////////////////////////////////////////////////////
    // YOU DO NOT NEED TO CHANGE ANYTHING BELOW THIS LINE TO RUN THIS EXAMPLE
    /////////////////////////////////////////////////////////////////////////////////

const raw = JSON.stringify({});

const requestOptions = {
      method: 'POST',
      headers: {
        'Accept': 'application/json',
        'Authorization': 'Key ' + PAT
      },
      body: raw
    };

fetch(`https://api.clarifai.com/v2/users/${USER_ID}/audit_log/searches`, requestOptions)
      .then(response => response.text())
      .then(result => console.log(result))
      .catch(error => console.log('error', error));
  </script>

// index.js file

////////////////////////////////////////////////////////////////////////////////////
// In this section, we set the user authentication and user ID.
// Change these strings to run your own example.
////////////////////////////////////////////////////////////////////////////////////

// Your PAT (Personal Access Token) can be found in the Account's Security section
const PAT = 'YOUR_PAT_HERE';
const USER_ID = 'YOUR_USER_ID_HERE';

///////////////////////////////////////////////////////////////////////////////////
// YOU DO NOT NEED TO CHANGE ANYTHING BELOW THIS LINE TO RUN THIS EXAMPLE
///////////////////////////////////////////////////////////////////////////////////

const { ClarifaiStub, grpc } = require("clarifai-nodejs-grpc");

const stub = ClarifaiStub.grpc();

// This will be used by every Clarifai endpoint call
const metadata = new grpc.Metadata();
metadata.set("authorization", "Key " + PAT);

stub.PostAuditLogSearches(
  {
    user_app_id: {
      user_id: USER_ID,
    },
  },
  metadata,
  (err, response) => {
    if (err) {
      throw new Error(err);
    }

if (response.status.code !== 10000) {
      console.log(response.status);
      throw new Error(
        "Post audit log searches failed, status: " + response.status.description
      );
    }

console.log(response);
  }
);

Filter Searches

You can optionally refine your searches to retrieve only the operations of interest. This enables targeted audit trails for the activities performed on the Clarifai platform.