updateOAuthApp( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates an OAuth app.

Only fields provided in mask.paths are updated.

You can update the following fields:

  • name
  • description
  • allowedDomain
  • loginUrl
  • logoutUrl
  • technology
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage OAuth Apps
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
_idstringRequired

ID of the OAuth app.

oAuthAppUpdateOAuthAppRequired
maskArray<string>Required

Explicit list of fields to update. Only fields listed are updated.

Returns
Return Type:Promise<OAuthApp>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?