Develop
Develop
Select your platform

Create Federated User API

Updated: Sep 13, 2024
This topic provides reference for the API used to create a federated user.

Create Federated User (APP ID)

Creates a new federated user with the specified persistent ID and display name.
Method:
POST
Endpoint:
https://graph.oculus.com/{federated_app_id}/federated_user_create

Path Parameters

The following table lists the API’s URL path parameters.
NameDescription
{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.
NameDescriptionOptionalType
persistent_id
A unique immutable ID that is used for federated user indexing.
 
String
display_name
A name for a federated user which can be displayed in a federated app.
• From 3-30 characters in length
•UTF-8 encoded (all code points are allowed)
•Preferably unique
 
String
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.
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:
  • The specified persistent ID is not valid or not unique.
  • The specified display name is not valid.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2025 Meta