Table of Contents

Interface ILogStreamsClient

Namespace
Auth0.ManagementApi
Assembly
Auth0.ManagementApi.dll
public interface ILogStreamsClient
Extension Methods

Methods

CreateAsync(CreateLogStreamRequestContent, RequestOptions?, CancellationToken) 

Create a log stream.

<p>Log Stream Types</p>

The type of log stream being created determines the properties required in the sink payload.

<p>HTTP Stream</p>

For an http Stream, the sink properties are listed in the payload below Request:

{
    	"name": "string",
    	"type": "http",
    	"sink": {
    		"httpEndpoint": "string",
    		"httpContentType": "string",
    		"httpContentFormat": "JSONLINES|JSONARRAY",
    		"httpAuthorization": "string"
    	}
    }
Response: 

{
    	"id": "string",
    	"name": "string",
    	"type": "http",
    	"status": "active",
    	"sink": {
    		"httpEndpoint": "string",
    		"httpContentType": "string",
    		"httpContentFormat": "JSONLINES|JSONARRAY",
    		"httpAuthorization": "string"
    	}
    }
<p>Amazon EventBridge Stream</p>

For an eventbridge Stream, the sink properties are listed in the payload below Request:

{
    	"name": "string",
    	"type": "eventbridge",
    	"sink": {
    		"awsRegion": "string",
    		"awsAccountId": "string"
    	}
    }
The response will include an additional field <code>awsPartnerEventSource</code> in the <code>sink</code>: 

{
    	"id": "string",
    	"name": "string",
    	"type": "eventbridge",
    	"status": "active",
    	"sink": {
    		"awsAccountId": "string",
    		"awsRegion": "string",
    		"awsPartnerEventSource": "string"
    	}
    }
<p>Azure Event Grid Stream</p>

For an Azure Event Grid Stream, the sink properties are listed in the payload below Request:

{
    	"name": "string",
    	"type": "eventgrid",
    	"sink": {
    		"azureSubscriptionId": "string",
    		"azureResourceGroup": "string",
    		"azureRegion": "string"
    	}
    }
Response: 

{
    	"id": "string",
    	"name": "string",
    	"type": "http",
    	"status": "active",
    	"sink": {
    		"azureSubscriptionId": "string",
    		"azureResourceGroup": "string",
    		"azureRegion": "string",
    		"azurePartnerTopic": "string"
    	}
    }
<p>Datadog Stream</p>

For a Datadog Stream, the sink properties are listed in the payload below Request:

{
    	"name": "string",
    	"type": "datadog",
    	"sink": {
    		"datadogRegion": "string",
    		"datadogApiKey": "string"
    	}
    }
Response: 

{
    	"id": "string",
    	"name": "string",
    	"type": "datadog",
    	"status": "active",
    	"sink": {
    		"datadogRegion": "string",
    		"datadogApiKey": "string"
    	}
    }
<p>Splunk Stream</p>

For a Splunk Stream, the sink properties are listed in the payload below Request:

{
    	"name": "string",
    	"type": "splunk",
    	"sink": {
    		"splunkDomain": "string",
    		"splunkToken": "string",
    		"splunkPort": "string",
    		"splunkSecure": "boolean"
    	}
    }
Response: 

{
    	"id": "string",
    	"name": "string",
    	"type": "splunk",
    	"status": "active",
    	"sink": {
    		"splunkDomain": "string",
    		"splunkToken": "string",
    		"splunkPort": "string",
    		"splunkSecure": "boolean"
    	}
    }
<p>Sumo Logic Stream</p>

For a Sumo Logic Stream, the sink properties are listed in the payload below Request:

{
    	"name": "string",
    	"type": "sumo",
    	"sink": {
    		"sumoSourceAddress": "string",
    	}
    }
Response: 

{
    	"id": "string",
    	"name": "string",
    	"type": "sumo",
    	"status": "active",
    	"sink": {
    		"sumoSourceAddress": "string",
    	}
    }
