Meta Avatars Cross-Play with Non-Meta Environments

This topic explains federated authentication and how to use it to enable the Meta Avatars SDK to cross-play with environments outside of the Meta ecosystem.

Federated authentication

Federated authentication brings compatible Platform Services to VR experiences on non-Meta platforms. Federated apps make service requests for federated users outside the Meta ecosystem. This enables cross-play between federated and primary apps on Meta devices.

This extends to Avatars, giving Unity app developers the ability to deliver Avatar content to users who might not have a Facebook account or a Meta headset. For more information on federated authentication, including a list of other compatible Platform Services, go to Federated Authentication.

Compatibility

Federated authentication supports SteamVR and Windows Mixed Reality VR.

SteamVR

Windows Mixed Reality VR

Using federated authentication with Avatars

Enable your app to be federated:

This section will walk you through how to start using federated authentication with Meta Avatars.

You first will need to enable your app to be federated:

In App Manager, click API.

In App Manager, click API.
App Manager API Button

In the API window to the right, click Generate Federated App ID.

In the API window to the right, click Generate Federated App ID.
Generate Federated App ID Button

Next you will need to obtain an access token for your app:

Click Federated App. The federated app access token is located under App Credentials.
Obtain an access token for your app. Click Federated App. The federated app access token is located under App Credentials.

You next need to obtain a federated user access token. Next, obtain a federated user access token.

If you are creating a new federated user, call federated_user_create specifying a unique persistent ID.

For an existing federated user, call one of the read user APIs.

Retrieve the persistent ID from the {data}persistent_id field in the JSON response payload.

If you are creating a new federated user, call federated_user_create specifying a unique persistent ID.

For an existing federated user, call one of the read user APIs.

Retrive the persistent ID from the {data}persistent_id field in the JSON response payload.

Call federated_user_gen_access_token with the query parameter persistent_id set to the ID you obtained in the previous step. The federated user token is provided in the response.

To initialize the Meta Avatars SDK, call Meta.Avatar2.OvrAvatarEntitlement.SetAccessToken(string token) and pass the access token you obtained. Initialize the Meta Avatars SDK by calling Meta.Avatar2.OvrAvatarEntitlement.SetAccessToken(string token) with the obtained access token.

Did you find this page helpful?