Develop
Develop
Select your platform

Update Federated User APIs

Updated: Oct 30, 2024
This topic provides reference on the APIs for updating a federated user.

Update (PERSISTENT ID)

Updates the federated user that has the specified persistent ID.
Method:
POST
Endpoint:
https://graph.oculus.com/{app-id}/federated_user_update/
Header
NameDescription
App access token
A Bearer access token that contains OC|$APP_ID |$APP_SECRET.

Path Parameters

The following table lists the API’s URL path parameters.
NameDescription
{app_id}
The application ID which can be obtained from the Developer Dashboard⁠ API page.

Query Parameters

The following table lists the API’s query parameters.
NameDescriptionOptionalType
display_name
The updated name for a federated user which can be displayed in a federated app. Must be:
• From 3-30 characters in length
•UTF-8 encoded (all code points are allowed)
•Preferably unique
✓
String
persistent_id
A unique immutable ID that is used for federated user indexing.
✓
String

Response

The following table describes the JSON payload received in the API response.
NameDescriptionOptionalType
id
The federated user’s ID, unique to the developer organization it was created under.
 
64-bit unsigned integer
persistent_id
The unique immutable ID that is used for federated user indexing.
 
String
unique_name
The 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
display_name
The name for a federated user which can be displayed in a federated app.
 
String

Errors

The following conditions will result in errors:
  • A federated app with the specified app ID does not exist.
  • A user with the specified persistent ID does not exist.
Did you find this page helpful?
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta