Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for apple SSO support on mod.io #36

Merged
merged 2 commits into from
Jul 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions public/en-us/console-platforms/apple.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
id: platforms-apple
title: Apple
slug: /platforms/apple/
sidebar_position: 5
---
import CrossLink from '@site/src/components/CrossLink'

# Apple SSO

Typical requirements to authenticate to mod.io from a game running on Apple include:
* A mod.io account.
* An Apple developer account.

## Setting up Apple SSO

Before you can integrate sign in with Apple on mod.io platform you need a paid Apple developer account. Sign up for one at [developer.apple.com](https://developer.apple.com/).

:::note
It takes about 48 hours for your Apple developer account to be verified. Once it is verified, you can proceed with the following steps.
:::

### Setting up Apple SSO through the Apple Developer Account

1. Sign in to your Apple developer account and click on your **[account](https://developer.apple.com/account/)**.
![apple_developer_account_settings.png](images/apple/apple_developer_account_settings.png)

2. In the **Certificates, Identifiers & Profiles** section, click on **[Identifiers](https://developer.apple.com/account/resources/identifiers/list)**. Click on the "+" button to create a new identifier and select the **App IDs** option.
![apple_select_appid.png](images/apple/apple_select_appid.png)

3. Under register a new identifier, select **App** type and click on **Continue**.
![apple_register_new_identifier.png](images/apple/apple_register_new_identifier.png)
4. Fill out the description and bundle ID for your app. Take note of the bundle id as you will need it [later](#modio-setup). Click on **Continue**.
![apple_register_appid.png](images/apple/apple_register_appid.png)
5. Fill in the App ID Description and Bundle ID, then scroll down to the **Capabilities** section. Take note of the **Bundle ID** as you will need it later. Enable the **Sign in with Apple** capability and click on **Continue**.
![apple_enable_signin_capability.png](images/apple/apple_enable_signin_capability.png)

6. Review the information and click on **Register**. A new App ID will be created, and you should be redirected back to the **identifiers** page.
7. Open your Xcode project and follow the steps [here](https://help.apple.com/xcode/mac/11.0/#/devaf282080a) to add your Apple Developer account to Xcode if it's not already connected.
8. Update the **Bundle Identifier** to match the one you created in the Apple Developer account. Update the **Team** to match your Apple Developer account.
![apple_signin_capability_xcode.png](images/apple/apple_signin_capability_xcode.png)
9. Next, navigate to the **Signing & Capabilities** tab. Select your team and then click on the "+" button to add a new capability.
![apple_sso_setup_xcode_config.png](images/apple/apple_sso_setup_xcode_config.png)
10. Scroll down the list to locate the **Sign in with Apple** capability, click to add this to your project. Update your App ID in the **Signing & Capabilities** tab.
![apple_xcode_enable_signin_capability.png](images/apple/apple_xcode_enable_signin_capability.png)

## Configuring your games Apple Bundle ID on mod.io

1. On the mod.io website, navigate to your [game's admin dashboard](https://mod.io/content) and go to the **Settings** tab.
2. Under **Admin > General Settings** find and click on the **Platform Authentication**.
![modio_apple_sso_game_settings.png](images/apple/modio_apple_sso_game_settings.png)

3. Enter the **<a name="modio-setup">Bundle ID</a>** of your app in the **Apple** field and **Save Changes**.

## Sign in players to mod.io using Apple

If your game is using the official mod.io SDK, Unreal or Unity plugin, follow the instructions provided with it to authenticate players using Apple SSO, or other supported platform authentication methods.

If you are building something custom using the mod.io REST API, follow the [instructions provided here](https://docs.mod.io/restapiref/#apple) to authenticate players using Apple SSO, by calling the `/external/appleauth` endpoint.

## References

* [Apple Developer Documentation](https://developer.apple.com/documentation/sign_in_with_apple/sign_in_with_apple_rest_api/authenticating_users_with_sign_in_with_apple) - Explains how Apple's SSO works in detail.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 4 additions & 10 deletions public/en-us/support/contacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,10 @@ slug: /support/contacts/
sidebar_position: 1
---

# Key Contacts
# Contacts

**Product lead:** scott@mod.io
For all game integration enquiries (Unity, Unreal, SDK and REST API), please contact us at developers@mod.io, or you can reach our team on Discord: https://discord.mod.io.

**Business lead:** paul@mod.io
For all business development enquiries, please contact us at developers@mod.io.

**Integration tech (Unity, Unreal and SDK):** developers@mod.io

**Authentication and web tech:** pat@mod.io

**Customer success and community:** danny@mod.io

**General enquiries:** support@mod.io
For general enquiries, please contact us at support@mod.io, or search our knowledge base: https://support.mod.io.
11 changes: 8 additions & 3 deletions public/menu/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,10 @@ const sidebars = {
},
],
},
// Console Platforms
// Platforms
{
type: 'html',
value: `${startStylePush}CONSOLE PLATFORMS${endStyle}`,
value: `${startStylePush}PLATFORMS${endStyle}`,
defaultStyle: true,
},
{
Expand All @@ -121,7 +121,7 @@ const sidebars = {
{
type: 'doc',
id: 'console-platforms/platforms-playstation',
label: 'PlayStation\u00ae4 & PlayStation\u00ae5',
label: 'PlayStation®4 & PlayStation®5',
},
{
type: 'doc',
Expand All @@ -138,6 +138,11 @@ const sidebars = {
id: 'console-platforms/platforms-console-sdks',
label: 'Console SDKs',
},
{
type: 'doc',
id: 'console-platforms/apple',
label: 'Apple',
},
// Game Management
{
type: 'html',
Expand Down