Glossary of Terms

Definitions for common terms regarding the EOS SDK and the Development Portal

Jump to:

ABCDEIOPS

A

account

An external user account that belongs to a single person. Unique within the external account system.

AccountId

A unique identifier for a user account.

Auth Method

Defines the flow and set of parameters sent to EOS for user authentication. There might be more than one authentication method per external Identity Provider.

Example: "epicgames_access_token", "epicgames_exchange_code", "xbl_user_token"

artifact

A family of binaries, metadata, and configurations describing a single application within a product, like a Game Client or a Mod Editor.

audience

A type of entitlement on the Epic Games Store that grants a user access to content when they purchase an offer.

B

binary

A versioned bundle of files and folders. Binaries are created by uploading your content using BuildPatchTool. Clients will download a binary and install your application.

C

OAuth Client

A set of credentials identifying an entity making authenticated requests to Epic Online Services, directly or via SDK. OAuth Client credentials are requested and managed via Developer Portal. You can read more about the standard OAuth 2.0 authentication flow here: https://oauth.net/2/

OAuth ClientId

Identifies the authentication client represented by the credentials in OAuth Client.

OAuth ClientSecret

A secret key required to be used within an OAuth ClientId to access the resources granted to it.

D

deployment

Deployments store all gameplay and player data, such as achievements a player has unlocked or currently ongoing matches in the matchmaking backend. Separate deployments can be used for separating game data between the live environment and internal playtesting. There can be many Deployments attached to a Sandbox.

DeploymentId

A unique identifier for a single deployment. Initializing the SDK requires providing the target DeploymentId for accessing game data in the backend services.

DisplayName

An account's public display name as it would appear to other users. For example, a user's display name would appear in leaderboards.

E

entitlement

An entitlement is anything a user owns, and can mean different things in different products. For example, an entitlement could grant access to one or more items, but it could also be dynamic in nature, supporting the addition or removal of item access over the lifetime of a product.

I

identity Provider

An external identity and authentication provider that hosts accounts for a user, such as Epic, Steam, or Xbox.

IdentityProviderId

A unique identifier associated with an external identity provider.

O

organization

An organization is a group that is responsible for creating and owning products. Every product is owned by an organization and provides it with data.

OrganizationId

A unique identifier for an organization within Epic Online Services and all other Epic systems.

P

presence

The activity status of the local or remote user.

Example: Whether the user is currently online, playing a game, or offline.

product

A game or other software product registered with Epic Online Services and owned by an organization. Acts as an umbrella for all information related to that product, including addons, mods, editors, development builds, and distributions on different platforms.

ProductId

A unique identifier associated with a single Product within Epic Online Services and all other Epic systems.

ProductUserId

Identifies player data for an EOS user within the scope of a single product.

S

sandbox

A high-level distribution environment for a game, such as the live and development environments. Sandboxes contain store-related information, mod configurations, and entries for specific deployments of a game.

Sandbox is referred to by Deployment that the SDK connects to. A sandbox may have multiple deployments referred to it at the same time.

SandboxId

A unique identifier for a sandbox.