About the App Invites Proxy API

The App Invites Proxy API lets authorized developers and Wix administrators manage access to apps through invitations and role assignments.

With the App Invites Proxy API, you can:

• Invite a collaborator by email with selected Identity roles for app access.
• Renew and resend an invitation, or cancel an unused invitation.
• Retrieve an app's contributors and invitations.
• Remove an account's role assignments for an app.

Use the Apps API to create or retrieve the app, then specify its id as appId in this API. Invitation and collaborator operations manage access to that app; they don't create or configure the app itself.

Invitations and assigned access

Creating an invitation sends an email but doesn't grant access immediately. The recipient must accept the invitation before the selected roles are assigned. Retrieve the app's contributors and invitations to distinguish pending invitations from assigned access.

Deleting an invitation doesn't remove an existing collaborator. Removing role assignments doesn't delete the account or app, or cancel outstanding invitations. These are separate actions when removing access.

Before you begin

It's important to note the following points before starting to code:

• Obtain the app ID from the Apps API. App access is distinct from the site access managed by the Site Invites API.
• Creating and resending invitations require a signed-in user with account context. Role discovery through Get Roles Info in the Users API has separate authentication requirements, including an account-level API key.
• Use Identity role IDs applicable to app access in invite.policyIds, not assignment IDs or unrelated site roles. Get Roles Info returns predefinedRoles and customRoles; use a selected role's id, or the app-access role IDs supplied through your account's Identity role configuration. This API doesn't define its own role catalog.
• Treat recipient email addresses and acceptance links as sensitive data.
• The app owner's account can't be removed with this API.

Use cases

• Invite a collaborator to an app.
• Resend an app invitation.
• Cancel an unused app invitation.
• Remove a collaborator's app access.

Terminology

• Invitation: An email invitation with a status, expiration, and acceptance link. Accepting it assigns the selected roles.
• Policy ID (role ID): An Identity role's ID, specified in policyIds to select access to grant. It isn't an invitation ID or assignment ID.
• Contributor: A user associated with the app. Its id is a user ID, while metaData.id is the account ID required when removing role assignments.
• Assignment ID: Identifies a role assignment. Clear Assigned App Policies Proxy returns the IDs it removed.