O Auth App Object


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

Properties
idstringRead-onlyformat GUID

ID of the OAuth app.


createdDatestringRead-onlyformat date-time

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


namestringminLength 2maxLength 256

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


descriptionstring

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


secretstringRead-onlydeprecated

For internal use only.


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.


allowedRedirectUrisArray <string>format URImaxItems 10

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.


allowedRedirectDomainsArray <string>maxItems 10

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.


allowSecretGenerationboolean

Whether a secret can be generated for this OAuth app.

Default: true until a secret has been generated for the OAuth App.


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.


applicationTypestring

OAuth application type.


technologystring

OAuth technology used by the oauth application.

Was this helpful?
Yes
No