Skip to content

Commit ef4e0b1

Browse files
update Open Source Docs from Roblox internal teams
1 parent 8fe5c5d commit ef4e0b1

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

content/en-us/cloud/auth/api-keys.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Group API keys are being deprecated and will not be supported after January 30,
2020

2121
You can create and configure API keys to access your resources. An API key's access is determined by the permissions of the user who owns it. This means it can generally access any resource the user has permissions for, including their individual experiences and any [group-owned](../../projects/groups.md) experiences where they have the appropriate role. Some scopes can be restricted to specific experiences, but not all.
2222

23-
For details on how to create API keys for managing group resources, see the [Create API Keys for Managing Group-owned Resources](#create-api-keys-for-managing-group-owned-resources) section below.
23+
For details on how to create API keys for managing group resources, see the [Create API keys for managing group-owned resources](#create-api-keys-for-managing-group-owned-resources) section below.
2424

2525
To create an API key:
2626

@@ -46,10 +46,6 @@ To create an API key:
4646

4747
For a list of all scopes and the APIs they support, see [Scopes](../reference/scopes.md).
4848

49-
<Alert severity="warning">
50-
For security reasons, give each API key the minimum number of required permissions. If an API key leaks, this principle of least privilege ensures that only a subset of your resources are compromised.
51-
</Alert>
52-
5349
1. **(Optional)** In the **Security** section, explicitly restrict IP access to the key using [CIDR
5450
notation](#cidr-format). You can find
5551
the IP address of your local machine and add it to the **Accepted IP
@@ -71,16 +67,16 @@ To create an API key:
7167
your application. Never share it with untrusted parties, such as anyone outside
7268
of your development team. </Alert>
7369

74-
## Create API Keys for Managing Group-owned Resources
70+
## Create API keys for managing group-owned resources
7571

76-
An API key grants access to all resources the user account has permissions for, including personal experiences outside of the group. If you use your personal account's API key for group automation and that key is compromised, other resources you may have access to are also at risk.
72+
An API key grants access to all resources the user account has permissions for, including personal experiences outside of the group. If you use your personal account's API key for group automation and that key is compromised, other resources you have access to are also at risk.
7773

7874
To prevent this, we **strongly recommend** creating a separate API key on a dedicated alternate account with access strictly limited to the target group. This new account dedicated for automation purposes should only be given access to the target group and granted the minimal permissions required for its task.
7975

8076
1. Create a new, dedicated Roblox account for your automation.
8177
1. Invite the new account to your group.
8278
1. Assign it a group role with the minimum permissions required for its task (e.g., only "Create and edit group experiences").
83-
1. Log into the new account and follow the steps in the section above to [create an API key](#create-api-keys).
79+
1. Log in to the new account and follow the steps in the section above to [create an API key](#create-api-keys).
8480
1. Use the generated API key for group resource automation.
8581

8682
## Best Practices For Managing API Keys
@@ -91,15 +87,15 @@ API keys are sensitive credentials that should be kept secure to prevent unautho
9187

9288
- **Select the minimum permissions needed**: When configuring scopes, select the minimum permissions necessary for the key's intended use. For those scopes that allow you to restrict scope access by experience, limit access to only the specific experiences that are needed.
9389

94-
- **Use IP Address restrictions**: Restrict API key access to specific IP addresses or CIDR ranges to prevent unauthorized usage from unknown locations. Do not use IP Address restrictions when using your API key in Roblox places to ensure your key can be used with Roblox servers.
90+
- **Use IP address restrictions**: Restrict API key access to specific IP addresses or CIDR ranges to prevent unauthorized usage from unknown locations. Do not use IP address restrictions when using your API key in Roblox places to ensure your key can be used with Roblox servers.
9591

96-
- **Set expiration dates**: For short-term use cases, configure expiration dates to automatically disable keys after a set period, reducing the risk if a key is compromised. Setting expiration dates is not recommended for longer-term use cases unless you have a key rotation process in place, as your automation may unexpectedly fail when the key expires.
92+
- **Set expiration dates**: For short-term use cases, configure expiration dates to automatically disable keys after a set period, reducing the risk if a key is compromised. Setting expiration dates is not recommended for longer-term use cases unless you have a key rotation process in place, as your automation can unexpectedly fail when the key expires.
9793

98-
- **Use dedicated alternate accounts for group resource management**: Use a dedicated account with minimal permissions for group resource management, as detailed in the [Create API Keys for Managing Group-owned Resources](#create-api-keys-for-managing-group-owned-resources) section.
94+
- **Use dedicated alternate accounts for group resource management**: Use a dedicated account with minimal permissions for group resource management, as detailed in the [Create API keys for managing group-owned resources](#create-api-keys-for-managing-group-owned-resources) section.
9995

100-
- **Store API keys securely**: Never store API keys directly in your source code, version control systems, or scripts where they could be exposed. Prefer using a secrets management system for storing and controlling access to your keys. In Roblox places, you should use [Secrets Store](cloud-services/secrets).
96+
- **Store API keys securely**: Never store API keys directly in your source code, version control systems, or scripts where they could be exposed. Use a secrets management system for storing and controlling access to your keys. In Roblox places, use a [Secrets Store](cloud-services/secrets).
10197

102-
- **Do not share API Keys through public channels**: Never share API keys through public communication channels, forums, or social media. Only share keys through secure, private channels with trusted team members. Limit access to who you share your keys with to minimize the blast radius if a key is compromised.
98+
- **Do not share API keys through public channels**: Never share API keys through public communication channels, forums, or social media. Only share keys through secure, private channels with trusted team members. Limit access to who you share your keys with to minimize the blast radius if a key is compromised.
10399

104100
## CIDR format
105101

0 commit comments

Comments
 (0)