-Retrieve a list of client grants, including the scopes associated with the application/API pair.
+Retrieve a list of [client grants](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the scopes associated with the application/API pair.
-Create a client grant for a machine-to-machine login flow. To learn more, read Client Credential Flow.
+Create a client grant for a machine-to-machine login flow. To learn more, read [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow).
-Retrieve a single client grant, including the
+Retrieve a single [client grant](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the
scopes associated with the application/API pair.
-Delete the Client Credential Flow from your machine-to-machine application.
+Delete the [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) from your machine-to-machine application.
@@ -828,38 +828,30 @@ await client.ClientGrants.UpdateAsync("id", new UpdateClientGrantRequestContent(
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 and Single Sign-On.
+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.
-
-
+- 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`.
-Create a new client (application or SSO integration). For more information, read Create Applications
-API Endpoints for Single Sign-On.
+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
+- 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.
+- 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.
+- 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.
+SSO Integrations created via this endpoint will accept login requests and share user profile information.
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 and 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.
-
-
+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`.
-Updates a client's settings. For more information, read Applications in Auth0 and Single Sign-On.
+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.
+- 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.
@@ -1345,7 +1330,7 @@ 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.
+For more information, read [Rotate Client Secrets](https://www.auth0.com/docs/get-started/applications/rotate-client-secret).
@@ -2704,7 +2689,7 @@ await client.CustomDomains.VerifyAsync("id");
-Retrieve device credential information (public_key, refresh_token, or rotating_refresh_token) associated with a specific user.
+Retrieve device credential information (`public_key`, `refresh_token`, or `rotating_refresh_token`) associated with a specific user.
-Create a device credential public key to manage refresh token rotation for a given user_id. Device Credentials APIs are designed for ad-hoc administrative use only and paging is by default enabled for GET requests.
+Create a device credential public key to manage refresh token rotation for a given `user_id`. Device Credentials APIs are designed for ad-hoc administrative use only and paging is by default enabled for GET requests.
-When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read Signing Keys.
+When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read [Signing Keys](https://auth0.com/docs/get-started/tenant-settings/signing-keys).
@@ -3952,7 +3937,7 @@ await client.Forms.UpdateAsync("id", new UpdateFormRequestContent());
-Retrieve the grants associated with your account.
+Retrieve the [grants](https://auth0.com/docs/api-auth/which-oauth-flow-to-use) associated with your account.
-Delete a grant associated with your account.
+Delete a grant associated with your account.
@@ -5940,22 +5925,20 @@ await client.NetworkAcls.UpdateAsync("id", new UpdateNetworkAclRequestContent())
Retrieve detailed list of all Organizations available in your tenant. For more information, see Auth0 Organizations.
This endpoint supports two types of pagination:
-
-
Offset pagination
-
Checkpoint pagination
-
+
+- Offset pagination
+- Checkpoint pagination
Checkpoint pagination must be used if you need to retrieve more than 1000 organizations.
-
Checkpoint Pagination
+**Checkpoint Pagination**
To search by checkpoint, use the following parameters:
-
-
from: Optional id from which to start selection.
-
take: The total number of entries to retrieve when using the from parameter. Defaults to 50.
-
-Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
+- `from`: Optional id from which to start selection.
+- `take`: The total number of entries to retrieve when using the `from` parameter. Defaults to 50.
+
+**Note**: The first time you call this endpoint using checkpoint pagination, omit the `from` parameter. If there are more results, a `next` value is included in the response. You can use this for subsequent API calls. When `next` is no longer included in the response, no pages are remaining.
@@ -6016,7 +5999,7 @@ await client.Organizations.ListAsync(
-Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review Create Your First Organization.
+Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review [Create Your First Organization](https://auth0.com/docs/manage-users/organizations/create-first-organization).
-Retrieve details about a single Organization specified by ID.
+Retrieve details about a single Organization specified by ID.
@@ -6180,7 +6163,7 @@ await client.Organizations.GetAsync("id");
Remove an Organization from your tenant. This action cannot be undone.
-Note: Members are automatically disassociated from an Organization when it is deleted. However, this action does not delete these users from your tenant.
+**Note**: Members are automatically disassociated from an Organization when it is deleted. However, this action does **not** delete these users from your tenant.
@@ -6234,7 +6217,7 @@ await client.Organizations.DeleteAsync("id");
-Update the details of a specific Organization, such as name and display name, branding options, and metadata.
+Update the details of a specific [Organization](https://auth0.com/docs/manage-users/organizations/configure-organizations/create-organizations), such as name and display name, branding options, and metadata.
@@ -8786,15 +8769,14 @@ await client.Tickets.ChangePasswordAsync(new ChangePasswordTicketRequestContent(
Retrieve a list of all Token Exchange Profiles available in your tenant.
-By using this feature, you agree to the applicable Free Trial terms in Okta’s Master Subscription Agreement. It is your responsibility to securely validate the user’s subject_token. See User Guide for more details.
+By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
This endpoint supports Checkpoint pagination. To search by checkpoint, use the following parameters:
-
-
from: Optional id from which to start selection.
-
take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.
-
-Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
+- `from`: Optional id from which to start selection.
+- `take`: The total amount of entries to retrieve when using the from parameter. Defaults to 50.
+
+**Note**: The first time you call this endpoint using checkpoint pagination, omit the `from` parameter. If there are more results, a `next` value is included in the response. You can use this for subsequent API calls. When `next` is no longer included in the response, no pages are remaining.
@@ -8852,7 +8834,7 @@ await client.TokenExchangeProfiles.ListAsync(
Create a new Token Exchange Profile within your tenant.
-By using this feature, you agree to the applicable Free Trial terms in Okta’s Master Subscription Agreement. It is your responsibility to securely validate the user’s subject_token. See User Guide for more details.
+By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
@@ -8916,7 +8898,7 @@ await client.TokenExchangeProfiles.CreateAsync(
Retrieve details about a single Token Exchange Profile specified by ID.
-By using this feature, you agree to the applicable Free Trial terms in Okta’s Master Subscription Agreement. It is your responsibility to securely validate the user’s subject_token. See User Guide for more details.
+By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
@@ -8972,8 +8954,7 @@ await client.TokenExchangeProfiles.GetAsync("id");
Delete a Token Exchange Profile within your tenant.
-By using this feature, you agree to the applicable Free Trial terms in Okta's Master Subscription Agreement. It is your responsibility to securely validate the user's subject_token. See User Guide for more details.
-
+By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
@@ -9029,8 +9010,7 @@ await client.TokenExchangeProfiles.DeleteAsync("id");
Update a Token Exchange Profile within your tenant.
-By using this feature, you agree to the applicable Free Trial terms in Okta's Master Subscription Agreement. It is your responsibility to securely validate the user's subject_token. See User Guide for more details.
-
+By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
@@ -9494,7 +9474,7 @@ await client.UserAttributeProfiles.UpdateAsync(
-Retrieve details of all Brute-force Protection blocks for a user with the given identifier (username, phone number, or email).
+Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for a user with the given identifier (username, phone number, or email).
-Remove all Brute-force Protection blocks for the user with the given identifier (username, phone number, or email).
+Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given identifier (username, phone number, or email).
-Note: This endpoint does not unblock users that were blocked by a tenant administrator.
+Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user).
-Retrieve details of all Brute-force Protection blocks for the user with the given ID.
+Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID.
-Remove all Brute-force Protection blocks for the user with the given ID.
+Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID.
-Note: This endpoint does not unblock users that were blocked by a tenant administrator.
+Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user).
@@ -13165,7 +13145,7 @@ await client.ClientGrants.Organizations.ListAsync(
Get the details of a client credential.
-Important: To enable credentials to be used for a client authentication method, set the client_authentication_methods property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the signed_request_object property on the client.
+**Important**: To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client.
@@ -13221,37 +13201,61 @@ await client.Clients.Credentials.ListAsync("client_id");
Create a client credential associated to your application. Credentials can be used to configure Private Key JWT and mTLS authentication methods, as well as for JWT-secured Authorization requests.
-
Public Key
Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests.
+**Public Key**
-Sample:
{
+Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests.
+
+Sample:
+
+```json
+{
"credential_type": "public_key",
"name": "string",
"pem": "string",
"alg": "RS256",
"parse_expiry_from_cert": false,
"expires_at": "2022-12-31T23:59:59Z"
-}
-
Certificate (CA-signed & self-signed)
Certificate credentials can be used to set up mTLS client authentication. CA-signed certificates can be configured either with a signed certificate or with just the certificate Subject DN.
+}
+```
+
+**Certificate (CA-signed & self-signed)**
+
+Certificate credentials can be used to set up mTLS client authentication. CA-signed certificates can be configured either with a signed certificate or with just the certificate Subject DN.
-CA-signed Certificate Sample (pem):
+
+- To enable the credential for Private Key JWT or mTLS authentication methods, set the `client_authentication_methods` property on the client. For more information, read [Configure Private Key JWT Authentication](https://auth0.com/docs/get-started/applications/configure-private-key-jwt) and [Configure mTLS Authentication](https://auth0.com/docs/get-started/applications/configure-mtls)
+- To enable the credential for JWT-secured Authorization requests, set the `signed_request_object`property on the client. For more information, read [Configure JWT-secured Authorization Requests (JAR)](https://auth0.com/docs/get-started/applications/configure-jar)
@@ -13318,7 +13322,7 @@ await client.Clients.Credentials.CreateAsync(
Get the details of a client credential.
-Important: To enable credentials to be used for a client authentication method, set the client_authentication_methods property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the signed_request_object property on the client.
+**Important**: To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client.
@@ -13517,15 +13521,10 @@ await client.Clients.Credentials.UpdateAsync(
-Retrieve all connections that are enabled for the specified Application, using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.
-
-
- This endpoint requires the read:connections scope and any one of read:clients or read:client_summary.
-
-
- Note: The first time you call this endpoint, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no further results are remaining.
-
-
+Retrieve all connections that are enabled for the specified [Application](https://www.auth0.com/docs/get-started/applications), using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.
+
+- This endpoint requires the `read:connections` scope and any one of `read:clients` or `read:client_summary`.
+- **Note**: The first time you call this endpoint, omit the `from` parameter. If there are more results, a `next` value is included in the response. You can use this for subsequent API calls. When `next` is no longer included in the response, no further results are remaining.
-Remove a discovery domain from an organization. This action cannot be undone.
+Remove a discovery domain from an organization. This action cannot be undone.
-Update the verification status and/or use_for_organization_discovery for an organization discovery domain. The status field must be either pending or verified. The use_for_organization_discovery field can be true or false (default: true).
+Update the verification status and/or use_for_organization_discovery for an organization discovery domain. The `status` field must be either `pending` or `verified`. The `use_for_organization_discovery` field can be `true` or `false` (default: `true`).
@@ -20110,7 +20109,7 @@ await client.Organizations.EnabledConnections.ListAsync(
Enable a specific connection for a given Organization. To enable a connection, it must already exist within your tenant; connections cannot be created through this action.
-Connections represent the relationship between Auth0 and a source of users. Available types of connections include database, enterprise, and social.
+[Connections](https://auth0.com/docs/authenticate/identity-providers) represent the relationship between Auth0 and a source of users. Available types of connections include database, enterprise, and social.
@@ -20239,7 +20238,7 @@ await client.Organizations.EnabledConnections.GetAsync("id", "connectionId");
Disable a specific connection for an Organization. Once disabled, Organization members can no longer use that connection to authenticate.
-Note: This action does not remove the connection from your tenant.
+**Note**: This action does not remove the connection from your tenant.
@@ -20376,7 +20375,7 @@ await client.Organizations.EnabledConnections.UpdateAsync(
-Retrieve a detailed list of invitations sent to users for a specific Organization. The list includes details such as inviter and invitee information, invitation URLs, and dates of creation and expiration. To learn more about Organization invitations, review Invite Organization Members.
+Retrieve a detailed list of invitations sent to users for a specific Organization. The list includes details such as inviter and invitee information, invitation URLs, and dates of creation and expiration. To learn more about Organization invitations, review [Invite Organization Members](https://auth0.com/docs/manage-users/organizations/configure-organizations/invite-members).
-Create a user invitation for a specific Organization. Upon creation, the listed user receives an email inviting them to join the Organization. To learn more about Organization invitations, review Invite Organization Members.
+Create a user invitation for a specific Organization. Upon creation, the listed user receives an email inviting them to join the Organization. To learn more about Organization invitations, review [Invite Organization Members](https://auth0.com/docs/manage-users/organizations/configure-organizations/invite-members).
@@ -20631,14 +20630,8 @@ await client.Organizations.Invitations.DeleteAsync("id", "invitation_id");
List organization members.
This endpoint is subject to eventual consistency. New users may not be immediately included in the response and deleted users may not be immediately removed from it.
-
-
- Use the fields parameter to optionally define the specific member details retrieved. If fields is left blank, all fields (except roles) are returned.
-
-
- Member roles are not sent by default. Use fields=roles to retrieve the roles assigned to each listed member. To use this parameter, you must include the read:organization_member_roles scope in the token.
-
-
+- Use the `fields` parameter to optionally define the specific member details retrieved. If `fields` is left blank, all fields (except roles) are returned.
+- Member roles are not sent by default. Use `fields=roles` to retrieve the roles assigned to each listed member. To use this parameter, you must include the `read:organization_member_roles` scope in the token.
This endpoint supports two types of pagination:
@@ -20647,9 +20640,9 @@ This endpoint supports two types of pagination:
Checkpoint pagination must be used if you need to retrieve more than 1000 organization members.
-
Checkpoint Pagination
+**Checkpoint Pagination**
-To search by checkpoint, use the following parameters: - from: Optional id from which to start selection. - take: The total amount of entries to retrieve when using the from parameter. Defaults to 50. Note: The first time you call this endpoint using Checkpoint Pagination, you should omit the from parameter. If there are more results, a next value will be included in the response. You can use this for subsequent API calls. When next is no longer included in the response, this indicates there are no more pages remaining.
+To search by checkpoint, use the following parameters: - from: Optional id from which to start selection. - take: The total amount of entries to retrieve when using the from parameter. Defaults to 50. Note: The first time you call this endpoint using Checkpoint Pagination, you should omit the `from` parameter. If there are more results, a `next` value will be included in the response. You can use this for subsequent API calls. When `next` is no longer included in the response, this indicates there are no more pages remaining.
@@ -20720,9 +20713,9 @@ await client.Organizations.Members.ListAsync(
-Set one or more existing users as members of a specific Organization.
+Set one or more existing users as members of a specific [Organization](https://auth0.com/docs/manage-users/organizations).
-To add a user to an Organization through this action, the user must already exist in your tenant. If a user does not yet exist, you can invite them to create an account, manually create them through the Auth0 Dashboard, or use the Management API.
+To add a user to an Organization through this action, the user must already exist in your tenant. If a user does not yet exist, you can [invite them to create an account](https://auth0.com/docs/manage-users/organizations/configure-organizations/invite-members), manually create them through the Auth0 Dashboard, or use the Management API.
-Retrieve detailed list of roles assigned to a given user within the context of a specific Organization.
-
-Users can be members of multiple Organizations with unique roles assigned for each membership. This action only returns the roles associated with the specified Organization; any roles assigned to the user within other Organizations are not included.
+Lists the groups that are assigned to the specified organization.
@@ -20856,15 +20847,9 @@ Users can be members of multiple Organizations with unique roles assigned for ea
-Assign one or more roles to a user to determine their access for a specific Organization.
-
-Users can be members of multiple Organizations with unique roles assigned for each membership. This action assigns roles to a user only for the specified Organization. Roles cannot be assigned to a user across multiple Organizations in the same call.
+Lists the roles assigned to the specified group in the context of an organization.
@@ -20937,10 +20913,10 @@ Users can be members of multiple Organizations with unique roles assigned for ea
```csharp
-await client.Organizations.Members.Roles.AssignAsync(
- "id",
- "user_id",
- new AssignOrganizationMemberRolesRequestContent { Roles = new List() { "roles" } }
+await client.Organizations.Groups.Roles.ListAsync(
+ "organization_id",
+ "group_id",
+ new ListOrganizationGroupRolesRequestParameters { From = "from", Take = 1 }
);
```
-Remove one or more Organization-specific roles from a given user.
-
-Users can be members of multiple Organizations with unique roles assigned for each membership. This action removes roles from a user in relation to the specified Organization. Roles assigned to the user within a different Organization cannot be managed in the same call.
+Assign one or more roles to a specified group in the context of an organization.
@@ -21013,10 +20987,10 @@ Users can be members of multiple Organizations with unique roles assigned for ea
```csharp
-await client.Organizations.Members.Roles.DeleteAsync(
- "id",
- "user_id",
- new DeleteOrganizationMemberRolesRequestContent { Roles = new List() { "roles" } }
+await client.Organizations.Groups.Roles.CreateAsync(
+ "organization_id",
+ "group_id",
+ new CreateOrganizationGroupRolesRequestContent { Roles = new List() { "roles" } }
);
```
-Learn more about [configuring render settings](https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens) for advanced customization.
+Lists the roles assigned to an organization member directly or through group membership.
@@ -21154,18 +21136,10 @@ Learn more about [configuring render settings](https://auth0.com/docs/customize/
```csharp
-await client.Prompts.Rendering.BulkUpdateAsync(
- new BulkUpdateAculRequestContent
- {
- Configs = new List()
- {
- new AculConfigsItem
- {
- Prompt = PromptGroupNameEnum.Login,
- Screen = ScreenGroupNameEnum.Login,
- },
- },
- }
+await client.Organizations.Members.EffectiveRoles.ListAsync(
+ "id",
+ "user_id",
+ new ListOrganizationMemberEffectiveRolesRequestParameters { From = "from", Take = 1 }
);
```
-Get render settings for a screen.
+Retrieve detailed list of roles assigned to a given user within the context of a specific Organization.
+
+Users can be members of multiple Organizations with unique roles assigned for each membership. This action only returns the roles associated with the specified Organization; any roles assigned to the user within other Organizations are not included.
@@ -21220,7 +21213,16 @@ Get render settings for a screen.
-Learn more about [configuring render settings](https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens) for advanced customization.
+Assign one or more [roles](https://auth0.com/docs/manage-users/access-control/rbac) to a user to determine their access for a specific Organization.
+
+Users can be members of multiple Organizations with unique roles assigned for each membership. This action assigns roles to a user only for the specified Organization. Roles cannot be assigned to a user across multiple Organizations in the same call.
@@ -21282,10 +21294,10 @@ Learn more about [configuring render settings](https://auth0.com/docs/customize/
```csharp
-await client.Prompts.Rendering.UpdateAsync(
- PromptGroupNameEnum.Login,
- ScreenGroupNameEnum.Login,
- new UpdateAculRequestContent()
+await client.Organizations.Members.Roles.AssignAsync(
+ "id",
+ "user_id",
+ new AssignOrganizationMemberRolesRequestContent { Roles = new List() { "roles" } }
);
```
-Retrieve custom text for a specific prompt and language.
+Remove one or more Organization-specific [roles](https://auth0.com/docs/manage-users/access-control/rbac) from a given user.
+
+Users can be members of multiple Organizations with unique roles assigned for each membership. This action removes roles from a user in relation to the specified Organization. Roles assigned to the user within a different Organization cannot be managed in the same call.
@@ -21357,7 +21370,11 @@ Retrieve custom text for a specific prompt and language.
+
+Learn more about [configuring render settings](https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens) for advanced customization.
+
+
+Learn more about [configuring render settings](https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens) for advanced customization.
+
+
+Returns the list of effective permissions for a user, taking into account permissions granted directly to the user, as well as those inherited through roles and group memberships.
+
+
+
+
+
+#### 🔌 Usage
+
+
+
+
+
+
+
+```csharp
+await client.Users.EffectivePermissions.ListAsync(
+ "id",
+ new ListUserEffectivePermissionsRequestParameters
+ {
+ From = "from",
+ Take = 1,
+ ResourceServerIdentifier = "resource_server_identifier",
+ }
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+
+
+
+
+
+**id:** `string` — ID of the user to retrieve the permissions for.
+
+
+
+Lists the roles which grant the user a given permission, including roles assigned directly to the user and those inherited through group memberships.
+
diff --git a/src/Auth0.ManagementApi/ClientGrants/ClientGrantsClient.cs b/src/Auth0.ManagementApi/ClientGrants/ClientGrantsClient.cs
index 3138acb5c..490e71cc3 100644
--- a/src/Auth0.ManagementApi/ClientGrants/ClientGrantsClient.cs
+++ b/src/Auth0.ManagementApi/ClientGrants/ClientGrantsClient.cs
@@ -16,7 +16,7 @@ internal ClientGrantsClient(RawClient client)
public Auth0.ManagementApi.ClientGrants.IOrganizationsClient Organizations { get; }
///
- /// Retrieve a list of client grants, including the scopes associated with the application/API pair.
+ /// Retrieve a list of [client grants](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the scopes associated with the application/API pair.
///
private WithRawResponseTask ListInternalAsync(
ListClientGrantsRequestParameters request,
@@ -401,7 +401,7 @@ private async Task> UpdateAsyn
}
///
- /// Retrieve a list of client grants, including the scopes associated with the application/API pair.
+ /// Retrieve a list of [client grants](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the scopes associated with the application/API pair.
///
///
/// await client.ClientGrants.ListAsync(
@@ -452,7 +452,7 @@ await ListInternalAsync(request, options, cancellationToken).WithRawResponse(),
}
///
- /// Create a client grant for a machine-to-machine login flow. To learn more, read Client Credential Flow.
+ /// Create a client grant for a machine-to-machine login flow. To learn more, read [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow).
///
///
/// await client.ClientGrants.CreateAsync(
@@ -471,7 +471,7 @@ public WithRawResponseTask CreateAsync(
}
///
- /// Retrieve a single client grant, including the
+ /// Retrieve a single [client grant](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the
/// scopes associated with the application/API pair.
///
///
@@ -489,7 +489,7 @@ public WithRawResponseTask GetAsync(
}
///
- /// Delete the Client Credential Flow from your machine-to-machine application.
+ /// Delete the [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) from your machine-to-machine application.
///
///
/// await client.ClientGrants.DeleteAsync("id");
diff --git a/src/Auth0.ManagementApi/ClientGrants/IClientGrantsClient.cs b/src/Auth0.ManagementApi/ClientGrants/IClientGrantsClient.cs
index 0b298afff..169118473 100644
--- a/src/Auth0.ManagementApi/ClientGrants/IClientGrantsClient.cs
+++ b/src/Auth0.ManagementApi/ClientGrants/IClientGrantsClient.cs
@@ -7,7 +7,7 @@ public partial interface IClientGrantsClient
public Auth0.ManagementApi.ClientGrants.IOrganizationsClient Organizations { get; }
///
- /// Retrieve a list of client grants, including the scopes associated with the application/API pair.
+ /// Retrieve a list of [client grants](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the scopes associated with the application/API pair.
///
Task> ListAsync(
ListClientGrantsRequestParameters request,
@@ -16,7 +16,7 @@ Task> ListAsync(
);
///
- /// Create a client grant for a machine-to-machine login flow. To learn more, read Client Credential Flow.
+ /// Create a client grant for a machine-to-machine login flow. To learn more, read [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow).
///
WithRawResponseTask CreateAsync(
CreateClientGrantRequestContent request,
@@ -25,7 +25,7 @@ WithRawResponseTask CreateAsync(
);
///
- /// Retrieve a single client grant, including the
+ /// Retrieve a single [client grant](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the
/// scopes associated with the application/API pair.
///
WithRawResponseTask GetAsync(
@@ -35,7 +35,7 @@ WithRawResponseTask GetAsync(
);
///
- /// Delete the Client Credential Flow from your machine-to-machine application.
+ /// Delete the [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) from your machine-to-machine application.
///
Task DeleteAsync(
string id,
diff --git a/src/Auth0.ManagementApi/Clients/ClientsClient.cs b/src/Auth0.ManagementApi/Clients/ClientsClient.cs
index a0f3e638d..92c5ad6f4 100644
--- a/src/Auth0.ManagementApi/Clients/ClientsClient.cs
+++ b/src/Auth0.ManagementApi/Clients/ClientsClient.cs
@@ -21,38 +21,30 @@ internal ClientsClient(RawClient client)
///
/// 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 and Single Sign-On.
+ /// 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.
- ///
- ///
+ /// - 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`.
///
private WithRawResponseTask ListInternalAsync(
ListClientsRequestParameters request,
@@ -726,38 +718,30 @@ private async Task> RotateSec
///
/// 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 and Single Sign-On.
+ /// 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.
- ///
- ///
+ /// - 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`.
///
///
/// await client.Clients.ListAsync(
@@ -811,18 +795,18 @@ await ListInternalAsync(request, options, cancellationToken).WithRawResponse(),
}
///
- /// Create a new client (application or SSO integration). For more information, read Create Applications
- /// .
+ /// 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
+ /// - 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.
+ /// - 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.
+ /// - 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.
///
@@ -894,36 +878,29 @@ public WithRawResponseTask RegisterCimdClient
///
/// 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 and 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.
- ///
- ///
+ /// 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`.
///
///
/// await client.Clients.GetAsync(
@@ -1008,15 +985,15 @@ public async Task DeleteAsync(
}
///
- /// Updates a client's settings. For more information, read Applications in Auth0 and Single Sign-On.
+ /// 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.
+ /// - 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.
///
///
/// await client.Clients.UpdateAsync("id", new UpdateClientRequestContent());
@@ -1038,7 +1015,7 @@ public WithRawResponseTask UpdateAsync(
///
/// 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.
+ /// For more information, read [Rotate Client Secrets](https://www.auth0.com/docs/get-started/applications/rotate-client-secret).
///
///
/// await client.Clients.RotateSecretAsync("id");
diff --git a/src/Auth0.ManagementApi/Clients/Connections/ConnectionsClient.cs b/src/Auth0.ManagementApi/Clients/Connections/ConnectionsClient.cs
index df29fc159..25ac076fb 100644
--- a/src/Auth0.ManagementApi/Clients/Connections/ConnectionsClient.cs
+++ b/src/Auth0.ManagementApi/Clients/Connections/ConnectionsClient.cs
@@ -14,15 +14,10 @@ internal ConnectionsClient(RawClient client)
}
///
- /// Retrieve all connections that are enabled for the specified Application, using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.
- ///
- ///
- /// This endpoint requires the read:connections scope and any one of read:clients or read:client_summary.
- ///
- ///
- /// Note: The first time you call this endpoint, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no further results are remaining.
- ///
- ///
+ /// Retrieve all connections that are enabled for the specified [Application](https://www.auth0.com/docs/get-started/applications), using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.
+ ///
+ /// - This endpoint requires the `read:connections` scope and any one of `read:clients` or `read:client_summary`.
+ /// - **Note**: The first time you call this endpoint, omit the `from` parameter. If there are more results, a `next` value is included in the response. You can use this for subsequent API calls. When `next` is no longer included in the response, no further results are remaining.
///
private WithRawResponseTask GetInternalAsync(
string id,
@@ -140,15 +135,10 @@ private async Task> GetInt
}
///
- /// Retrieve all connections that are enabled for the specified Application, using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.
- ///
- ///
- /// This endpoint requires the read:connections scope and any one of read:clients or read:client_summary.
- ///
- ///
- /// Note: The first time you call this endpoint, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no further results are remaining.
- ///
- ///
+ /// Retrieve all connections that are enabled for the specified [Application](https://www.auth0.com/docs/get-started/applications), using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.
+ ///
+ /// - This endpoint requires the `read:connections` scope and any one of `read:clients` or `read:client_summary`.
+ /// - **Note**: The first time you call this endpoint, omit the `from` parameter. If there are more results, a `next` value is included in the response. You can use this for subsequent API calls. When `next` is no longer included in the response, no further results are remaining.
///
///
/// await client.Clients.Connections.GetAsync(
diff --git a/src/Auth0.ManagementApi/Clients/Connections/IConnectionsClient.cs b/src/Auth0.ManagementApi/Clients/Connections/IConnectionsClient.cs
index 4450b9300..9264856a3 100644
--- a/src/Auth0.ManagementApi/Clients/Connections/IConnectionsClient.cs
+++ b/src/Auth0.ManagementApi/Clients/Connections/IConnectionsClient.cs
@@ -6,15 +6,10 @@ namespace Auth0.ManagementApi.Clients;
public partial interface IConnectionsClient
{
///
- /// Retrieve all connections that are enabled for the specified Application, using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.
- ///
- ///
- /// This endpoint requires the read:connections scope and any one of read:clients or read:client_summary.
- ///
- ///
- /// Note: The first time you call this endpoint, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no further results are remaining.
- ///
- ///
+ /// Retrieve all connections that are enabled for the specified [Application](https://www.auth0.com/docs/get-started/applications), using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.
+ ///
+ /// - This endpoint requires the `read:connections` scope and any one of `read:clients` or `read:client_summary`.
+ /// - **Note**: The first time you call this endpoint, omit the `from` parameter. If there are more results, a `next` value is included in the response. You can use this for subsequent API calls. When `next` is no longer included in the response, no further results are remaining.
///
Task> GetAsync(
string id,
diff --git a/src/Auth0.ManagementApi/Clients/Credentials/CredentialsClient.cs b/src/Auth0.ManagementApi/Clients/Credentials/CredentialsClient.cs
index 7c8b38dc4..95f0eaf9f 100644
--- a/src/Auth0.ManagementApi/Clients/Credentials/CredentialsClient.cs
+++ b/src/Auth0.ManagementApi/Clients/Credentials/CredentialsClient.cs
@@ -382,7 +382,7 @@ private async Task> Update
///
/// Get the details of a client credential.
///
- /// Important: To enable credentials to be used for a client authentication method, set the client_authentication_methods property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the signed_request_object property on the client.
+ /// **Important**: To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client.
///
///
/// await client.Clients.Credentials.ListAsync("client_id");
@@ -401,37 +401,61 @@ public WithRawResponseTask> ListAsync(
///
/// Create a client credential associated to your application. Credentials can be used to configure Private Key JWT and mTLS authentication methods, as well as for JWT-secured Authorization requests.
///
- /// Public KeyPublic Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests.
+ /// **Public Key**
///
- /// Sample: {
+ /// Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests.
+ ///
+ /// Sample:
+ ///
+ /// ```json
+ /// {
/// "credential_type": "public_key",
/// "name": "string",
/// "pem": "string",
/// "alg": "RS256",
/// "parse_expiry_from_cert": false,
/// "expires_at": "2022-12-31T23:59:59Z"
- /// }
- /// Certificate (CA-signed & self-signed)Certificate credentials can be used to set up mTLS client authentication. CA-signed certificates can be configured either with a signed certificate or with just the certificate Subject DN.
+ /// }
+ /// ```
+ ///
+ /// **Certificate (CA-signed & self-signed)**
+ ///
+ /// Certificate credentials can be used to set up mTLS client authentication. CA-signed certificates can be configured either with a signed certificate or with just the certificate Subject DN.
+ ///
+ /// CA-signed Certificate Sample (pem):
///
- /// CA-signed Certificate Sample (pem): {
+ /// ```json
+ /// {
/// "credential_type": "x509_cert",
/// "name": "string",
/// "pem": "string"
- /// }CA-signed Certificate Sample (subject_dn): {
+ /// }
+ /// ```
+ ///
+ /// CA-signed Certificate Sample (subject_dn):
+ ///
+ /// ```json
+ /// {
/// "credential_type": "cert_subject_dn",
/// "name": "string",
/// "subject_dn": "string"
- /// }Self-signed Certificate Sample: {
+ /// }
+ /// ```
+ ///
+ /// Self-signed Certificate Sample:
+ ///
+ /// ```json
+ /// {
/// "credential_type": "cert_subject_dn",
/// "name": "string",
/// "pem": "string"
- /// }
+ /// }
+ /// ```
///
/// The credential will be created but not yet enabled for use until you set the corresponding properties in the client:
- ///
- /// To enable the credential for Private Key JWT or mTLS authentication methods, set the client_authentication_methods property on the client. For more information, read Configure Private Key JWT Authentication and Configure mTLS Authentication
- /// To enable the credential for JWT-secured Authorization requests, set the signed_request_objectproperty on the client. For more information, read Configure JWT-secured Authorization Requests (JAR)
- ///
+ ///
+ /// - To enable the credential for Private Key JWT or mTLS authentication methods, set the `client_authentication_methods` property on the client. For more information, read [Configure Private Key JWT Authentication](https://auth0.com/docs/get-started/applications/configure-private-key-jwt) and [Configure mTLS Authentication](https://auth0.com/docs/get-started/applications/configure-mtls)
+ /// - To enable the credential for JWT-secured Authorization requests, set the `signed_request_object`property on the client. For more information, read [Configure JWT-secured Authorization Requests (JAR)](https://auth0.com/docs/get-started/applications/configure-jar)
///
///
/// await client.Clients.Credentials.CreateAsync(
@@ -454,7 +478,7 @@ public WithRawResponseTask CreateAsync(
///
/// Get the details of a client credential.
///
- /// Important: To enable credentials to be used for a client authentication method, set the client_authentication_methods property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the signed_request_object property on the client.
+ /// **Important**: To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client.
///
///
/// await client.Clients.Credentials.GetAsync("client_id", "credential_id");
diff --git a/src/Auth0.ManagementApi/Clients/Credentials/ICredentialsClient.cs b/src/Auth0.ManagementApi/Clients/Credentials/ICredentialsClient.cs
index 65e657cd6..d267a38c3 100644
--- a/src/Auth0.ManagementApi/Clients/Credentials/ICredentialsClient.cs
+++ b/src/Auth0.ManagementApi/Clients/Credentials/ICredentialsClient.cs
@@ -7,7 +7,7 @@ public partial interface ICredentialsClient
///
/// Get the details of a client credential.
///
- /// Important: To enable credentials to be used for a client authentication method, set the client_authentication_methods property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the signed_request_object property on the client.
+ /// **Important**: To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client.
///
WithRawResponseTask> ListAsync(
string clientId,
@@ -18,37 +18,61 @@ WithRawResponseTask> ListAsync(
///
/// Create a client credential associated to your application. Credentials can be used to configure Private Key JWT and mTLS authentication methods, as well as for JWT-secured Authorization requests.
///
- /// Public KeyPublic Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests.
+ /// **Public Key**
///
- /// Sample: {
+ /// Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests.
+ ///
+ /// Sample:
+ ///
+ /// ```json
+ /// {
/// "credential_type": "public_key",
/// "name": "string",
/// "pem": "string",
/// "alg": "RS256",
/// "parse_expiry_from_cert": false,
/// "expires_at": "2022-12-31T23:59:59Z"
- /// }
- /// Certificate (CA-signed & self-signed)Certificate credentials can be used to set up mTLS client authentication. CA-signed certificates can be configured either with a signed certificate or with just the certificate Subject DN.
+ /// }
+ /// ```
+ ///
+ /// **Certificate (CA-signed & self-signed)**
+ ///
+ /// Certificate credentials can be used to set up mTLS client authentication. CA-signed certificates can be configured either with a signed certificate or with just the certificate Subject DN.
+ ///
+ /// CA-signed Certificate Sample (pem):
///
- /// CA-signed Certificate Sample (pem): {
+ /// ```json
+ /// {
/// "credential_type": "x509_cert",
/// "name": "string",
/// "pem": "string"
- /// }CA-signed Certificate Sample (subject_dn): {
+ /// }
+ /// ```
+ ///
+ /// CA-signed Certificate Sample (subject_dn):
+ ///
+ /// ```json
+ /// {
/// "credential_type": "cert_subject_dn",
/// "name": "string",
/// "subject_dn": "string"
- /// }Self-signed Certificate Sample: {
+ /// }
+ /// ```
+ ///
+ /// Self-signed Certificate Sample:
+ ///
+ /// ```json
+ /// {
/// "credential_type": "cert_subject_dn",
/// "name": "string",
/// "pem": "string"
- /// }
+ /// }
+ /// ```
///
/// The credential will be created but not yet enabled for use until you set the corresponding properties in the client:
- ///
- /// To enable the credential for Private Key JWT or mTLS authentication methods, set the client_authentication_methods property on the client. For more information, read Configure Private Key JWT Authentication and Configure mTLS Authentication
- /// To enable the credential for JWT-secured Authorization requests, set the signed_request_objectproperty on the client. For more information, read Configure JWT-secured Authorization Requests (JAR)
- ///
+ ///
+ /// - To enable the credential for Private Key JWT or mTLS authentication methods, set the `client_authentication_methods` property on the client. For more information, read [Configure Private Key JWT Authentication](https://auth0.com/docs/get-started/applications/configure-private-key-jwt) and [Configure mTLS Authentication](https://auth0.com/docs/get-started/applications/configure-mtls)
+ /// - To enable the credential for JWT-secured Authorization requests, set the `signed_request_object`property on the client. For more information, read [Configure JWT-secured Authorization Requests (JAR)](https://auth0.com/docs/get-started/applications/configure-jar)
///
WithRawResponseTask CreateAsync(
string clientId,
@@ -60,7 +84,7 @@ WithRawResponseTask CreateAsync(
///
/// Get the details of a client credential.
///
- /// Important: To enable credentials to be used for a client authentication method, set the client_authentication_methods property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the signed_request_object property on the client.
+ /// **Important**: To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client.
///
WithRawResponseTask GetAsync(
string clientId,
diff --git a/src/Auth0.ManagementApi/Clients/IClientsClient.cs b/src/Auth0.ManagementApi/Clients/IClientsClient.cs
index b414be580..1d29160d1 100644
--- a/src/Auth0.ManagementApi/Clients/IClientsClient.cs
+++ b/src/Auth0.ManagementApi/Clients/IClientsClient.cs
@@ -10,38 +10,30 @@ public partial interface IClientsClient
///
/// 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 and Single Sign-On.
+ /// 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.
- ///
- ///
+ /// - 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`.
///
Task> ListAsync(
ListClientsRequestParameters request,
@@ -50,18 +42,18 @@ Task> ListAsync(
);
///
- /// Create a new client (application or SSO integration). For more information, read Create Applications
- /// .
+ /// 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
+ /// - 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.
+ /// - 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.
+ /// - 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.
///
@@ -105,36 +97,29 @@ WithRawResponseTask RegisterCimdClientAsync(
///
/// 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 and 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.
- ///
- ///
+ /// 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`.
///
WithRawResponseTask GetAsync(
string id,
@@ -153,15 +138,15 @@ Task DeleteAsync(
);
///
- /// Updates a client's settings. For more information, read Applications in Auth0 and Single Sign-On.
+ /// 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.
+ /// - 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.
///
WithRawResponseTask UpdateAsync(
string id,
@@ -175,7 +160,7 @@ WithRawResponseTask UpdateAsync(
///
/// 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.
+ /// For more information, read [Rotate Client Secrets](https://www.auth0.com/docs/get-started/applications/rotate-client-secret).
///
WithRawResponseTask RotateSecretAsync(
string id,
diff --git a/src/Auth0.ManagementApi/DeviceCredentials/DeviceCredentialsClient.cs b/src/Auth0.ManagementApi/DeviceCredentials/DeviceCredentialsClient.cs
index 913c34fbe..75dacd5a0 100644
--- a/src/Auth0.ManagementApi/DeviceCredentials/DeviceCredentialsClient.cs
+++ b/src/Auth0.ManagementApi/DeviceCredentials/DeviceCredentialsClient.cs
@@ -13,7 +13,7 @@ internal DeviceCredentialsClient(RawClient client)
}
///
- /// Retrieve device credential information (public_key, refresh_token, or rotating_refresh_token) associated with a specific user.
+ /// Retrieve device credential information (`public_key`, `refresh_token`, or `rotating_refresh_token`) associated with a specific user.
///
private WithRawResponseTask ListInternalAsync(
ListDeviceCredentialsRequestParameters request,
@@ -225,7 +225,7 @@ private async Task<
}
///
- /// Retrieve device credential information (public_key, refresh_token, or rotating_refresh_token) associated with a specific user.
+ /// Retrieve device credential information (`public_key`, `refresh_token`, or `rotating_refresh_token`) associated with a specific user.
///
///
/// await client.DeviceCredentials.ListAsync(
@@ -277,9 +277,9 @@ await ListInternalAsync(request, options, cancellationToken).WithRawResponse(),
}
///
- /// Create a device credential public key to manage refresh token rotation for a given user_id. Device Credentials APIs are designed for ad-hoc administrative use only and paging is by default enabled for GET requests.
+ /// Create a device credential public key to manage refresh token rotation for a given `user_id`. Device Credentials APIs are designed for ad-hoc administrative use only and paging is by default enabled for GET requests.
///
- /// When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read Signing Keys.
+ /// When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read [Signing Keys](https://auth0.com/docs/get-started/tenant-settings/signing-keys).
///
///
/// await client.DeviceCredentials.CreatePublicKeyAsync(
diff --git a/src/Auth0.ManagementApi/DeviceCredentials/IDeviceCredentialsClient.cs b/src/Auth0.ManagementApi/DeviceCredentials/IDeviceCredentialsClient.cs
index cdbe0ed51..2eab6be27 100644
--- a/src/Auth0.ManagementApi/DeviceCredentials/IDeviceCredentialsClient.cs
+++ b/src/Auth0.ManagementApi/DeviceCredentials/IDeviceCredentialsClient.cs
@@ -5,7 +5,7 @@ namespace Auth0.ManagementApi;
public partial interface IDeviceCredentialsClient
{
///
- /// Retrieve device credential information (public_key, refresh_token, or rotating_refresh_token) associated with a specific user.
+ /// Retrieve device credential information (`public_key`, `refresh_token`, or `rotating_refresh_token`) associated with a specific user.
///
Task> ListAsync(
ListDeviceCredentialsRequestParameters request,
@@ -14,9 +14,9 @@ Task> ListAsync(
);
///
- /// Create a device credential public key to manage refresh token rotation for a given user_id. Device Credentials APIs are designed for ad-hoc administrative use only and paging is by default enabled for GET requests.
+ /// Create a device credential public key to manage refresh token rotation for a given `user_id`. Device Credentials APIs are designed for ad-hoc administrative use only and paging is by default enabled for GET requests.
///
- /// When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read Signing Keys.
+ /// When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read [Signing Keys](https://auth0.com/docs/get-started/tenant-settings/signing-keys).
///
WithRawResponseTask CreatePublicKeyAsync(
CreatePublicKeyDeviceCredentialRequestContent request,
diff --git a/src/Auth0.ManagementApi/Organizations/DiscoveryDomains/DiscoveryDomainsClient.cs b/src/Auth0.ManagementApi/Organizations/DiscoveryDomains/DiscoveryDomainsClient.cs
index 30766708f..ed442be47 100644
--- a/src/Auth0.ManagementApi/Organizations/DiscoveryDomains/DiscoveryDomainsClient.cs
+++ b/src/Auth0.ManagementApi/Organizations/DiscoveryDomains/DiscoveryDomainsClient.cs
@@ -682,7 +682,7 @@ public async Task DeleteAsync(
}
///
- /// Update the verification status and/or use_for_organization_discovery for an organization discovery domain. The status field must be either pending or verified. The use_for_organization_discovery field can be true or false (default: true).
+ /// Update the verification status and/or use_for_organization_discovery for an organization discovery domain. The `status` field must be either `pending` or `verified`. The `use_for_organization_discovery` field can be `true` or `false` (default: `true`).
///
///
/// await client.Organizations.DiscoveryDomains.UpdateAsync(
diff --git a/src/Auth0.ManagementApi/Organizations/DiscoveryDomains/IDiscoveryDomainsClient.cs b/src/Auth0.ManagementApi/Organizations/DiscoveryDomains/IDiscoveryDomainsClient.cs
index 69784c167..ee89effd0 100644
--- a/src/Auth0.ManagementApi/Organizations/DiscoveryDomains/IDiscoveryDomainsClient.cs
+++ b/src/Auth0.ManagementApi/Organizations/DiscoveryDomains/IDiscoveryDomainsClient.cs
@@ -59,7 +59,7 @@ Task DeleteAsync(
);
///
- /// Update the verification status and/or use_for_organization_discovery for an organization discovery domain. The status field must be either pending or verified. The use_for_organization_discovery field can be true or false (default: true).
+ /// Update the verification status and/or use_for_organization_discovery for an organization discovery domain. The `status` field must be either `pending` or `verified`. The `use_for_organization_discovery` field can be `true` or `false` (default: `true`).
///
WithRawResponseTask UpdateAsync(
string id,
diff --git a/src/Auth0.ManagementApi/Organizations/EnabledConnections/EnabledConnectionsClient.cs b/src/Auth0.ManagementApi/Organizations/EnabledConnections/EnabledConnectionsClient.cs
index 4455b9263..a885f54b9 100644
--- a/src/Auth0.ManagementApi/Organizations/EnabledConnections/EnabledConnectionsClient.cs
+++ b/src/Auth0.ManagementApi/Organizations/EnabledConnections/EnabledConnectionsClient.cs
@@ -458,7 +458,7 @@ await ListInternalAsync(id, request, options, cancellationToken)
///
/// Enable a specific connection for a given Organization. To enable a connection, it must already exist within your tenant; connections cannot be created through this action.
///
- /// Connections represent the relationship between Auth0 and a source of users. Available types of connections include database, enterprise, and social.
+ /// [Connections](https://auth0.com/docs/authenticate/identity-providers) represent the relationship between Auth0 and a source of users. Available types of connections include database, enterprise, and social.
///
///
/// await client.Organizations.EnabledConnections.AddAsync(
@@ -499,7 +499,7 @@ public WithRawResponseTask GetAsync(
///
/// Disable a specific connection for an Organization. Once disabled, Organization members can no longer use that connection to authenticate.
///
- /// Note: This action does not remove the connection from your tenant.
+ /// **Note**: This action does not remove the connection from your tenant.
///
///
/// await client.Organizations.EnabledConnections.DeleteAsync("id", "connectionId");
diff --git a/src/Auth0.ManagementApi/Organizations/EnabledConnections/IEnabledConnectionsClient.cs b/src/Auth0.ManagementApi/Organizations/EnabledConnections/IEnabledConnectionsClient.cs
index 19a9cd4fd..b8151e249 100644
--- a/src/Auth0.ManagementApi/Organizations/EnabledConnections/IEnabledConnectionsClient.cs
+++ b/src/Auth0.ManagementApi/Organizations/EnabledConnections/IEnabledConnectionsClient.cs
@@ -18,7 +18,7 @@ Task> ListAsync(
///
/// Enable a specific connection for a given Organization. To enable a connection, it must already exist within your tenant; connections cannot be created through this action.
///
- /// Connections represent the relationship between Auth0 and a source of users. Available types of connections include database, enterprise, and social.
+ /// [Connections](https://auth0.com/docs/authenticate/identity-providers) represent the relationship between Auth0 and a source of users. Available types of connections include database, enterprise, and social.
///
WithRawResponseTask AddAsync(
string id,
@@ -40,7 +40,7 @@ WithRawResponseTask GetAsync(
///
/// Disable a specific connection for an Organization. Once disabled, Organization members can no longer use that connection to authenticate.
///
- /// Note: This action does not remove the connection from your tenant.
+ /// **Note**: This action does not remove the connection from your tenant.
///
Task DeleteAsync(
string id,
diff --git a/src/Auth0.ManagementApi/Organizations/Groups/GroupsClient.cs b/src/Auth0.ManagementApi/Organizations/Groups/GroupsClient.cs
new file mode 100644
index 000000000..54712abb8
--- /dev/null
+++ b/src/Auth0.ManagementApi/Organizations/Groups/GroupsClient.cs
@@ -0,0 +1,175 @@
+using Auth0.ManagementApi;
+using Auth0.ManagementApi.Core;
+using global::System.Text.Json;
+
+namespace Auth0.ManagementApi.Organizations;
+
+public partial class GroupsClient : IGroupsClient
+{
+ private readonly RawClient _client;
+
+ internal GroupsClient(RawClient client)
+ {
+ _client = client;
+ Roles = new Auth0.ManagementApi.Organizations.Groups.RolesClient(_client);
+ }
+
+ public Auth0.ManagementApi.Organizations.Groups.IRolesClient Roles { get; }
+
+ ///
+ /// Lists the groups that are assigned to the specified organization.
+ ///
+ private WithRawResponseTask ListInternalAsync(
+ string organizationId,
+ ListOrganizationGroupsRequestParameters request,
+ RequestOptions? options = null,
+ CancellationToken cancellationToken = default
+ )
+ {
+ return new WithRawResponseTask(
+ ListInternalAsyncCore(organizationId, request, options, cancellationToken)
+ );
+ }
+
+ private async Task<
+ WithRawResponse
+ > ListInternalAsyncCore(
+ string organizationId,
+ ListOrganizationGroupsRequestParameters request,
+ RequestOptions? options = null,
+ CancellationToken cancellationToken = default
+ )
+ {
+ var _queryString = new Auth0.ManagementApi.Core.QueryStringBuilder.Builder(capacity: 2)
+ .Add("from", request.From.IsDefined ? request.From.Value : null)
+ .Add("take", request.Take.IsDefined ? request.Take.Value : null)
+ .MergeAdditional(options?.AdditionalQueryParameters)
+ .Build();
+ var _headers = await new Auth0.ManagementApi.Core.HeadersBuilder.Builder()
+ .Add(_client.Options.Headers)
+ .Add(_client.Options.AdditionalHeaders)
+ .Add(options?.AdditionalHeaders)
+ .BuildAsync()
+ .ConfigureAwait(false);
+ var response = await _client
+ .SendRequestAsync(
+ new JsonRequest
+ {
+ Method = HttpMethod.Get,
+ Path = string.Format(
+ "organizations/{0}/groups",
+ ValueConvert.ToPathParameterString(organizationId)
+ ),
+ QueryString = _queryString,
+ Headers = _headers,
+ Options = options,
+ },
+ cancellationToken
+ )
+ .ConfigureAwait(false);
+ if (response.StatusCode is >= 200 and < 400)
+ {
+ var responseBody = await response
+ .Raw.Content.ReadAsStringAsync(cancellationToken)
+ .ConfigureAwait(false);
+ try
+ {
+ var responseData = JsonUtils.Deserialize(
+ responseBody
+ )!;
+ return new WithRawResponse()
+ {
+ Data = responseData,
+ RawResponse = new RawResponse()
+ {
+ StatusCode = response.Raw.StatusCode,
+ Url = response.Raw.RequestMessage?.RequestUri ?? new Uri("about:blank"),
+ Headers = ResponseHeaders.FromHttpResponseMessage(response.Raw),
+ },
+ };
+ }
+ catch (JsonException e)
+ {
+ throw new ManagementApiException(
+ "Failed to deserialize response",
+ response.StatusCode,
+ null,
+ e
+ );
+ }
+ }
+ {
+ var responseBody = await response
+ .Raw.Content.ReadAsStringAsync(cancellationToken)
+ .ConfigureAwait(false);
+ try
+ {
+ switch (response.StatusCode)
+ {
+ case 400:
+ throw new BadRequestError(JsonUtils.Deserialize