Class IntegrationRequiredParam

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

Param are form input values, primarily utilized when specifying secrets and configuration values for actions.

These are especially important for partner integrations -- but can be exposed to tenant admins as well if they want to parameterize their custom actions.

[Serializable]
public record IntegrationRequiredParam : IJsonOnDeserialized, IEquatable<IntegrationRequiredParam>

Inheritance

object

IntegrationRequiredParam

Implements

IJsonOnDeserialized

IEquatable<IntegrationRequiredParam>

Inherited Members

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)

Properties

AdditionalProperties

[JsonIgnore]
public ReadOnlyAdditionalProperties AdditionalProperties { get; }

Property Value

ReadOnlyAdditionalProperties

DefaultValue

The default value for this parameter.

[JsonPropertyName("default_value")]
public string? DefaultValue { get; set; }

Property Value

string

Description

The lengthier description for this parameter.

[JsonPropertyName("description")]
public string? Description { get; set; }

Property Value

string

Label

The short label for this parameter.

[JsonPropertyName("label")]
public string? Label { get; set; }

Property Value

string

Name

The name of the parameter.

[JsonPropertyName("name")]
public string? Name { get; set; }

Property Value

string

Optional

The temp flag for if this parameter is required (experimental; for Labs use only).

[JsonPropertyName("optional")]
public bool? Optional { get; set; }

Property Value

bool?

Options

The allowable options for this param.

[JsonPropertyName("options")]
public IEnumerable<IntegrationRequiredParamOption>? Options { get; set; }

Property Value

IEnumerable<IntegrationRequiredParamOption>

Placeholder

Placeholder text for this parameter.

[JsonPropertyName("placeholder")]
public string? Placeholder { get; set; }

Property Value

string

Required

The flag for if this parameter is required.

[JsonPropertyName("required")]
public bool? Required { get; set; }

Property Value

bool?

Type

[JsonPropertyName("type")]
public IntegrationRequiredParamTypeEnum? Type { get; set; }

Property Value

IntegrationRequiredParamTypeEnum?

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.