Access FAQ
Overview
This page covers the Access service's frequently asked questions (FAQ) by customers at our Customer Support Portal.
Why are some players not receiving emails?
Some internet service providers (ISPs) will block an email due to the sender, signed-by, and mailed-by not being synchronized.
What should we do?
- Generate CNAME records on SendGrid. To learn how, see SendGrid's Set up Domain Authentication guide.
- Add the CNAME records in your domain.
- Learn more about CNAME by reading SendGrid Documentation
- Every domain registrar may have a different method for adding the CNAME, please refer to your domain registrar documentation.
What if players still aren't receiving emails?
Some ISPs also have a mechanism to block emails from shared IP addresses. You will need to use a dedicated IP address on SendGrid.
If your issue is not resolved, contact support@accelbyte.net for customer support.
What is the Oculus user id stored in AGS?
There are two types of user ids in Oculus:
- app scoped id: unique ID per application, different for the same application on different devices, can be avoided by app grouping, in the same app grouping, new users will have the same app scoped id, for games that want to share user data between devices, please put the apps in the same app group.
- organization scoped id: unique per organization, allows different apps within the same organization to identify the user.
For AGS account link, we use organization scoped id
so that we can identify the same Oculus account regardless of the apps within this organization.
We also utilize the app scoped id
for some features like IAP.
You can get the app scoped id
by an AGS user id with this endpoint.
You can get the AGS user account by the app scoped id
with this endpoint.
What's the best way to get an authorization (apiKey) to test endpoints in the API Explorer?
The authorization (apiKey)
is also known as access token
in AGS. There are two types of access token in AGS:
- user token: access token granted to a user
- client token: access token granted to an IAM client by client credentials
This guide will walk you each token type.
Prerequisites
We need to create an IAM client first. Please follow this document to create an IAM client. Let's create a confidential IAM client for example, you need to keep the Client ID and Secret, we will need them for the following steps.
You can only get the secret during the IAM client creation, so please copy it and store it.
User token
Steps
- Open the TokenGrantV3 api doc.
- Click the Authorize button(lock icon) in the top-right corner.
- Under Basic authorization, paste your Client ID into the Username field, paste your Secret into the Password field.
- Click Authorize, then click Close.
- Click Try it out button.
- Set Grant Type to
password
. - Enter your AGS Admin Portal username and password, then click Execute.
- Copy the
access_token
from the response body. - Open any api endpoint from AGS API Explorer.
- Click the Authorize button(lock icon) in the top-right corner.
- In the authorization (apiKey) section, enter "Bearer " (in capitals, with a space) followed by your
access_token
. - Click Authorize and then Close.
- You can now test the API endpoints with this authorization.
Client token
Steps
- Open the TokenGrantV3 api doc.
- Click the Authorize button(lock icon) in the top-right corner.
- Under Basic authorization, paste your Client ID into the Username field, paste your Secret into the Password field.
- Click Authorize, then click Close.
- Click Try it out button.
- Set Grant Type to
client_credentials
, then click Execute.. - Copy the
access_token
from the response body. - Open any api endpoint from AGS API Explorer.
- Click the Authorize button(lock icon) in the top-right corner.
- In the authorization (apiKey) section, enter "Bearer " (in capitals, with a space) followed by your
access_token
. - Click Authorize and then Close.
- You can now test the API endpoints with this authorization.
Some API endpoints are protected by Permissions, you can find the required permission of the endpoint from Required permission in the api doc.
If you get the insufficient permissions
error, you need to grant permissions to the user's role or grant permissions to your IAM client.
But do NOT grant any permission to a public IAM client, it's not safe.