-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update Teams docs * small edit * move into table * update assets * update other table * add changelog * small clarif * table formatting
- Loading branch information
1 parent
6632a27
commit 80b0958
Showing
7 changed files
with
48 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,80 +1,76 @@ | ||
| # Teams | ||
|
|
||
| Teams are groups of developers on Discord who want to collaborate on apps. On other platforms, these may be referred to as "organizations", "companies", or "teams". We went with the name Teams because it best encompassed all the awesome conglomerates of devs that work together to make awesome things on Discord. Also, we never got picked for kickball in gym class, so now we get to be on a team. | ||
| Teams are groups of developers (or other Discord users) who want to collaborate and share access to an app's configuration, management, and payout settings. Go team(s)! | ||
|
|
||
| ## What Do They Do | ||
| ## Creating a Team | ||
|
|
||
| Teams allow you and other Discord users to share access to apps. No more sharing login credentials in order to reset the token on a bot that your friend owns but you work on, or other such cases. | ||
| To create or be a member on a team, you must [enable 2FA for your Discord account](https://support.discord.com/hc/en-us/articles/219576828-Setting-up-Two-Factor-Authentication). After you have 2FA enabled, create a team by navigating to the [Teams page](https://discord.com/developers/teams) then clicking the "New Team" button. | ||
|
|
||
| For game developers, this means that you can get your engineers access to your app for credentials they may need, your marketing folks access to store page management, and your finance people access to sales and performance metrics. | ||
|  | ||
|
|
||
| > danger | ||
| > For the initial release, Teams only support one kind of user: Admin. Admins have full access to all parts of an app _except_ for deleting the app and adding/removing users. That can only be done by the owner of the Team. | ||
| ## How Do I Make One | ||
|
|
||
| Making a Team is easy! Head on over to our [Team creation](https://discord.com/developers/teams) page and make your own. | ||
|
|
||
|  | ||
|
|
||
| Note that to use Discord Teams, you need to have 2FA enabled on your account. Security is of the utmost importance, especially when it comes to shared resources. If you're developing on your own and don't want to use Teams, you do not need 2FA. But, in order to keep other Team members safe, you'll need to add it to use Teams. | ||
| Once you create a team, you'll land on the **Team Information** page where you can fill out details and start inviting other Discord users to join your team. Since users added to a team have access to any apps that team owns, use caution when adding new team members. | ||
|
|
||
|  | ||
| > info | ||
| > Currently, only the team Owner can invite or remove additional users. | ||
| Once your team is made, you can start inviting other Discord users to join. | ||
| ## Adding Apps to a Team | ||
|
|
||
| > info | ||
| > For the initial release, only the Team owner can invite or remove additional users. | ||
| Once your team is set up, you can create or transfer apps that will be owned by the team. Teams can have a maximum of 25 apps. | ||
|
|
||
| ## Apps on Teams | ||
| ### Creating an App | ||
|
|
||
| Now that you've got your Team set up, you can start creating apps under it. Teams can own a maximum of 25 apps. To create a new app under a Team, select the Team in the app creation modal. If you want to keep the app under your own ownership, choose `Personal`: | ||
| To create a new app that belongs to a team, select the team from the **Team** dropdown in the app creation modal. If you want to keep the app under your own account's ownership, choose `Personal`: | ||
|
|
||
|  | ||
|  | ||
|
|
||
| If you have an existing app that you want to transfer to a Team, you can do that, too! Just go into the app that you want to transfer, hit `Transfer App to Team`, and send the app to its new home. | ||
| ### Transfering an App | ||
|
|
||
|  | ||
| To transfer an existing app to a team, navigate to the [Application](https://discord.com/developers/applications) that you want to transfer. At the bottom of the app's **General Information** page, click "Transfer App to Team". | ||
|
|
||
| > danger | ||
| > Once an app has been transferred to a team, it _cannot_ be transferred back. | ||
| ## What Next | ||
|  | ||
|
|
||
| What next? Go make awesome stuff! Whether you're a Game Developer, Mad Bot Scientist, or OAuth2 Enthusiast, you can now work together with other like-minded Discordians to bring your creations to life. | ||
| ## Team Member Roles | ||
|
|
||
| We've got a lot of awesome features planned for teams in the future, so stay tuned for things like: | ||
| Team members can be one of four roles (owner, admin, developer, and read-only), and each role inherits the access of those below it. Roles for team members can be configured under **Team Members** in a team's settings. | ||
|
|
||
| - Roles and Permissions | ||
| - Audit Logs | ||
| - More cat pictures | ||
| ###### Team Member Role Types | ||
|
|
||
| | Role Name | Value | Description | | ||
| | --------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | Owner | owner | Owners are the most permissiable role, and can take destructive, irreversible actions like deleting team-owned apps or the team itself. Teams are limited to 1 owner. | | ||
| | Admin | admin | Admins have similar access as owners, except they cannot take destructive actions on the team or team-owned apps. | | ||
| | Developer | developer | Developers can access information about team-owned apps, like the client secret or public key. They can also take limited actions on team-owned apps, like configuring interaction endpoints or resetting the bot token. Members with the Developer role *cannot* manage the team or its members, or take destructive actions on team-owned apps. | | ||
| | Read-only | read_only | Read-only members can access information about a team and any team-owned apps. Some examples include getting the IDs of applications and exporting payout records. | | ||
|
|
||
| Go team! | ||
|
|
||
| ## Data Models | ||
|
|
||
| ###### Team Object | ||
|
|
||
| | field | type | description | | ||
| | ------------- | --------------------------------------------------------------------------------- | -------------------------------------- | | ||
| | icon | ?string | a hash of the image of the team's icon | | ||
| | id | snowflake | the unique id of the team | | ||
| | members | array of [team member](#DOCS_TOPICS_TEAMS/data-models-team-member-object) objects | the members of the team | | ||
| | name | string | the name of the team | | ||
| | owner_user_id | snowflake | the user id of the current team owner | | ||
| | field | type | description | | ||
| | ------------- | --------------------------------------------------------------------------------- | ------------------------------------ | | ||
| | icon | ?string | Hash of the image of the team's icon | | ||
| | id | snowflake | Unique ID of the team | | ||
| | members | array of [team member](#DOCS_TOPICS_TEAMS/data-models-team-member-object) objects | Members of the team | | ||
| | name | string | Name of the team | | ||
| | owner_user_id | snowflake | User ID of the current team owner | | ||
|
|
||
| ###### Team Member Object | ||
|
|
||
| | field | type | description | | ||
| | ---------------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | ||
| | membership_state | integer | the user's [membership state](#DOCS_TOPICS_TEAMS/data-models-membership-state-enum) on the team | | ||
| | permissions | array of strings | will always be `["*"]` | | ||
| | team_id | snowflake | the id of the parent team of which they are a member | | ||
| | user | partial [user](#DOCS_RESOURCES_USER/user-object) object | the avatar, discriminator, id, and username of the user | | ||
| | field | type | description | | ||
| | ---------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------- | | ||
| | membership_state | integer | User's [membership state](#DOCS_TOPICS_TEAMS/data-models-membership-state-enum) on the team | | ||
| | team_id | snowflake | ID of the parent team of which they are a member | | ||
| | user | partial [user](#DOCS_RESOURCES_USER/user-object) object | Avatar, discriminator, ID, and username of the user | | ||
| | role | string | [Role](#DOCS_TOPICS_TEAMS/team-member-roles-team-member-role-types) of the team member | | ||
|
|
||
|
|
||
| ###### Membership State Enum | ||
|
|
||
| | name | value | | ||
| | -------- | ----- | | ||
| | INVITED | 1 | | ||
| | ACCEPTED | 2 | | ||
| | ACCEPTED | 2 | |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.