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 are updated.

You can update the following fields:

  • name
  • description
  • allowedDomain
  • loginUrl
  • logoutUrl
  • technology
Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Headless Manage
Manage OAuth Apps
Learn more about app permissions.
Method Declaration
Copy
function updateOAuthApp(
  _id: string,
  oAuthApp: UpdateOAuthApp,
  mask: Array<string>,
): Promise<OAuthApp>;
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>
JavaScript
import { oAuthApps } from "@wix/auth-management";

async function updateOAuthApp(id, oAuthApp, mask) {
  const response = await oAuthApps.updateOAuthApp(id, oAuthApp, mask);
}
Errors

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

Did this help?