You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en-us/cloud/auth/api-keys.md
+29-38Lines changed: 29 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,19 +14,18 @@ authenticate to Open Cloud on your behalf.
14
14
15
15
## Create API keys
16
16
17
-
You can create and configure API keys for your individually-owned
18
-
experiences or [group-owned](../../projects/groups.md) experiences.
17
+
<Alertseverity="warning">
18
+
Group API keys are being deprecated and will not be supported after January 30, 2026. All references to API keys in the text below refer to user-owned keys.
19
+
</Alert>
19
20
20
-
You must be the group owner or assigned to a role within the group that has the
21
-
API key admin permission in order to create an API key for your group. A group
22
-
member can only create an API key with the same resource access permissions of
23
-
their role. For example, only group members with the **Create and edit group
24
-
experiences** permission can create an API key that can publish a place file.
21
+
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.
22
+
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.
25
24
26
25
To create an API key:
27
26
28
27
1. Navigate to the [Creator Dashboard](https://create.roblox.com/dashboard/creations).
29
-
1.**(Optional)** Click the **Creator Hub** dropdown to select a group if you are creating the API key for a group.
28
+
30
29
1. In the left navigation menu, select **Open Cloud**→[API Keys](https://create.roblox.com/dashboard/credentials?activeTab=ApiKeysTab).
31
30
1. Click the **Create API Key** button.
32
31
1. Enter a unique name for your API key. Use a name that can help you recall the
@@ -36,13 +35,9 @@ To create an API key:
36
35
System** menu. Repeat this step if
37
36
you need to add multiple APIs to the key.
38
37
39
-
<Alertseverity="info">
40
-
Certain permissions, generally those with the `legacy` prefix, aren't available for group-owned API keys. To add those permissions and send requests to the associated endpoints, you must use a user-owned API key.
41
-
</Alert>
42
-
43
38
1. If applicable, select the experience that you want to access with the API key.
44
39
45
-
For user-owned API keys, you have the option to disable **Restrict by Experience**. When disabled, your API key has access to all of your user-owned experiences and any group-owned experiences that you have the correct permissions for, including experiences created in the future.
40
+
You can optionally disable **Restrict by Experience**. When disabled, your API key has access to all of your user-owned experiences and any group-owned experiences where you have the appropriate permissions, including any experiences you create in the future.
46
41
47
42
1. From the **Select Operations** dropdown, select the operations that you
48
43
want to enable for the API key.
@@ -76,39 +71,35 @@ To create an API key:
76
71
your application. Never share it with untrusted parties, such as anyone outside
77
72
of your development team. </Alert>
78
73
79
-
## Group-owned API key permissions
74
+
## Create API Keys for Managing Group-owned Resources
75
+
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.
77
+
78
+
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.
79
+
80
+
1. Create a new, dedicated Roblox account for your automation.
81
+
1. Invite the new account to your group.
82
+
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).
84
+
1. Use the generated API key for group resource automation.
85
+
86
+
## Best Practices For Managing API Keys
80
87
81
-
Group owners can manage group-owned API key permissions for group members to
82
-
have different levels of control of API keys based on their [roles and
83
-
permissions](../../projects/groups.md#roles-and-permissions) within the group.
84
-
There are also situations that automatically revoke API key management
85
-
permissions for group members.
88
+
API keys are sensitive credentials that should be kept secure to prevent unauthorized access to your data. Here are some best practices for managing API keys.
86
89
87
-
### Permissions granting
90
+
-**Create separate keys for each application**: Create separate API keys for each application or use case to isolate access and reduce the impact if a key is compromised.
88
91
89
-
As a group owner, you can grant the **Manage all API keys** permission
90
-
to roles within your group. Members with this permission have all the
91
-
permissions that a group owner has for API keys, including the ability to
92
-
create, view, edit, revoke, and audit all of the group's API keys.
92
+
-**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.
93
93
94
-
You can also grant the **Manage own API keys** permission to roles within your
95
-
group. This allows members to only create and view keys owned by them rather
96
-
than being able to manage others' keys.
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.
97
95
98
-
### Permissions invalidation
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.
99
97
100
-
There are multiple situations that automatically revoke a group member's
101
-
permission to manage group API keys:
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.
102
99
103
-
- The member is assigned to a different role that doesn't have the permission.
104
-
This can happen during a transfer of the group ownership.
105
-
- The member's permission is disabled on their currently assigned role.
106
-
- The member leaves or is removed from the group.
107
-
- The member's account is under moderation by Roblox.
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).
108
101
109
-
In any of these cases, API keys generated by that user are given the **Revoked**
110
-
[status](#api-key-status). To use these keys again, the group owner or a member
111
-
with the **Manage all API keys** permission must regenerate the keys.
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.
Copy file name to clipboardExpand all lines: content/en-us/ip-licensing/faq.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,7 +58,7 @@ description: Frequently asked questions about IP licensing tools.
58
58
59
59
<dt>**How do I communicate with IP holders I have an agreement with?**</dt>
60
60
<dd><p />
61
-
IP holders can ask Roblox to contact you if they want to request any changes to a licensed experience. You'll receive a notification from Roblox to ensure that you can make any necessary changes to your experience.
61
+
IP holders can ask Roblox to contact you if they want to request any changes to a licensed experience. You'll receive a notification from Roblox to ensure that you can make any necessary changes to your experience.
62
62
<p /></dd><br />
63
63
64
64
<dt>**How will I be notified if a license changes?**</dt>
@@ -78,7 +78,7 @@ description: Frequently asked questions about IP licensing tools.
78
78
79
79
<dt>**What protections do I have as a creator from an IP owner who is trying to inaccurately claim IP in my experience?**</dt>
80
80
<dd><p />
81
-
If you believe an IP owner has inaccurately offered a license for your experience, you have 7 days to dispute the offer. When you dispute an offer, you can select from a set of reasons that tell the IP owner why the license isn't needed.
81
+
If you believe an IP owner has inaccurately offered a license for your experience, you have 14 days to dispute the offer. When you dispute an offer, you can select from a set of reasons that tell the IP owner why the license isn't needed.
82
82
<p /></dd><br />
83
83
84
84
<dt>**Can an IP license agreement ever be cancelled?**</dt>
Copy file name to clipboardExpand all lines: content/en-us/ip-licensing/license-manager.md
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,10 @@ To create your license listing:
43
43
3. Under **Experience eligibility**, select the criteria you want experiences to meet in order to apply to use the license. Creators whose experiences don't meet these requirements aren't eligible to apply to use your IP. To allow all creators to apply, leave the default values.
44
44
- For **Minimum average last 7 daily active users (DAU)**, choose between no requirement, greater than 1,000 DAU, or grater than 25,000 DAU.
45
45
- For **Maximum maturity rating**, choose between minimal, mild, moderate, and restricted. See [Maturity labels](../production/promotion/content-maturity.md#questionnaire-categories) for more information about different maturity ratings.
46
-
4. Under **Guidelines and restrictions**, upload a file with all guidelines and restrictions you want creators to follow when using your IP to build experiences. This file must describe what creators are and aren't allowed to do with your IP.
46
+
4. Under **Guidelines and restrictions**:
47
+
1. Enter the scope of your IP license. Include general background about the IP and clarify if any parts of the IP can or cannot be referenced by creators in their experience.
48
+
2. Under **Content standards**, set the rules that creators must follow when using your IP.
49
+
3. (Optional) Under **Brand guidelines**, upload a file to provide creators with creative direction.
47
50
5. Under **Privacy**, select one of the following:
48
51
-**Public** to make the license listing public and visible to all creators. This option also allows all eligible creators to apply to use the license.
49
52
-**Private** to make the license only available to creators that you reach out to directly and that have experiences that match your IP.
@@ -60,7 +63,7 @@ After you have created a license listing, you can go to **My licenses** ⟩ **[I
60
63
- To add new licenses to the listing, click **Add license**.
61
64
62
65
<Alertseverity="warning">
63
-
You **cannot** change the revenue share rate you set after you create a license listing.
66
+
Once your license has a pending, inquired, or active agreement, you **cannot** change the revenue share rate.
0 commit comments