details

Creates, updates, deletes, gets or lists a details resource.

Overview

Name	details
Type	Resource
Id	github.teams.details

Fields

The following fields are returned by SELECT queries:

get_by_name

Response

Name	Datatype	Description
id	integer	Unique identifier of the team
name	string	Name of the team (example: Developers)
enterprise_id	integer	Unique identifier of the enterprise to which this team belongs
node_id	string	(example: MDQ6VGVhbTE=)
organization_id	integer	Unique identifier of the organization to which this team belongs
created_at	string (date-time)	(example: 2017-07-14T16:53:42Z)
description	string	(example: A great team.)
html_url	string (uri)	(example: https://github.com/orgs/rails/teams/core)
ldap_dn	string	The distinguished name (DN) of the LDAP entry to map to a team. (example: cn=Enterprise Ops,ou=teams,dc=github,dc=com)
members_count	integer
members_url	string	(example: https://api.github.com/organizations/1/team/1/members{/member})
notification_setting	string	The notification setting the team has set (notifications_enabled, notifications_disabled) (example: notifications_enabled)
organization	object	Team Organization (title: Team Organization)
parent	object	Groups of organization members that gives permissions on specified repositories. (title: Team Simple)
permission	string	Permission that the team will have for its repositories (example: push)
privacy	string	The level of privacy this team should have (closed, secret) (example: closed)
repos_count	integer
repositories_url	string (uri)	(example: https://api.github.com/organizations/1/team/1/repos)
slug	string	(example: justice-league)
type	string	The ownership type of the team (enterprise, organization)
updated_at	string (date-time)	(example: 2017-08-17T12:37:15Z)
url	string (uri)	URL for the team (example: https://api.github.com/organizations/1/team/1)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_name	select	org, team_slug		Gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, "My TEam Näme" would become my-team-name. > [!NOTE] > You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
org	string	The organization name. The name is not case sensitive.
team_slug	string	The slug of the team name.

SELECT examples

get_by_name

Gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, "My TEam Näme" would become my-team-name.

> [!NOTE]
> You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.

SELECT
id,
name,
enterprise_id,
node_id,
organization_id,
created_at,
description,
html_url,
ldap_dn,
members_count,
members_url,
notification_setting,
organization,
parent,
permission,
privacy,
repos_count,
repositories_url,
slug,
type,
updated_at,
url
FROM github.teams.details
WHERE org = '{{ org }}' -- required
AND team_slug = '{{ team_slug }}' -- required
;