WithRawResponseTask<CreateLogStreamResponseContent> CreateAsync(CreateLogStreamRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request CreateLogStreamRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateLogStreamResponseContent>

DeleteAsync(string, RequestOptions?, CancellationToken)

Delete a log stream.

Task DeleteAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

Task

GetAsync(string, RequestOptions?, CancellationToken) 

 Retrieve a log stream configuration and status.

 <p>Sample responses</p><p>Amazon EventBridge Log Stream</p><pre><code class="lang-csharp">{
 	"id": "string",
 	"name": "string",
 	"type": "eventbridge",
 	"status": "active|paused|suspended",
 	"sink": {
 		"awsAccountId": "string",
 		"awsRegion": "string",
 		"awsPartnerEventSource": "string"
 	}
 }</code></pre> <p>HTTP Log Stream</p><pre><code class="lang-csharp">{
 	"id": "string",
 	"name": "string",
 	"type": "http",
 	"status": "active|paused|suspended",
 	"sink": {
 		"httpContentFormat": "JSONLINES|JSONARRAY",
 		"httpContentType": "string",
 		"httpEndpoint": "string",
 		"httpAuthorization": "string"
 	}
 }</code></pre> <p>Datadog Log Stream</p><pre><code class="lang-csharp">{
 	"id": "string",
 	"name": "string",
 	"type": "datadog",
 	"status": "active|paused|suspended",
 	"sink": {
 		"datadogRegion": "string",
 		"datadogApiKey": "string"
 	}

 }</code></pre><p>Mixpanel</p>

 	Request: 

{
     	  "name": "string",
     	  "type": "mixpanel",
     	  "sink": {
     		"mixpanelRegion": "string", // "us" | "eu",
     		"mixpanelProjectId": "string",
     		"mixpanelServiceAccountUsername": "string",
     		"mixpanelServiceAccountPassword": "string"
     	  }
     	}
 	Response: 

{
     		"id": "string",
     		"name": "string",
     		"type": "mixpanel",
     		"status": "active",
     		"sink": {
     		  "mixpanelRegion": "string", // "us" | "eu",
     		  "mixpanelProjectId": "string",
     		  "mixpanelServiceAccountUsername": "string",
     		  "mixpanelServiceAccountPassword": "string" // the following is redacted on return
     		}
     	  }
 	<p>Segment</p>

 	Request: 

{
    	  "name": "string",
    	  "type": "segment",
    	  "sink": {
    		"segmentWriteKey": "string"
    	  }
    	}
 	Response: 

{
     	  "id": "string",
     	  "name": "string",
     	  "type": "segment",
     	  "status": "active",
     	  "sink": {
     		"segmentWriteKey": "string"
     	  }
     	}
 <p>Splunk Log Stream</p><pre><code class="lang-csharp">{
 	"id": "string",
 	"name": "string",
 	"type": "splunk",
 	"status": "active|paused|suspended",
 	"sink": {
 		"splunkDomain": "string",
 		"splunkToken": "string",
 		"splunkPort": "string",
 		"splunkSecure": "boolean"
 	}
 }</code></pre> <p>Sumo Logic Log Stream</p><pre><code class="lang-csharp">{
 	"id": "string",
 	"name": "string",
 	"type": "sumo",
 	"status": "active|paused|suspended",
 	"sink": {
 		"sumoSourceAddress": "string",
 	}
 }</code></pre> <p>Status</p>

The status of a log stream maybe any of the following: 1. active - Stream is currently enabled. 2. paused - Stream is currently user disabled and will not attempt log delivery. 3. suspended - Stream is currently disabled because of errors and will not attempt log delivery.

WithRawResponseTask<GetLogStreamResponseContent> GetAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<GetLogStreamResponseContent>

ListAsync(RequestOptions?, CancellationToken)

Retrieve details on log streams.

Sample Response

[{
	"id": "string",
	"name": "string",
	"type": "eventbridge",
	"status": "active|paused|suspended",
	"sink": {
		"awsAccountId": "string",
		"awsRegion": "string",
		"awsPartnerEventSource": "string"
	}
}, {
	"id": "string",
	"name": "string",
	"type": "http",
	"status": "active|paused|suspended",
	"sink": {
		"httpContentFormat": "JSONLINES|JSONARRAY",
		"httpContentType": "string",
		"httpEndpoint": "string",
		"httpAuthorization": "string"
	}
},
{
	"id": "string",
	"name": "string",
	"type": "eventgrid",
	"status": "active|paused|suspended",
	"sink": {
		"azureSubscriptionId": "string",
		"azureResourceGroup": "string",
		"azureRegion": "string",
		"azurePartnerTopic": "string"
	}
},
{
	"id": "string",
	"name": "string",
	"type": "splunk",
	"status": "active|paused|suspended",
	"sink": {
		"splunkDomain": "string",
		"splunkToken": "string",
		"splunkPort": "string",
		"splunkSecure": "boolean"
	}
},
{
	"id": "string",
	"name": "string",
	"type": "sumo",
	"status": "active|paused|suspended",
	"sink": {
		"sumoSourceAddress": "string",
	}
},
{
	"id": "string",
	"name": "string",
	"type": "datadog",
	"status": "active|paused|suspended",
	"sink": {
		"datadogRegion": "string",
		"datadogApiKey": "string"
	}
}]
WithRawResponseTask<IEnumerable<LogStreamResponseSchema>> ListAsync(RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<IEnumerable<LogStreamResponseSchema>>

UpdateAsync(string, UpdateLogStreamRequestContent, RequestOptions?, CancellationToken) 

Update a log stream.

<p>Examples of how to use the PATCH endpoint.</p>

The following fields may be updated in a PATCH operation:

  • name
  • status
  • sink
Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted. 
<p>Update the status of a log stream</p><pre><code class="lang-csharp">{
	"status": "active|paused"
}</code></pre>
<p>Update the name of a log stream</p><pre><code class="lang-csharp">{
	"name": "string"
}</code></pre>
<p>Update the sink properties of a stream of type <code>http</code></p><pre><code class="lang-csharp">{
  "sink": {
    "httpEndpoint": "string",
    "httpContentType": "string",
    "httpContentFormat": "JSONARRAY|JSONLINES",
    "httpAuthorization": "string"
  }
}</code></pre>
<p>Update the sink properties of a stream of type <code>datadog</code></p><pre><code class="lang-csharp">{
  "sink": {
		"datadogRegion": "string",
		"datadogApiKey": "string"
  }
}</code></pre>
<p>Update the sink properties of a stream of type <code>splunk</code></p><pre><code class="lang-csharp">{
  "sink": {
    "splunkDomain": "string",
    "splunkToken": "string",
    "splunkPort": "string",
    "splunkSecure": "boolean"
  }
}</code></pre>
<p>Update the sink properties of a stream of type <code>sumo</code></p><pre><code class="lang-csharp">{
  "sink": {
    "sumoSourceAddress": "string"
  }
}</code></pre>

WithRawResponseTask<UpdateLogStreamResponseContent> UpdateAsync(string id, UpdateLogStreamRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string
request UpdateLogStreamRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateLogStreamResponseContent>