Class OrganizationTemplatesClient

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

public class OrganizationTemplatesClient : IOrganizationTemplatesClient

Inheritance

object

OrganizationTemplatesClient

Implements

IOrganizationTemplatesClient

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

OptionalExtensions.AddIfNotNull<T>(T?, Dictionary<string, object?>, string)

Methods

CreateAsync(CreateOrganizationTemplateRequestContent, RequestOptions?, CancellationToken)

Create an Organization Template.

public WithRawResponseTask<OrganizationTemplate> CreateAsync(CreateOrganizationTemplateRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request CreateOrganizationTemplateRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<OrganizationTemplate>

Examples

await client.OrganizationTemplates.CreateAsync(
    new CreateOrganizationTemplateRequestContent
    {
        Name = "name",
        OrganizationDeletionBehavior = OrganizationDeletionBehaviorEnum.Allow,
        EnforcePermissionCeiling = true,
        EnforceSelfAssignmentRestriction = true,
    }
);

GetAsync(string, RequestOptions?, CancellationToken)

Retrieve details about a single Organization Template specified by ID.

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<OrganizationTemplate>

Examples

await client.OrganizationTemplates.GetAsync("id");

ListAsync(ListOrganizationTemplatesRequestParameters, RequestOptions?, CancellationToken)

Retrieve a list of Organization Templates. This endpoint supports Checkpoint pagination. Results are returned in a stable order, sorted by their identifier (id) in ascending order.

public Task<Pager<OrganizationTemplate>> ListAsync(ListOrganizationTemplatesRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request ListOrganizationTemplatesRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<OrganizationTemplate>>

Examples

await client.OrganizationTemplates.ListAsync(
    new ListOrganizationTemplatesRequestParameters { From = "from", Take = 1 }
);

ListOrganizationsAsync(string, ListTemplateOrganizationsRequestParameters, RequestOptions?, CancellationToken)

Retrieve a list of organizations assigned to an Organization Template. This endpoint supports Checkpoint pagination. Results are returned in a stable order, sorted by their identifier (id) in ascending order.

public Task<Pager<OrganizationTemplateAssignedOrganization>> ListOrganizationsAsync(string id, ListTemplateOrganizationsRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request ListTemplateOrganizationsRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<OrganizationTemplateAssignedOrganization>>

Examples

await client.OrganizationTemplates.ListOrganizationsAsync(
    "id",
    new ListTemplateOrganizationsRequestParameters { From = "from", Take = 1 }
);

UpdateAsync(string, UpdateOrganizationTemplateRequestContent, RequestOptions?, CancellationToken)

Update the details of a specific Organization Template.

public WithRawResponseTask<OrganizationTemplate> UpdateAsync(string id, UpdateOrganizationTemplateRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request UpdateOrganizationTemplateRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<OrganizationTemplate>

Examples

await client.OrganizationTemplates.UpdateAsync(
    "id",
    new UpdateOrganizationTemplateRequestContent()
);