InstanceSettingsApi.md

\InstanceSettingsApi

All URIs are relative to https://api.clerk.dev/v1

Method	HTTP request	Description
update_instance	PATCH /instance	Update instance settings
update_instance_organization_settings	PATCH /instance/organization_settings	Update instance organization settings
update_instance_restrictions	PATCH /instance/restrictions	Update instance restrictions

update_instance

update_instance(update_instance_request) Update instance settings

Updates the settings of an instance

Parameters

Name	Type	Description	Required	Notes
update_instance_request	Option<UpdateInstanceRequest>

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_instance_organization_settings

crate::models::OrganizationSettings update_instance_organization_settings(update_instance_organization_settings_request) Update instance organization settings

Updates the organization settings of the instance

Parameters

Name	Type	Description	Required	Notes
update_instance_organization_settings_request	Option<UpdateInstanceOrganizationSettingsRequest>

Return type

crate::models::OrganizationSettings

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_instance_restrictions

crate::models::InstanceRestrictions update_instance_restrictions(update_instance_restrictions_request) Update instance restrictions

Updates the restriction settings of an instance

Parameters

Name	Type	Description	Required	Notes
update_instance_restrictions_request	Option<UpdateInstanceRestrictionsRequest>

Return type

crate::models::InstanceRestrictions

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]