client

func (*Client) Create ¶

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

Create a new client (application or SSO integration). For more information, read [Create Applications](https://www.auth0.com/docs/get-started/auth0-overview/create-applications) [API Endpoints for Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on/api-endpoints-for-single-sign-on).

Notes: - We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret. - The `client_authentication_methods` and `token_endpoint_auth_method` properties are mutually exclusive. Use `client_authentication_methods` to configure the client with Private Key JWT authentication method. Otherwise, use `token_endpoint_auth_method` to configure the client with client secret (basic or post) or with no authentication method (none). - When using `client_authentication_methods` to configure the client with Private Key JWT authentication method, specify fully defined credentials. These credentials will be automatically enabled for Private Key JWT authentication on the client. - To configure `client_authentication_methods`, the `create:client_credentials` scope is required. - To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256.

SSO Integrations created via this endpoint will accept login requests and share user profile information.

func (*Client) Delete ¶

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

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

Delete a client and related configuration (rules, connections, etc).

func (*Client) Get ¶

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

	id string,
	request *management.GetClientRequestParameters,
	opts ...option.RequestOption,
) (*management.GetClientResponseContent, error)

Retrieve client details by ID. Clients are SSO connections or Applications linked with your Auth0 tenant. A list of fields to include or exclude may also be specified. For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on).

• The following properties can be retrieved with any of the scopes: `client_id`, `app_type`, `name`, and `description`.
• The following properties can only be retrieved with the `read:clients` or `read:client_keys` scopes: `callbacks`, `oidc_logout`, `allowed_origins`, `web_origins`, `tenant`, `global`, `config_route`, `callback_url_template`, `jwt_configuration`, `jwt_configuration.lifetime_in_seconds`, `jwt_configuration.secret_encoded`, `jwt_configuration.scopes`, `jwt_configuration.alg`, `api_type`, `logo_uri`, `allowed_clients`, `owners`, `custom_login_page`, `custom_login_page_off`, `sso`, `addons`, `form_template`, `custom_login_page_codeview`, `resource_servers`, `client_metadata`, `mobile`, `mobile.android`, `mobile.ios`, `allowed_logout_urls`, `token_endpoint_auth_method`, `is_first_party`, `oidc_conformant`, `is_token_endpoint_ip_header_trusted`, `initiate_login_uri`, `grant_types`, `refresh_token`, `refresh_token.rotation_type`, `refresh_token.expiration_type`, `refresh_token.leeway`, `refresh_token.token_lifetime`, `refresh_token.policies`, `organization_usage`, `organization_require_behavior`.
• The following properties can only be retrieved with the `read:client_keys` or `read:client_credentials` scopes: `encryption_key`, `encryption_key.pub`, `encryption_key.cert`, `client_secret`, `client_authentication_methods` and `signing_key`.

func (*Client) List ¶

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

Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude may also be specified. For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on).

• The following can be retrieved with any scope: `client_id`, `app_type`, `name`, and `description`.
• The following properties can only be retrieved with the `read:clients` or `read:client_keys` scope: `callbacks`, `oidc_logout`, `allowed_origins`, `web_origins`, `tenant`, `global`, `config_route`, `callback_url_template`, `jwt_configuration`, `jwt_configuration.lifetime_in_seconds`, `jwt_configuration.secret_encoded`, `jwt_configuration.scopes`, `jwt_configuration.alg`, `api_type`, `logo_uri`, `allowed_clients`, `owners`, `custom_login_page`, `custom_login_page_off`, `sso`, `addons`, `form_template`, `custom_login_page_codeview`, `resource_servers`, `client_metadata`, `mobile`, `mobile.android`, `mobile.ios`, `allowed_logout_urls`, `token_endpoint_auth_method`, `is_first_party`, `oidc_conformant`, `is_token_endpoint_ip_header_trusted`, `initiate_login_uri`, `grant_types`, `refresh_token`, `refresh_token.rotation_type`, `refresh_token.expiration_type`, `refresh_token.leeway`, `refresh_token.token_lifetime`, `refresh_token.policies`, `organization_usage`, `organization_require_behavior`.
• The following properties can only be retrieved with the `read:client_keys` or `read:client_credentials` scope: `encryption_key`, `encryption_key.pub`, `encryption_key.cert`, `client_secret`, `client_authentication_methods` and `signing_key`.

