client

func (*Client) CheckStatus ¶

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

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

Retrieves the status of an ad/ldap connection referenced by its <code>ID</code>. <code>200 OK</code> http status code response is returned when the connection is online, otherwise a <code>404</code> status code is returned along with an error message

func (*Client) Create ¶

func (c *Client) Create(
	ctx context.Context,
	request *management.CreateConnectionRequestContent,
	opts ...option.RequestOption,
) (*management.CreateConnectionResponseContent, error)

Creates a new connection according to the JSON object received in <code>body</code>.<br/>

func (*Client) Delete ¶

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

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

Removes a specific <a href="https://auth0.com/docs/authenticate/identity-providers">connection</a> from your tenant. This action cannot be undone. Once removed, users can no longer use this connection to authenticate.

func (*Client) Get ¶

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

	id string,
	request *management.GetConnectionRequestParameters,
	opts ...option.RequestOption,
) (*management.GetConnectionResponseContent, error)

Retrieve details for a specified <a href="https://auth0.com/docs/authenticate/identity-providers">connection</a> along with options that can be used for identity provider configuration.

func (*Client) List ¶

func (c *Client) List(
	ctx context.Context,
	request *management.ListConnectionsQueryParameters,
	opts ...option.RequestOption,
) (*core.Page[*management.ConnectionForList], error)

Retrieves detailed list of all <a href="https://auth0.com/docs/authenticate/identity-providers">connections</a> that match the specified strategy. If no strategy is provided, all connections within your tenant are retrieved. This action can accept a list of fields to include or exclude from the resulting list of connections.

This endpoint supports two types of pagination: <ul> <li>Offset pagination</li> <li>Checkpoint pagination</li> </ul>

Checkpoint pagination must be used if you need to retrieve more than 1000 connections.

<h2>Checkpoint Pagination</h2>

To search by checkpoint, use the following parameters: <ul> <li><code>from</code>: Optional id from which to start selection.</li> <li><code>take</code>: The total amount of entries to retrieve when using the from parameter. Defaults to 50.</li> </ul>

<b>Note</b>: The first time you call this endpoint using checkpoint pagination, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no pages are remaining.

func (*Client) Update ¶

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

	id string,
	request *management.UpdateConnectionRequestContent,
	opts ...option.RequestOption,
) (*management.UpdateConnectionResponseContent, error)

Update details for a specific <a href="https://auth0.com/docs/authenticate/identity-providers">connection</a>, including option properties for identity provider configuration.

<b>Note</b>: If you use the <code>options</code> parameter, the entire <code>options</code> object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option.

func (*RawClient) CheckStatus ¶

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

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

func (*RawClient) Create ¶

func (r *RawClient) Create(
	ctx context.Context,
	request *management.CreateConnectionRequestContent,
	opts ...option.RequestOption,
) (*core.Response[*management.CreateConnectionResponseContent], error)

func (*RawClient) Delete ¶

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

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

func (*RawClient) Get ¶

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

	id string,
	request *management.GetConnectionRequestParameters,
	opts ...option.RequestOption,
) (*core.Response[*management.GetConnectionResponseContent], error)

func (*RawClient) Update ¶

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

	id string,
	request *management.UpdateConnectionRequestContent,
	opts ...option.RequestOption,
) (*core.Response[*management.UpdateConnectionResponseContent], error)