Meta Developers

Develop

Develop

Select your platform

Developing Apps for Horizon OS

Set Up Your Device

Explore Features with Building Blocks

Simulate Builds with XR Simulator

Add User Input and Interactions

Meta XR Core SDK

Meta XR Core SDK Overview

Meta XR Core SDK Samples

Interaction SDK Overview

Get Started with Interaction SDK

Add an Interaction with Quick Actions

Use Interaction SDK with Unity XR

OpenXR Hand Skeleton

OpenXR Upgrade Dialog

Upgrade Custom Components

The Cameraless Rig Prefab

Use Custom Hand Models

ComprehensiveRigExample Scene

ConcurrentHandsControllersExamples Scene

Interactor Interactable Lifecycle

Interactor Groups

Use Active State

Pointer Lifecycle

Grabbing Objects

Poke Interactions

PokeExamples Scene

Ray Interactions

RayExamples Scene

Moving in the World

Locomotion Overview

Teleport Interactions

Turn Interactions

Slide Interactions

Step Interactions

Gating Locomotion

Microgestures for Locomotion

Locomotion Events

Create Locomotion Interactions

Character Controllers for Locomotion

Locomotion Comfort

LocomotionExamples Scene

Unity Canvas Integration

Detecting Poses

Build Custom Hand Pose

Hand Pose Selector Recorder

Hand Pose Detection

Body Pose Detection

Compare Body Poses

PoseExamples Scene

GestureExamples Scene

BodyPoseDetectionExamples Scene

Handling Events

Secondary Interactions

Working with Hands

Hand Physics Capsules

Get Hand Bone Position

Body, Face, and Eye Tracking

Getting Started

Natural Facial Expressions

Body Tracking Samples

Natural Facial Expressions and Eye Tracking Samples

Advanced Samples

Advanced Material

Scripts and Shaders

Troubleshooting

Tracked Keyboard

Tracked Keyboard with Interaction SDK Sample

Feature Walkthrough

Troubleshooting

Troubleshooting

Other Runtime APIs

Customize inputs and animations

Mixed Reality Utility Kit

Create Depth Perception

Samples and Support

Unity’s XR.Oculus Usage

Troubleshooting and FAQ

Spatial Data Permission

Use the Scene Model

Access Scene data with OVRAnchor

Mixed Reality Sample

Custom Scene Manager Sample

Troubleshooting

Migrate to MR Utility Kit

Get Started with OVRSceneManager

Use OVRSceneManager

Plane and Volume Sample

Use Spatial Anchors

Getting Started

Spatial Anchors

Shared Spatial Anchors

Shared Spatial Anchors Sample

Shared Spatial Anchors Troubleshooting

Use Space Sharing

Getting Started

Passthrough Camera

Implementation using WebCamTexture

Colocation Discovery

Mixed Reality Experience and Use Cases

Asynchronous Tasks

Platform Solutions

Getting Started Guide

Set Up for Platform Development

Set Up Platform Entitlements

Server-to-Server API Basics

Multiplayer Features

User Engagement

User Engagement Overview

User Notifications

Create User Notifications

Event-Based Notifications

Developer Posts

Leaderboards Client APIS

Leaderboard Server APIs

Challenges Client APIs

Challenges Server APIs

Share Content from Meta Quest Apps

Monetization Overview

Add-ons - DLC and IAP

Add-ons Purchase Integration

Add-ons Server APIs

Testing Add-ons

Server APIs for Subscriptions

Social Features

Social Features Overview

Parties and Party Chat

Parties and Party Chat

User Info, Friends and Relationships

Verify the User

Enable Friend Requests (Mobile)

Managed Accounts

Managed Account API Overview

User Management

User Management Overview

Entitlement Check

Cross-Play with Federated Authentication

Create Federated User

Delete Federated User

Generate Federated User Access Token

Read Federated User

Read Federated Users

Update Federated User

Account Linking

Security Overview

Attestation API

Get Age Category API

Lying Down Mode

Quest Tools Overview

App Deep Linking

System Deep Linking

In App Update APIs

Asset Files to Manage Download Size

Save Game Best Practices

Cross-Device Development with App Groupings

Platform Reference

Platform Release Notes Archive

Integrate Meta Avatars

Enhance the User Interface

Camera Features

Configure Meta XR Camera Settings

Add a Splash Screen

Mixed Reality Capture

Spectator Camera for Casting

The Boundary System

Create Interactive Boundaries

Enable Focus Awareness

Enable System Keyboard Overlay

Oculus Dash in Unity

Display and Rendering Capabilities

Fixed Foveated Rendering

Eye Tracked Foveated Rendering

Set Display Refresh Rates

Enable Phase Sync

Enable Multiview

Enable Late Latching

VR Compositor Layers

Single Pass Stereo Rendering and Stereo Instancing

Set Specific Color Space

Asymmetric FOV FAQ

Application SpaceWarp Developer Guide

Forward+ Rendering

Vulkan Subpasses

Performance and Optimization

Project Configuration

Build Configuration

Optimize Build Iterations and Use Quick Scene Preview

Strip Unused Shaders

Cubemap Screenshots

Cross-Platform Development

Application lifecycle handling

Use Meta Quest Scriptable Testing Services to Enable E2E Testing

