Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions .fern/replay.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

165 changes: 66 additions & 99 deletions reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -1049,16 +1049,14 @@ await client.Clients.PreviewCimdMetadataAsync(
Idempotent registration for Client ID Metadata Document (CIMD) clients.
Uses external_client_id as the unique identifier for upsert operations.

<strong>Create:</strong> Returns 201 when a new client is created (requires <code>create:clients</code> scope).
<strong>Update:</strong> Returns 200 when an existing client is updated (requires <code>update:clients</code> scope).
**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:
<ul>
<li>Fetches and validates the metadata document</li>
<li>Maps CIMD fields to Auth0 client configuration</li>
<li>Creates/rotates credentials from the JWKS</li>
<li>Enforces CIMD security policies (HTTPS-only, no shared secrets)</li>
</ul>
- 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)
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -6676,7 +6674,7 @@ await client.RefreshTokens.ListAsync(
<dl>
<dd>

Revoke refresh tokens in bulk by ID list, user, user+client, or client.
Revoke refresh tokens in bulk by ID list, user, user+client, or user+client+audience.
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -12435,7 +12433,7 @@ await client.Branding.Themes.UpdateAsync(
<dl>
<dd>

Retrieve a list of <a href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone providers</a> details set for a Tenant. A list of fields to include or exclude may also be specified.
Retrieve a list of [phone providers](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) details set for a Tenant. A list of fields to include or exclude may also be specified.
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -12491,8 +12489,8 @@ await client.Branding.Phone.Providers.ListAsync(
<dl>
<dd>

Create a <a href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone provider</a>.
The <code>credentials</code> object requires different properties depending on the phone provider (which is specified using the <code>name</code> property).
Create a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).
The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property).
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -12552,7 +12550,7 @@ await client.Branding.Phone.Providers.CreateAsync(
<dl>
<dd>

Retrieve <a href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone provider</a> details. A list of fields to include or exclude may also be specified.
Retrieve [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) details. A list of fields to include or exclude may also be specified.
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -12660,8 +12658,8 @@ await client.Branding.Phone.Providers.DeleteAsync("id");
<dl>
<dd>

Update a <a href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone provider</a>.
The <code>credentials</code> object requires different properties depending on the phone provider (which is specified using the <code>name</code> property).
Update a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).
The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property).
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -15043,7 +15041,7 @@ await client.Connections.ScimConfiguration.Tokens.DeleteAsync("id", "tokenId");
<dl>
<dd>

