listAccessLogs
List Starburst built-in access control access logs
/api/v1/biac/audit/accessLogs
Usage and SDK Samples
curl -X GET\
\
-H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"//api/v1/biac/audit/accessLogs?pageToken=&pageSize=&pageSort=&startDate=&endDate=&queryId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuditLogsApi;
import java.io.File;
import java.util.*;
public class AuditLogsApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: 02_Cf_Access_Basic
HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
02_Cf_Access_Basic.setUsername("YOUR USERNAME");
02_Cf_Access_Basic.setPassword("YOUR PASSWORD");
AuditLogsApi apiInstance = new AuditLogsApi();
String pageToken = pageToken_example; // String | Page token
String pageSize = pageSize_example; // String | Page size
String pageSort = pageSort_example; // String | Sorting order
Date startDate = 2013-10-20T19:20:30+01:00; // Date | Start of the log entry timestamp interval to match (inclusive)
Date endDate = 2013-10-20T19:20:30+01:00; // Date | End of the log entry timestamp interval to match (exclusive)
Date queryId = 2013-10-20T19:20:30+01:00; // Date | Query ID for which log entries should be matched
try {
PaginatedResultAccessLogResponse result = apiInstance.listAccessLogs(pageToken, pageSize, pageSort, startDate, endDate, queryId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AuditLogsApi#listAccessLogs");
e.printStackTrace();
}
}
}
import io.swagger.client.api.AuditLogsApi;
public class AuditLogsApiExample {
public static void main(String[] args) {
AuditLogsApi apiInstance = new AuditLogsApi();
String pageToken = pageToken_example; // String | Page token
String pageSize = pageSize_example; // String | Page size
String pageSort = pageSort_example; // String | Sorting order
Date startDate = 2013-10-20T19:20:30+01:00; // Date | Start of the log entry timestamp interval to match (inclusive)
Date endDate = 2013-10-20T19:20:30+01:00; // Date | End of the log entry timestamp interval to match (exclusive)
Date queryId = 2013-10-20T19:20:30+01:00; // Date | Query ID for which log entries should be matched
try {
PaginatedResultAccessLogResponse result = apiInstance.listAccessLogs(pageToken, pageSize, pageSort, startDate, endDate, queryId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AuditLogsApi#listAccessLogs");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *pageToken = pageToken_example; // Page token (optional)
String *pageSize = pageSize_example; // Page size (optional) (default to 100)
String *pageSort = pageSort_example; // Sorting order (optional) (default to desc)
Date *startDate = 2013-10-20T19:20:30+01:00; // Start of the log entry timestamp interval to match (inclusive) (optional)
Date *endDate = 2013-10-20T19:20:30+01:00; // End of the log entry timestamp interval to match (exclusive) (optional)
Date *queryId = 2013-10-20T19:20:30+01:00; // Query ID for which log entries should be matched (optional)
AuditLogsApi *apiInstance = [[AuditLogsApi alloc] init];
// List Starburst built-in access control access logs
[apiInstance listAccessLogsWith:pageToken
pageSize:pageSize
pageSort:pageSort
startDate:startDate
endDate:endDate
queryId:queryId
completionHandler: ^(PaginatedResultAccessLogResponse output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');
var defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;
// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'
var api = new StarburstEnterpriseApiDocumentation.AuditLogsApi()
var opts = {
'pageToken': pageToken_example, // {{String}} Page token
'pageSize': pageSize_example, // {{String}} Page size
'pageSort': pageSort_example, // {{String}} Sorting order
'startDate': 2013-10-20T19:20:30+01:00, // {{Date}} Start of the log entry timestamp interval to match (inclusive)
'endDate': 2013-10-20T19:20:30+01:00, // {{Date}} End of the log entry timestamp interval to match (exclusive)
'queryId': 2013-10-20T19:20:30+01:00 // {{Date}} Query ID for which log entries should be matched
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.listAccessLogs(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class listAccessLogsExample
{
public void main()
{
// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN"; // Configure HTTP basic authorization: 02_Cf_Access_Basic
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new AuditLogsApi();
var pageToken = pageToken_example; // String | Page token (optional)
var pageSize = pageSize_example; // String | Page size (optional) (default to 100)
var pageSort = pageSort_example; // String | Sorting order (optional) (default to desc)
var startDate = 2013-10-20T19:20:30+01:00; // Date | Start of the log entry timestamp interval to match (inclusive) (optional)
var endDate = 2013-10-20T19:20:30+01:00; // Date | End of the log entry timestamp interval to match (exclusive) (optional)
var queryId = 2013-10-20T19:20:30+01:00; // Date | Query ID for which log entries should be matched (optional)
try
{
// List Starburst built-in access control access logs
PaginatedResultAccessLogResponse result = apiInstance.listAccessLogs(pageToken, pageSize, pageSort, startDate, endDate, queryId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AuditLogsApi.listAccessLogs: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Swagger\Client\ApiAuditLogsApi();
$pageToken = pageToken_example; // String | Page token
$pageSize = pageSize_example; // String | Page size
$pageSort = pageSort_example; // String | Sorting order
$startDate = 2013-10-20T19:20:30+01:00; // Date | Start of the log entry timestamp interval to match (inclusive)
$endDate = 2013-10-20T19:20:30+01:00; // Date | End of the log entry timestamp interval to match (exclusive)
$queryId = 2013-10-20T19:20:30+01:00; // Date | Query ID for which log entries should be matched
try {
$result = $api_instance->listAccessLogs($pageToken, $pageSize, $pageSort, $startDate, $endDate, $queryId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AuditLogsApi->listAccessLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuditLogsApi;
# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';
my $api_instance = WWW::SwaggerClient::AuditLogsApi->new();
my $pageToken = pageToken_example; # String | Page token
my $pageSize = pageSize_example; # String | Page size
my $pageSort = pageSort_example; # String | Sorting order
my $startDate = 2013-10-20T19:20:30+01:00; # Date | Start of the log entry timestamp interval to match (inclusive)
my $endDate = 2013-10-20T19:20:30+01:00; # Date | End of the log entry timestamp interval to match (exclusive)
my $queryId = 2013-10-20T19:20:30+01:00; # Date | Query ID for which log entries should be matched
eval {
my $result = $api_instance->listAccessLogs(pageToken => $pageToken, pageSize => $pageSize, pageSort => $pageSort, startDate => $startDate, endDate => $endDate, queryId => $queryId);
print Dumper($result);
};
if ($@) {
warn "Exception when calling AuditLogsApi->listAccessLogs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = swagger_client.AuditLogsApi()
pageToken = pageToken_example # String | Page token (optional)
pageSize = pageSize_example # String | Page size (optional) (default to 100)
pageSort = pageSort_example # String | Sorting order (optional) (default to desc)
startDate = 2013-10-20T19:20:30+01:00 # Date | Start of the log entry timestamp interval to match (inclusive) (optional)
endDate = 2013-10-20T19:20:30+01:00 # Date | End of the log entry timestamp interval to match (exclusive) (optional)
queryId = 2013-10-20T19:20:30+01:00 # Date | Query ID for which log entries should be matched (optional)
try:
# List Starburst built-in access control access logs
api_response = api_instance.list_access_logs(pageToken=pageToken, pageSize=pageSize, pageSort=pageSort, startDate=startDate, endDate=endDate, queryId=queryId)
pprint(api_response)
except ApiException as e:
print("Exception when calling AuditLogsApi->listAccessLogs: %s\n" % e)
Parameters
Name | Description |
---|---|
pageToken |
String
Page token
|
pageSize |
String
Page size
|
pageSort |
String
Sorting order
|
startDate |
Date
(date-time)
Start of the log entry timestamp interval to match (inclusive)
|
endDate |
Date
(date-time)
End of the log entry timestamp interval to match (exclusive)
|
queryId |
Date
(date-time)
Query ID for which log entries should be matched
|