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

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

Name	Description	Optional	Type
`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

The following conditions will result in errors:

A federated user with the specified ID does not exist.

Read User (PERSISTENT ID)

Gets the federated user who has the persistent ID specified in the URL query.

GET

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

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.

The following table lists the API’s query parameters.

Name	Description	Optional	Type
`persistent_id`	A unique immutable ID that is used for federated user indexing.		String
`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

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

Name	Description	Optional	Type
`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

The following conditions will result in errors:

A federated app with the specified app ID does not exist.

A federated user with the specified persistent ID does not exist.

Read User (ME)

Gets the federated user whose access token is being used for authentication and being generated by persistent ID.

Method:

GET

Endpoint:

https://graph.oculus.com/me

Header

Name	Description
User access token	A Bearer access token for a federated user create under the same developer team as the targeted federated app belongs to.

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`

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

Name	Description	Optional	Type
`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