Retrieve details of the <a href="https://auth0.com/docs/customize/email/smtp-email-providers">email provider configuration</a> in your tenant. A list of fields to include or exclude may also be specified.
Retrieve details of the [email provider configuration](https://auth0.com/docs/customize/email/smtp-email-providers) in your tenant. A list of fields to include or exclude may also be specified.
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -15099,48 +15097,31 @@ await client.Emails.Provider.GetAsync(
<dl>
<dd>

Create an <a href="https://auth0.com/docs/email/providers">email provider</a>. The <code>credentials</code> object
requires different properties depending on the email provider (which is specified using the <code>name</code> property):
<ul>
<li><code>mandrill</code> requires <code>api_key</code></li>
<li><code>sendgrid</code> requires <code>api_key</code></li>
<li>
<code>sparkpost</code> requires <code>api_key</code>. Optionally, set <code>region</code> to <code>eu</code> to use
the SparkPost service hosted in Western Europe; set to <code>null</code> to use the SparkPost service hosted in
North America. <code>eu</code> or <code>null</code> are the only valid values for <code>region</code>.
</li>
<li>
<code>mailgun</code> requires <code>api_key</code> and <code>domain</code>. Optionally, set <code>region</code> to
<code>eu</code> to use the Mailgun service hosted in Europe; set to <code>null</code> otherwise. <code>eu</code> or
<code>null</code> are the only valid values for <code>region</code>.
</li>
<li><code>ses</code> requires <code>accessKeyId</code>, <code>secretAccessKey</code>, and <code>region</code></li>
<li>
<code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and
<code>smtp_pass</code>
</li>
</ul>
Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration
Create an [email provider](https://auth0.com/docs/email/providers). The `credentials` object
requires different properties depending on the email provider (which is specified using the `name` property):

- `mandrill` requires `api_key`
- `sendgrid` requires `api_key`
- `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use
the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in
North America. `eu` or `null` are the only valid values for `region`.
- `mailgun` requires `api_key` and `domain`. Optionally, set `region` to
`eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or
`null` are the only valid values for `region`.
- `ses` requires `accessKeyId`, `secretAccessKey`, and `region`
- `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and
`smtp_pass`

Depending on the type of provider it is possible to specify `settings` object with different configuration
options, which will be used when sending an email:
<ul>
<li>
<code>smtp</code> provider, <code>settings</code> may contain <code>headers</code> object.
<ul>
<li>
When using AWS SES SMTP host, you may provide a name of configuration set in
<code>X-SES-Configuration-Set</code> header. Value must be a string.
</li>
<li>
When using Sparkpost host, you may provide value for
<code>X-MSYS_API</code> header. Value must be an object.
</li>
</ul>
</li>
<li>
for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide
a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.
</li>
</ul>

- `smtp` provider, `settings` may contain `headers` object.
- When using AWS SES SMTP host, you may provide a name of configuration set in
`X-SES-Configuration-Set` header. Value must be a string.
- When using Sparkpost host, you may provide value for
`X-MSYS_API` header. Value must be an object.
- For `ses` provider, `settings` may contain `message` object, where you can provide
a name of configuration set in `configuration_set_name` property. Value must be a string.
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -15239,46 +15220,32 @@ await client.Emails.Provider.DeleteAsync();
<dl>
<dd>

Update an <a href="https://auth0.com/docs/email/providers">email provider</a>. The <code>credentials</code> object
requires different properties depending on the email provider (which is specified using the <code>name</code> property):
<ul>
<li><code>mandrill</code> requires <code>api_key</code></li>
<li><code>sendgrid</code> requires <code>api_key</code></li>
<li>
<code>sparkpost</code> requires <code>api_key</code>. Optionally, set <code>region</code> to <code>eu</code> to use
the SparkPost service hosted in Western Europe; set to <code>null</code> to use the SparkPost service hosted in
North America. <code>eu</code> or <code>null</code> are the only valid values for <code>region</code>.
</li>
<li>
<code>mailgun</code> requires <code>api_key</code> and <code>domain</code>. Optionally, set <code>region</code> to
<code>eu</code> to use the Mailgun service hosted in Europe; set to <code>null</code> otherwise. <code>eu</code> or
<code>null</code> are the only valid values for <code>region</code>.
</li>
<li><code>ses</code> requires <code>accessKeyId</code>, <code>secretAccessKey</code>, and <code>region</code></li>
<li>
<code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and
<code>smtp_pass</code>
</li>
</ul>
Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration
Update an [email provider](https://auth0.com/docs/email/providers). The `credentials` object
requires different properties depending on the email provider (which is specified using the `name` property):

- `mandrill` requires `api_key`
- `sendgrid` requires `api_key`
- `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use
the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in
North America. `eu` or `null` are the only valid values for `region`.
- `mailgun` requires `api_key` and `domain`. Optionally, set `region` to
`eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or
`null` are the only valid values for `region`.
- `ses` requires `accessKeyId`, `secretAccessKey`, and `region`
- `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and
`smtp_pass`

Depending on the type of provider it is possible to specify `settings` object with different configuration
options, which will be used when sending an email:
<ul>
<li>
<code>smtp</code> provider, <code>settings</code> may contain <code>headers</code> object.
<ul>
<li>
When using AWS SES SMTP host, you may provide a name of configuration set in
<code>X-SES-Configuration-Set</code> header. Value must be a string.
</li>
<li>
When using Sparkpost host, you may provide value for
<code>X-MSYS_API</code> header. Value must be an object.
</li>
</ul>
for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide
a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.
</li>
</ul>

- `smtp` provider, `settings` may contain `headers` object.
- When using AWS SES SMTP host, you may provide a name of configuration set in
`X-SES-Configuration-Set` header. Value must be a string.
- When using Sparkpost host, you may provide value for
`X-MSYS_API` header. Value must be an object.

For `ses` provider, `settings` may contain `message` object, where you can provide
a name of configuration set in `configuration_set_name` property. Value must be a string.
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -16010,7 +15977,7 @@ await client.Groups.Members.GetAsync(
<dl>
<dd>

Lists the <a href="https://auth0.com/docs/manage-users/access-control/rbac">roles</a> assigned to a group.
Lists the [roles](https://auth0.com/docs/manage-users/access-control/rbac) assigned to a group.
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -16075,7 +16042,7 @@ await client.Groups.Roles.ListAsync(
<dl>
<dd>

Assign one or more <a href="https://auth0.com/docs/manage-users/access-control/rbac">roles</a> to a specified group.
Assign one or more [roles](https://auth0.com/docs/manage-users/access-control/rbac) to a specified group.
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -16140,7 +16107,7 @@ await client.Groups.Roles.CreateAsync(
<dl>
<dd>

Unassign one or more <a href="https://auth0.com/docs/manage-users/access-control/rbac">roles</a> from a specified group.
Unassign one or more [roles](https://auth0.com/docs/manage-users/access-control/rbac) from a specified group.
</dd>
</dl>
</dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ namespace Auth0.ManagementApi.Branding.Phone;
public partial interface IProvidersClient
{
/// <summary>
/// Retrieve a list of <see href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone providers</see> details set for a Tenant. A list of fields to include or exclude may also be specified.
/// Retrieve a list of [phone providers](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) details set for a Tenant. A list of fields to include or exclude may also be specified.
/// </summary>
WithRawResponseTask<ListBrandingPhoneProvidersResponseContent> ListAsync(
ListBrandingPhoneProvidersRequestParameters request,
Expand All @@ -14,8 +14,8 @@ WithRawResponseTask<ListBrandingPhoneProvidersResponseContent> ListAsync(
);

/// <summary>
/// Create a <see href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone provider</see>.
/// The <c>credentials</c> object requires different properties depending on the phone provider (which is specified using the <c>name</c> property).
/// Create a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).
/// The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property).
/// </summary>
WithRawResponseTask<CreateBrandingPhoneProviderResponseContent> CreateAsync(
CreateBrandingPhoneProviderRequestContent request,
Expand All @@ -24,7 +24,7 @@ WithRawResponseTask<CreateBrandingPhoneProviderResponseContent> CreateAsync(
);

/// <summary>
/// Retrieve <see href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone provider</see> details. A list of fields to include or exclude may also be specified.
/// Retrieve [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) details. A list of fields to include or exclude may also be specified.
/// </summary>
WithRawResponseTask<GetBrandingPhoneProviderResponseContent> GetAsync(
string id,
Expand All @@ -42,8 +42,8 @@ Task DeleteAsync(
);

/// <summary>
/// Update a <see href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone provider</see>.
/// The <c>credentials</c> object requires different properties depending on the phone provider (which is specified using the <c>name</c> property).
/// Update a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).
/// The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property).
/// </summary>
WithRawResponseTask<UpdateBrandingPhoneProviderResponseContent> UpdateAsync(
string id,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -476,7 +476,7 @@ private async Task<WithRawResponse<CreatePhoneProviderSendTestResponseContent>>
}

/// <summary>
/// Retrieve a list of <see href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone providers</see> details set for a Tenant. A list of fields to include or exclude may also be specified.
/// Retrieve a list of [phone providers](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) details set for a Tenant. A list of fields to include or exclude may also be specified.
/// </summary>
/// <example><code>
/// await client.Branding.Phone.Providers.ListAsync(
Expand All @@ -495,8 +495,8 @@ public WithRawResponseTask<ListBrandingPhoneProvidersResponseContent> ListAsync(
}

/// <summary>
/// Create a <see href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone provider</see>.
/// The <c>credentials</c> object requires different properties depending on the phone provider (which is specified using the <c>name</c> property).
/// Create a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).
/// The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property).
/// </summary>
/// <example><code>
/// await client.Branding.Phone.Providers.CreateAsync(
Expand All @@ -519,7 +519,7 @@ public WithRawResponseTask<CreateBrandingPhoneProviderResponseContent> CreateAsy
}

/// <summary>
/// Retrieve <see href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone provider</see> details. A list of fields to include or exclude may also be specified.
/// Retrieve [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) details. A list of fields to include or exclude may also be specified.
/// </summary>
/// <example><code>
/// await client.Branding.Phone.Providers.GetAsync("id");
Expand Down Expand Up @@ -603,8 +603,8 @@ public async Task DeleteAsync(
}

/// <summary>
/// Update a <see href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone provider</see>.
/// The <c>credentials</c> object requires different properties depending on the phone provider (which is specified using the <c>name</c> property).
/// Update a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).
/// The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property).
/// </summary>
/// <example><code>
/// await client.Branding.Phone.Providers.UpdateAsync(
Expand Down
Loading
Loading