Table of Contents

Interface ISegmentsClient

Namespace
Auth0.ManagementApi.Experimentation
Assembly
Auth0.ManagementApi.dll
public interface ISegmentsClient
Extension Methods

Methods

CreateAsync(CreateSegmentRequestContent, RequestOptions?, CancellationToken)

Create a new segment with rule-based membership criteria for use in experiments.

WithRawResponseTask<CreateSegmentResponseContent> CreateAsync(CreateSegmentRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request CreateSegmentRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateSegmentResponseContent>

DeleteAsync(string, RequestOptions?, CancellationToken)

Delete a segment by ID. Idempotent: returns 204 even if segment does not exist.

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

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask

GetAsync(string, RequestOptions?, CancellationToken)

Retrieve a single segment by its ID.

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

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<GetSegmentResponseContent>

ListAsync(ListSegmentsRequestParameters, RequestOptions?, CancellationToken)

Retrieve a paginated list of segments for the tenant.

Task<Pager<Segment>> ListAsync(ListSegmentsRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request ListSegmentsRequestParameters
options RequestOptions
cancellationToken CancellationToken

Returns

Task<Pager<Segment>>

UpdateAsync(string, UpdateSegmentRequestContent, RequestOptions?, CancellationToken)

Partially update a segment by ID. Only provided fields are updated. Sending rules replaces the entire rules array.

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

Parameters

id string
request UpdateSegmentRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateSegmentResponseContent>