Skip to content

Latest commit

 

History

History
90 lines (71 loc) · 5.98 KB

AuditLogsApi.md

File metadata and controls

90 lines (71 loc) · 5.98 KB

AuditLogsApi

All URIs are relative to https://api.openai.com/v1

Method HTTP request Description
listAuditLogs GET /organization/audit_logs List user actions and configuration changes within this organization.

listAuditLogs

ListAuditLogsResponse listAuditLogs(effectiveAt, projectIds, eventTypes, actorIds, actorEmails, resourceIds, limit, after, before)

List user actions and configuration changes within this organization.

Example

// Import classes:
import com.github.ainoya.client.ApiClient;
import com.github.ainoya.client.ApiException;
import com.github.ainoya.client.Configuration;
import com.github.ainoya.client.auth.*;
import com.github.ainoya.client.models.*;
import com.github.ainoya.openai.client.api.AuditLogsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.openai.com/v1");
    
    // Configure HTTP bearer authorization: ApiKeyAuth
    HttpBearerAuth ApiKeyAuth = (HttpBearerAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setBearerToken("BEARER TOKEN");

    AuditLogsApi apiInstance = new AuditLogsApi(defaultClient);
    ListAuditLogsEffectiveAtParameter effectiveAt = new ListAuditLogsEffectiveAtParameter(); // ListAuditLogsEffectiveAtParameter | Return only events whose `effective_at` (Unix seconds) is in this range.
    List<String> projectIds = Arrays.asList(); // List<String> | Return only events for these projects.
    List<AuditLogEventType> eventTypes = Arrays.asList(); // List<AuditLogEventType> | Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](/docs/api-reference/audit-logs/object).
    List<String> actorIds = Arrays.asList(); // List<String> | Return only events performed by these actors. Can be a user ID, a service account ID, or an api key tracking ID.
    List<String> actorEmails = Arrays.asList(); // List<String> | Return only events performed by users with these emails.
    List<String> resourceIds = Arrays.asList(); // List<String> | Return only events performed on these targets. For example, a project ID updated.
    Integer limit = 20; // Integer | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. 
    String after = "after_example"; // String | A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. 
    String before = "before_example"; // String | A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. 
    try {
      ListAuditLogsResponse result = apiInstance.listAuditLogs(effectiveAt, projectIds, eventTypes, actorIds, actorEmails, resourceIds, limit, after, before);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AuditLogsApi#listAuditLogs");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
effectiveAt ListAuditLogsEffectiveAtParameter Return only events whose `effective_at` (Unix seconds) is in this range. [optional]
projectIds List<String> Return only events for these projects. [optional]
eventTypes List<AuditLogEventType> Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the audit log object. [optional]
actorIds List<String> Return only events performed by these actors. Can be a user ID, a service account ID, or an api key tracking ID. [optional]
actorEmails List<String> Return only events performed by users with these emails. [optional]
resourceIds List<String> Return only events performed on these targets. For example, a project ID updated. [optional]
limit Integer A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. [optional] [default to 20]
after String A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. [optional]
before String A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. [optional]

Return type

ListAuditLogsResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Audit logs listed successfully. -