rules

package
v3.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 9, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	WithRawResponse *RawClient
	// contains filtered or unexported fields
}

func NewClient

func NewClient(options *core.RequestOptions) *Client

func (*Client) Create

Create a [new rule](https://auth0.com/docs/rules#create-a-new-rule-using-the-management-api).

Note: Changing a rule's stage of execution from the default `login_success` can change the rule's function signature to have user omitted.

Example:

request := &management.CreateRuleRequestContent{
    Name: "name",
    Script: "script",
}
client.Rules.Create(
    context.TODO(),
    request,
)

func (*Client) Delete

func (c *Client) Delete(
	ctx context.Context,

	id string,
	opts ...option.RequestOption,
) error

Delete a rule.

Example:

client.Rules.Delete(
    context.TODO(),
    "id",
)

func (*Client) Get

Retrieve [rule](https://auth0.com/docs/rules) details. Accepts a list of fields to include or exclude in the result.

Example:

request := &management.GetRuleRequestParameters{
    Fields: management.String(
        "fields",
    ),
    IncludeFields: management.Bool(
        true,
    ),
}
client.Rules.Get(
    context.TODO(),
    "id",
    request,
)

func (*Client) List

Retrieve a filtered list of rules(https://auth0.com/docs/rules). Accepts a list of fields to include or exclude.

Example:

request := &management.ListRulesRequestParameters{
    Page: management.Int(
        1,
    ),
    PerPage: management.Int(
        1,
    ),
    IncludeTotals: management.Bool(
        true,
    ),
    Enabled: management.Bool(
        true,
    ),
    Fields: management.String(
        "fields",
    ),
    IncludeFields: management.Bool(
        true,
    ),
}
client.Rules.List(
    context.TODO(),
    request,
)

func (*Client) Update

Update an existing rule.

Example:

request := &management.UpdateRuleRequestContent{}
client.Rules.Update(
    context.TODO(),
    "id",
    request,
)

type RawClient

type RawClient struct {
	// contains filtered or unexported fields
}

func NewRawClient

func NewRawClient(options *core.RequestOptions) *RawClient

func (*RawClient) Delete

func (r *RawClient) Delete(
	ctx context.Context,

	id string,
	opts ...option.RequestOption,
) (*core.Response[any], error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL