O Auth App Object


An intermediary application that authorizes and authenticates an external client to access data on a Wix project or site.

Properties
allowedRedirectDomainsArray <string>maxItems 20

List of domains to which redirection from Wix is allowed after processes other than authentication.

When a client redirects a user to a Wix page (for example, for checkout), the client provides a URL to redirect the user back to. Wix only redirects the user if the URL is in one of the specified domains.


allowedRedirectUrisArray <string>format URImaxItems 20

List of URIs to which redirection from Wix is allowed after authentication.

When a client redirects a user to Wix for authentication, the client provides a URI to redirect the user back to after the user has been authenticated. Wix only redirects the user if the exact URI is contained in this array.


allowSecretGenerationboolean

For internal use only.


applicationTypestring

OAuth application type.


createdDatestringRead-onlyformat date-time

Date and time the OAuth app was created, in ISO 8601 format.


descriptionstring

Description of the OAuth app, as it appears in the dashboard.


idstringRead-onlyformat GUID

ID of the OAuth app.


loginUrlstringformat WEB_URL

External login URL to which users are redirected automatically to authenticate. If no login URL is specified, the user is redirected to Wix to authenticate.


logoutUrlstringformat WEB_URL

External logout URL to which we invoke when user logout at wix. If no logout URL is specified, the user is logged out only at Wix.


namestringminLength 2maxLength 256

Display name of the OAuth app, as it appears in the dashboard.


redirectUrlWixPagesstringmaxLength 1024

Redirect url for Wix-hosted pages.


secretstringRead-onlydeprecated

For internal use only.


technologystring

OAuth technology used by the oauth application.


wixPagesDomainsMappingsArray <WixPagesDomainMapping>maxItems 200

List of domain mappings from external domains to Wix domains. When a user accesses a non-Wix domain, they can be automatically forwarded to the corresponding Wix domain based on these mappings. This enables domain-level redirection from external domains to Wix-hosted pages.

Did this help?