Manage Legal Documents on the Admin Portal
Overview
This guide walks you through how to create, update, and publish legal documents on the AccelByte Gaming Services (AGS) Admin Portal or with the AGS CLI.
Prerequisites
This permission section applies to Private Cloud customers only
Access to the AGS Admin Portal with the following permissions:
| Usage | Permission Tag | Action |
|---|---|---|
| Legal document management | ADMIN:NAMESPACE:{namespace}:LEGAL | Create, Update, Read, and Delete |
To follow the AGS CLI steps, install the AGS CLI and sign in with an account that has the permissions above. See Install and sign in. The examples use a Bash shell.
Manage documents
This section walks you through how to manage legal documents in the AGS Admin Portal or with the AGS CLI.
Create a legal document
- Admin Portal
- AGS CLI
-
On the Admin Portal sidebar, go to Foundations > Legal & Privacy > Legal Documents.
-
On the Legal Documents page, click the + Create Document button. The Create Document form appears.
-
On the form, fill in the required fields:
- Document Name: Type in a name for the legal document. Only letters and spaces are allowed.
- Document Type:
- Choose Legal Document to create Privacy Policies or Terms and Conditions.
- Choose Marketing Preference to create a marketing material, such as the option for players to sign up for a newsletter.
- Country: Select the countries that you want this document to be applicable to. The first country that you choose will be the default country, so the documents uploaded later for this country will also apply to all countries that do not have their own policies.
importantCountries can't be modified after the legal document is created. Make sure your country selections during this step are correct before submitting the form.
- Tags (Optional): Add tags to classify the document.
- Clients (Optional): Select the IAM client this legal document will be applied to. In the publisher namespace, this could be the Player Portal or the Launcher, whereas in the game namespace this could be the Game Client.
tipYou can add additional clients to the legal document after it's created.
-
Visibility: choose whether to set the legal document to Active or Inactive on your legal website.
- Active: Displays the legal document on the client, making it visible and accessible to all users.
- Inactive: Hides the legal document from the client, making all mandatory policies within it optional. The document will still be accessible to players through the game client and their legal agreement history. For example, this setting is useful for making a game Non-disclosure Agreement (NDA) available only to invited players, who can access and sign it before starting closed testing.
-
Description: Input a description of the document.
-
When you're finished, click the Create button. The new document will be added to the Legal Documents list.
-
Find the ID of the document type. The Legal Document and Marketing Preference types each have an ID:
ags legal base-policies list-types --namespace <YourNamespace> --limit 20In the output, find the type by its
policyTypeNameand note itsid. -
(Optional) To apply the document to IAM clients, find their client IDs:
ags iam clients list --namespace <YourNamespace> -
Create a JSON file with the document's settings. Any file name works. This example uses
document.json:{
"basePolicyName": "<DocumentName>",
"typeId": "<DocumentTypeId>",
"affectedCountries": ["US", "CA"],
"tags": [],
"affectedClientIds": [],
"isHidden": false,
"isHiddenPublic": false,
"description": "<Description>"
}These fields match the Admin Portal fields:
Admin Portal field Request body field Document Name basePolicyName. Only letters and spaces are allowed.Document Type typeId: the type ID from step 1.Country affectedCountries: two-letter country codes, such asUS. You can't change these countries after you create the document.Tags tagsClients affectedClientIds: the client IDs from step 2.Visibility isHidden:falsefor Active ortruefor Inactive.Description descriptionisHiddenPubliccontrols whether your legal website shows the document. Set it totrueto hide the document from the website. It doesn't change whether players must accept the document. -
Create the document. After
@, pass the path to your JSON file:ags legal base-policies create --namespace <YourNamespace> --json @document.jsonThe command prints the new document, including its
id.noteThe first country in
affectedCountriesdoesn't always become the default country. To check or change the default, see Create a policy.
Edit a legal document
- Admin Portal
- AGS CLI
-
On the Admin Portal sidebar, go to Foundations > Legal & Privacy > Legal Documents.
-
On the Legal Documents page, you can see a list of all existing legal documents. Choose the document you want to update and click Update in the Action column next to it.
-
In the Update Document form that appears, make the desired changes. If necessary, use the previous section for help filling out the fields.
-
Once completed, click the Edit button. The document will be updated.
-
Find the ID of the legal document:
ags legal base-policies list --namespace <YourNamespace>In the output, find the document by its
basePolicyNameand note itsid. -
Save the document's current settings to a file. Replace
<BasePolicyId>with the document ID:ags legal base-policies get --namespace <YourNamespace> --base-policy-id <BasePolicyId> --format json > document.json -
In
document.json, change the fields you want. The field names are listed in Create a legal document. Then add this line, so that the update doesn't add any countries:"affectedCountries": []warningThe update replaces the name, description, tags, clients, and visibility of the document with the values in the file. Leave the fields you don't change as they are. If you remove a field, the update clears it. The update fails if the file has no
affectedCountriesfield. -
Update the document:
ags legal base-policies update --namespace <YourNamespace> --base-policy-id <BasePolicyId> --json @document.jsonnoteWhen you set a document to Inactive, the Admin Portal also clears Mandatory Update on each of its policies. With the AGS CLI, do this yourself for each mandatory policy, as described in step 7 of Create a policy.
Delete a legal document
- Admin Portal
- AGS CLI
-
On the Admin Portal sidebar, go to Foundations > Legal & Privacy > Legal Documents.
-
On the Legal Documents page, you can see a list of all existing legal documents. Choose the document you want to delete and click Delete in the Action column next to it.
-
Click the Confirm button. The document will be deleted.
-
Find the ID of the legal document:
ags legal base-policies list --namespace <YourNamespace>In the output, find the document by its
basePolicyNameand note itsid. -
Delete the document. Replace
<BasePolicyId>with the document ID. When prompted, confirm the deletion.ags legal base-policies delete --namespace <YourNamespace> --base-policy-id <BasePolicyId>
Create a policy
After creating a legal document, you can create a country-specific policy to hold special versions of that document that are for specific countries or a group policy for multiple countries. The countries that were entered when a legal document was created or edited will be listed as countries that require a specific version of that document. To add a new country-specific or group policy to that list, follow the steps below.
- Admin Portal
- AGS CLI
-
On the Admin Portal sidebar, go to Foundations > Legal & Privacy > Legal Documents.
-
On the Legal Documents page, you can see a list of all existing legal documents. Choose the document to which you want to add a policy and click the name in the Document Name column of it.
-
On the Legal Document Details page, you can see detailed information about the selected legal document and the list of country-specific & group policies related to that document. To create a new policy, click the + Create Policy button.
-
On the Policy Creation form that appears, fill in the required fields:
- Policy Type:
- Choose Country-Specific to create a policy for a single specific country.
- Country: to select the one country that you want this policy to be applicable to.
- Choose Group to create a policy for multiple countries.
- Group Name to name your country group, for example: North America, Europe.
- Country to select the countries that you want this policy to be applicable to. You can choose more than 1 country and countries that have already been selected in other policies will not appear in the options.
- Choose Country-Specific to create a policy for a single specific country.
You'll be redirected to the policy page that you just created.
- Policy Type:
-
To set this policy as the default, click the Set as Default button.
-
If you want to require players to accept this policy before continuing to use the platform, select the Mandatory Update checkbox.
-
Find the ID of the legal document:
ags legal base-policies list --namespace <YourNamespace>In the output, find the document by its
basePolicyNameand note itsid. -
Save the document's current settings to a file. Replace
<BasePolicyId>with the document ID:ags legal base-policies get --namespace <YourNamespace> --base-policy-id <BasePolicyId> --format json > document.json -
In
document.json, add the fields for the new policy:-
For a country-specific policy, add the country code and set
countryTypetoCOUNTRY:"affectedCountries": ["JP"],
"countryType": "COUNTRY" -
For a group policy, add the country codes, set
countryTypetoCOUNTRY_GROUP, and name the group. The group name must be 3 to 50 characters long."affectedCountries": ["FR", "DE"],
"countryType": "COUNTRY_GROUP",
"countryGroupName": "<GroupName>"
Countries that already have their own policy are skipped. Leave the other fields as they are, because the update also resends them.
-
-
Create the policy:
ags legal base-policies update --namespace <YourNamespace> --base-policy-id <BasePolicyId> --json @document.json -
Find the ID of the new policy:
ags legal base-policies get --namespace <YourNamespace> --base-policy-id <BasePolicyId>In the
policieslist of the output, find the policy by itscountryCode, or by itscountryGroupNamefor a group policy. Note itsidandpolicyName. -
To set this policy as the default, run the following command. Replace
<PolicyId>with the policy ID:ags legal policies set-default --namespace <YourNamespace> --policy-id <PolicyId> -
To require players to accept this policy, turn on Mandatory Update. Replace
<PolicyName>with thepolicyNamefrom step 5. To turn it off, setisMandatorytofalse.ags legal policies update --namespace <YourNamespace> --policy-id <PolicyId> \
--json '{"policyName": "<PolicyName>", "isMandatory": true}'noteLike the Admin Portal, this command also sets
isDefaultOptedandshouldNotifyOnUpdatetofalseand clears the policy description.
Manage policy versions of legal documents
This section walks you through how to create and update policy versions of legal documents in the AGS Admin Portal or with the AGS CLI.
Create a new version of a document
After creating a policy, you can add a new version of that document anytime it's revised. To create a new version of a document, follow the steps:
- Admin Portal
- AGS CLI
-
On the Admin Portal sidebar, go to Foundations > Legal & Privacy > Legal Documents.
-
On the Legal Documents page you can see a list of all existing legal documents. Choose the document to which you want to add a new version and click View in the Action column next to it.
-
On the Legal Document Details page, you can see detailed information about the selected legal document and the list of policies related to that document. To create a new version of a policy, click View in the Action column next to the policy you want to add a version to.
-
On the Policy Details page of the policy you chose, you can see information about the policy and its existing versions. To create a new version of the document, click the + Create a Version button.
-
On the Create Version form that appears, enter a name for the new version in the Version Name field.
-
Click the Create button. The new document version will be created.
-
To add content to a document version, click View in the Action column of that version.
-
On the Version Details page, you can see detailed information about the selected document version. To add content to this version, click the Create New button.
-
On the Create Locale form that appears, choose the language the document is in from the Locale dropdown. Then, click the Browse button to find the document on your computer and upload it. The file should be a
.mdor.htmlfile. -
Click the Create button. The selected file will be uploaded.
-
Find the ID of the legal document:
ags legal base-policies list --namespace <YourNamespace>In the output, find the document by its
basePolicyNameand note itsid. -
Find the ID of the policy. Replace
<BasePolicyId>with the document ID:ags legal base-policies get --namespace <YourNamespace> --base-policy-id <BasePolicyId>In the
policieslist of the output, find the policy by itscountryCode, or by itscountryGroupNamefor a group policy, and note itsid. -
Create the version. Replace
<PolicyId>with the policy ID and<VersionName>with a name for the version:ags legal versions create --namespace <YourNamespace> --policy-id <PolicyId> \
--json '{"displayVersion": "<VersionName>", "description": "", "isCommitted": true}'The command prints the new version, including its
id. -
To add the document content, use the Admin Portal. The AGS CLI has no command to upload the document file. In the Admin Portal tab, follow steps 1 to 4 to open the policy, then steps 7 to 10 to upload the file to the new version.
Edit a document version
-
On the Admin Portal sidebar, go to Foundations > Legal & Privacy > Legal Documents.
-
On the Legal Documents page, you can see a list of all existing legal documents. Choose the document to which you want to add a new version and click View in the Action column next to it.
-
On the Legal Document Details page, you can see detailed information about the selected legal document and the list of policies related to that document. Click View in the Action column next to the policy that contains the version of the document you want to edit.
-
On the Policy Details page of the policy you chose, you can see information about the policy and its existing versions. To edit a version, click View in the Action column of that version.
-
On the Version Details page, use the text editor on the left side of the page to make your edits. The text box on the right side shows you how your changes will look after they're published.
-
Once completed, click Save.
Publish a policy version
- Admin Portal
- AGS CLI
-
On the Admin Portal sidebar, go to Foundations > Legal & Privacy > Legal Documents.
-
On the Legal Documents page, find the legal document you want to update and click on its name to open its details page.
-
On the details page of the document, scroll down to the Policy section.
-
From the list of the document's policies, find the policy you want to update and click its View option. The policy's details page appears.
-
In the Versions section, find the version you want to publish. Click on its ellipsis menu and click PUBLISH.
-
On the confirmation message, type PUBLISH and select the Notify users checkbox if you want to notify players about the policy update via email.
-
Click the Publish button. The new version is published.
-
Find the ID of the legal document:
ags legal base-policies list --namespace <YourNamespace>In the output, find the document by its
basePolicyNameand note itsid. -
Find the ID of the policy. Replace
<BasePolicyId>with the document ID:ags legal base-policies get --namespace <YourNamespace> --base-policy-id <BasePolicyId>In the
policieslist of the output, find the policy by itscountryCode, or by itscountryGroupNamefor a group policy, and note itsid. -
Find the ID of the version. Replace
<PolicyId>with the policy ID:ags legal versions list --namespace <YourNamespace> --policy-id <PolicyId>In the output, find the version by its
displayVersionand note itsid. -
Publish the version. Replace
<PolicyVersionId>with the version ID. To notify players about the policy update by email, set--should-notifytotrue.ags legal versions publish --namespace <YourNamespace> --policy-version-id <PolicyVersionId> --should-notify false
Delete a document version
- Admin Portal
- AGS CLI
-
On the Admin Portal sidebar, go to Foundations > Legal & Privacy > Legal Documents.
-
On the Legal Documents page, you can see a list of all existing legal documents. Choose the document to which you want to delete a version and click View in the Action column next to it.
-
On the Legal Document Details page, you can see detailed information about the selected legal document and the list of policies related to that document. Click View in the Action column next to the policy that contains the version of the document you want to delete.
-
On the Policy Details page of the policy you chose, you can see information about the policy and its existing versions. To delete a version, click Delete in the Action column of that version.
-
Click the Confirm button. The version will be deleted.
-
Find the ID of the legal document:
ags legal base-policies list --namespace <YourNamespace>In the output, find the document by its
basePolicyNameand note itsid. -
Find the ID of the policy. Replace
<BasePolicyId>with the document ID:ags legal base-policies get --namespace <YourNamespace> --base-policy-id <BasePolicyId>In the
policieslist of the output, find the policy by itscountryCode, or by itscountryGroupNamefor a group policy, and note itsid. -
Find the ID of the version. Replace
<PolicyId>with the policy ID:ags legal versions list --namespace <YourNamespace> --policy-id <PolicyId>In the output, find the version by its
displayVersionand note itsid. -
Delete the version. Replace
<PolicyVersionId>with the version ID. When prompted, confirm the deletion.ags legal versions delete --namespace <YourNamespace> --policy-version-id <PolicyVersionId>