Using AutoDriver to Record Inputs

Vulkan Validation Layers

Developer Tools

Meta XR Packages

In-Editor Tools

Project Setup Tool

XR Plugin Management

Building Blocks

Immersive Debugger

HMD Motion Emulation

Meta Quest Developer Hub

Manage Your Headset

Set Up Headset with MQDH

Debugging Tools

Create Custom Command

Performance Analyzer and Metrics

How to Take Perfetto Traces

Layer Visibility Control

Explore File Manager

Add, Remove, and Switch Between Multi-User Accounts

Deploy Build on Headset

Troubleshooting MQDH

Submit and Track Bugs and Feature Requests

Meta XR Simulator

Collect VrApi Logs with Logcat

Logcat Stats Definitions

Configure Android System Properties

Android Debug Bridge for Meta Quest

Performance Tools

RenderDoc Meta Fork

Taking and Loading a Capture

Performing a Render Stage Trace

Performing a Draw Call Trace

Accessing Vulkan Shader Stats

Recommended Settings

Draw Call Metrics

OVR Metrics Tool

OVR Metrics Tool Stats Definition Guide

Best Practices - OVR Metrics Tool for Non-Engineers

Publish Your App

Prepare Your App for Publishing

Generate the Android Manifest File

Upload App from Unity

Sample Projects

Import Oculus Integration SDK (Legacy)

Oculus Integration SDK Sample Framework (Legacy)

Interaction SDK Tutorials (Legacy)

Create Grab Interactions

Create Distance Grab Interactions

Create Poke Interactions

Create Ray Interactions

Use Ray Interaction with UI

Throw an Object

Oculus Audio SDK (EOL)

Meta Avatars SDK Quest 1 Support (Retired)

Oculus VST Spatializer for DAWs Integration (Retired)

Oculus VST Spatializer for DAWs Integration Guide (Retired)

Overview (Retired)

Use Oculus Plugin (Retired)

VST Options and Parameters (Retired)

3D Visualizer (Retired)

DAW-Specific Notes (Retired)

Legal Notifications (Retired)

Oculus AAX Spatializer for DAWs Integration (Retired)

Oculus AAX Spatializer for DAWs Integration Guide (Retired)

Overview (Retired)

Use Plugin (Retired)

Track Parameters (Retired)

3D Visualizer (Retired)

Archived Platform Solutions

Matchmaking (Deprecated)

Introduction to Matchmaking (Deprecated)

Matchmaking API (Deprecated)

Implement Matchmaking (Deprecated)

Refine Matchmaking (Deprecated)

Test and Tune Matches (Deprecated)

Group Launch (Deprecated)

Peer-to-Peer Networking (Deprecated)

Rooms (Deprecated)

Rooms Client APIs (Deprecated)

Server APIs for Moderated Rooms (Deprecated)

Peer to Peer Voice Chat (VoIP) (Deprecated)

Tracked Keyboard (Deprecated)

Overview (Deprecated)

Get Started (Deprecated)

Integrate OVRTrackedKeyboard Prefab (Deprecated)

Debug Tracked Keyboard-Enabled Apps with Link (Deprecated)

Tracked Keyboard Sample (Deprecated)

Virtual Keyboard (Deprecated)

Overview (Deprecated)

Getting Started (Deprecated)

Sample Overview (Deprecated)

Integrating the OVRVirtualKeyboard Prefab (Deprecated)

Custom Integrations and Best Practices (Deprecated)

FAQ (Deprecated)

Archived Developer Tools

GPU Systrace (Deprecated)

Cloud Saves API (Deprecated)

Cloud Saves Deprecation

Read Federated Users API

Updated: Oct 30, 2024

This topic provides reference for the API used to get data for multiple federated users created within the same developer organization.

Read Users

Method:

GET

Endpoint:

https://graph.oculus.com/{federated_app_id}/federated_users

Path Parameters

The following table lists the API’s URL path parameters.

Name	Description
`{federated_app_id}`	The federated application ID which can be obtained from the Developer Dashboard API page.

Query Parameters

The following table lists the API’s query parameters.

Name	Description	Optional	Type
`fields`	A comma-separated list of the fields to include in the response.	✓	A comma-separated list. Valid values: • `id` • `persistent_id` • `unique_name` • `display_name`
`access_token`	Bearer token that contains OC\|$APP_ID \|$APP_SECRET		String

Response

The following table describes the JSON payload received in the API response.

Name	Description	Optional	Type
`data`	An paginated array of federated users with the requested fields.		Array
`data{id}`	A federated user’s ID, unique to the developer organization it was created under.	✓	64-bit unsigned integer
`data{persistent_id}`	A unique immutable ID that is used for federated user indexing.	✓	String
`data{unique_name}`	A unique name given to a federated user if their display name is already taken by another user, formatted `{display_name}#` followed by a numerical ID.	✓	String
`data{display_name}`	A name for a federated user which can be displayed in a federated app.	✓	String
`paging`	An array of URLs used to paginate to the previous or the next set of users.		Array
`paging{previous}`	The URL used to paginate to the previous set of users or an empty string if there are no previous users.		String
`paging{next}`	The URL used to paginate to the next set of users or an empty string if there are no more users next.		String

Did you find this page helpful?