func (*Client) PreviewCimdMetadata ¶ added in v2.8.0

func (c *Client) PreviewCimdMetadata(
	ctx context.Context,
	request *management.PreviewCimdMetadataRequestContent,
	opts ...option.RequestOption,
) (*management.PreviewCimdMetadataResponseContent, error)

Fetches and validates a Client ID Metadata Document without creating a client. Returns the raw metadata and how it would be mapped to Auth0 client fields. This endpoint is useful for testing metadata URIs before creating CIMD clients.

func (*Client) RegisterCimdClient ¶ added in v2.8.0

func (c *Client) RegisterCimdClient(
	ctx context.Context,
	request *management.RegisterCimdClientRequestContent,
	opts ...option.RequestOption,
) (*management.RegisterCimdClientResponseContent, error)

Idempotent registration for Client ID Metadata Document (CIMD) clients. Uses external_client_id as the unique identifier for upsert operations.

**Create:** Returns 201 when a new client is created (requires `create:clients` scope). **Update:** Returns 200 when an existing client is updated (requires `update:clients` scope).

This endpoint automatically: - Fetches and validates the metadata document - Maps CIMD fields to Auth0 client configuration - Creates/rotates credentials from the JWKS - Enforces CIMD security policies (HTTPS-only, no shared secrets)

func (*Client) RotateSecret ¶

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

	id string,
	opts ...option.RequestOption,
) (*management.RotateClientSecretResponseContent, error)

Rotate a client secret.

This endpoint cannot be used with clients configured with Private Key JWT authentication method (client_authentication_methods configured with private_key_jwt). The generated secret is NOT base64 encoded.

For more information, read [Rotate Client Secrets](https://www.auth0.com/docs/get-started/applications/rotate-client-secret).

func (*Client) Update ¶

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

	id string,
	request *management.UpdateClientRequestContent,
	opts ...option.RequestOption,
) (*management.UpdateClientResponseContent, error)

Updates a client's settings. For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on).

Notes: - The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope. - The `client_authentication_methods` and `token_endpoint_auth_method` properties are mutually exclusive. Use `client_authentication_methods` to configure the client with Private Key JWT authentication method. Otherwise, use `token_endpoint_auth_method` to configure the client with client secret (basic or post) or with no authentication method (none). - When using `client_authentication_methods` to configure the client with Private Key JWT authentication method, only specify the credential IDs that were generated when creating the credentials on the client. - To configure `client_authentication_methods`, the `update:client_credentials` scope is required. - To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256. - To change a client's `is_first_party` property to `false`, the `organization_usage` and `organization_require_behavior` properties must be unset.

func (*RawClient) Create ¶

func (r *RawClient) Create(
	ctx context.Context,
	request *management.CreateClientRequestContent,
	opts ...option.RequestOption,
) (*core.Response[*management.CreateClientResponseContent], 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.GetClientRequestParameters,
	opts ...option.RequestOption,
) (*core.Response[*management.GetClientResponseContent], error)

func (*RawClient) PreviewCimdMetadata ¶ added in v2.8.0

func (r *RawClient) PreviewCimdMetadata(
	ctx context.Context,
	request *management.PreviewCimdMetadataRequestContent,
	opts ...option.RequestOption,
) (*core.Response[*management.PreviewCimdMetadataResponseContent], error)

func (*RawClient) RegisterCimdClient ¶ added in v2.8.0

func (r *RawClient) RegisterCimdClient(
	ctx context.Context,
	request *management.RegisterCimdClientRequestContent,
	opts ...option.RequestOption,
) (*core.Response[*management.RegisterCimdClientResponseContent], error)

func (*RawClient) RotateSecret ¶

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

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

func (*RawClient) Update ¶

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

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