Users

Справочная документация по типам схем GraphQL в категории «Пользователи».

В этой статье

Queries

user

Query

Lookup a user by login.

Тип: User

Аргументы для user

Имя.Description

login (String!)

The user's login.

viewer

Query

The currently authenticated user.

Тип: User!

Mutations

changeUserStatus

Mutation

Update your status on GitHub.

Поля ввода для changeUserStatus

Возвращаемые поля для changeUserStatus

Имя.Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

status (UserStatus)

Your updated status.

createUserList

Mutation

Creates a new user list.

Поля ввода для createUserList

Возвращаемые поля для createUserList

Имя.Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

list (UserList)

The list that was just created.

viewer (User)

The user who created the list.

deleteUserList

Mutation

Deletes a user list.

Поля ввода для deleteUserList

Возвращаемые поля для deleteUserList

Имя.Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The owner of the list that will be deleted.

followUser

Mutation

Follow a user.

Поля ввода для followUser

Возвращаемые поля для followUser

Имя.Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The user that was followed.

setUserInteractionLimit

Mutation

Set a user level interaction limit for an user's public repositories.

Поля ввода для setUserInteractionLimit

Возвращаемые поля для setUserInteractionLimit

Имя.Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The user that the interaction limit was set for.

unfollowUser

Mutation

Unfollow a user.

Поля ввода для unfollowUser

Возвращаемые поля для unfollowUser

Имя.Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The user that was unfollowed.

updateUserList

Mutation

Updates an existing user list.

Поля ввода для updateUserList

Возвращаемые поля для updateUserList

Имя.Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

list (UserList)

The list that was just updated.

updateUserListsForItem

Mutation

Updates which of the viewer's lists an item belongs to.

Поля ввода для updateUserListsForItem

Возвращаемые поля для updateUserListsForItem

Имя.Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (UserListItems)

The item that was added.

lists ([UserList!])

The lists to which this item belongs.

user (User)

The user who owns the lists.

Objects

ActorConnection

Object

The connection type for Actor.

Поля для ActorConnection

Имя.Description

edges ([ActorEdge])

A list of edges.

nodes ([Actor])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ActorEdge

Object

An edge in a connection.

Поля для ActorEdge

Имя.Description

cursor (String!)

A cursor for use in pagination.

node (Actor)

The item at the end of the edge.

ActorLocation

Object

Location information for an actor.

Поля для ActorLocation

Имя.Description

city (String)

City.

country (String)

Country name.

countryCode (String)

Country code.

region (String)

Region name.

regionCode (String)

Region or state code.

ContributionCalendar

Object

A calendar of contributions made on GitHub by a user.

Поля для ContributionCalendar

Имя.Description

colors ([String!]!)

A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.

isHalloween (Boolean!)

Determine if the color set was chosen because it's currently Halloween.

months ([ContributionCalendarMonth!]!)

A list of the months of contributions in this calendar.

totalContributions (Int!)

The count of total contributions in the calendar.

weeks ([ContributionCalendarWeek!]!)

A list of the weeks of contributions in this calendar.

ContributionCalendarDay

Object

Represents a single day of contributions on GitHub by a user.

Поля для ContributionCalendarDay

Имя.Description

color (String!)

The hex color code that represents how many contributions were made on this day compared to others in the calendar.

contributionCount (Int!)

How many contributions were made by the user on this day.

contributionLevel (ContributionLevel!)

Indication of contributions, relative to other days. Can be used to indicate which color to represent this day on a calendar.

date (Date!)

The day this square represents.

weekday (Int!)

A number representing which day of the week this square represents, e.g., 1 is Monday.

ContributionCalendarMonth

Object

A month of contributions in a user's contribution graph.

Поля для ContributionCalendarMonth

Имя.Description

firstDay (Date!)

The date of the first day of this month.

name (String!)

The name of the month.

totalWeeks (Int!)

How many weeks started in this month.

year (Int!)

The year the month occurred in.

ContributionCalendarWeek

Object

A week of contributions in a user's contribution graph.

Поля для ContributionCalendarWeek

Имя.Description

contributionDays ([ContributionCalendarDay!]!)

The days of contributions in this week.

firstDay (Date!)

The date of the earliest square in this week.

ContributionsCollection

Object

A collection of contributions made by a user, including opened issues, commits, and pull requests. Contributions in private and internal repositories are only included with the optional read:user scope.

Поля для ContributionsCollection

Имя.Description

commitContributionsByRepository ([CommitContributionsByRepository!]!)

Commit contributions made by the user, grouped by repository.

Аргументы для commitContributionsByRepository

  • maxRepositories (Int)

    How many repositories should be included.

    The default value is 25.

contributionCalendar (ContributionCalendar!)

A calendar of this user's contributions on GitHub.

contributionYears ([Int!]!)

The years the user has been making contributions with the most recent year first.

doesEndInCurrentMonth (Boolean!)

Determine if this collection's time span ends in the current month.

earliestRestrictedContributionDate (Date)

The date of the first restricted contribution the user made in this time period. Can only be non-null when the user has enabled private contribution counts.

endedAt (DateTime!)

The ending date and time of this collection.

firstIssueContribution (CreatedIssueOrRestrictedContribution)

The first issue the user opened on GitHub. This will be null if that issue was opened outside the collection's time range and ignoreTimeRange is false. If the issue is not visible but the user has opted to show private contributions, a RestrictedContribution will be returned.

firstPullRequestContribution (CreatedPullRequestOrRestrictedContribution)

The first pull request the user opened on GitHub. This will be null if that pull request was opened outside the collection's time range and ignoreTimeRange is not true. If the pull request is not visible but the user has opted to show private contributions, a RestrictedContribution will be returned.

firstRepositoryContribution (CreatedRepositoryOrRestrictedContribution)

The first repository the user created on GitHub. This will be null if that first repository was created outside the collection's time range and ignoreTimeRange is false. If the repository is not visible, then a RestrictedContribution is returned.

hasActivityInThePast (Boolean!)

Does the user have any more activity in the timeline that occurred prior to the collection's time range?.

hasAnyContributions (Boolean!)

Determine if there are any contributions in this collection.

hasAnyRestrictedContributions (Boolean!)

Determine if the user made any contributions in this time frame whose details are not visible because they were made in a private repository. Can only be true if the user enabled private contribution counts.

isSingleDay (Boolean!)

Whether or not the collector's time span is all within the same day.

issueContributions (CreatedIssueContributionConnection!)

A list of issues the user opened.

Аргументы для issueContributions

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • excludeFirst (Boolean)

    Should the user's first issue ever be excluded from the result.

    The default value is false.

  • excludePopular (Boolean)

    Should the user's most commented issue be excluded from the result.

    The default value is false.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ContributionOrder)

    Ordering options for contributions returned from the connection.

issueContributionsByRepository ([IssueContributionsByRepository!]!)

Issue contributions made by the user, grouped by repository.

Аргументы для issueContributionsByRepository

  • excludeFirst (Boolean)

    Should the user's first issue ever be excluded from the result.

    The default value is false.

  • excludePopular (Boolean)

    Should the user's most commented issue be excluded from the result.

    The default value is false.

  • maxRepositories (Int)

    How many repositories should be included.

    The default value is 25.

joinedGitHubContribution (JoinedGitHubContribution)

When the user signed up for GitHub. This will be null if that sign up date falls outside the collection's time range and ignoreTimeRange is false.

latestRestrictedContributionDate (Date)

The date of the most recent restricted contribution the user made in this time period. Can only be non-null when the user has enabled private contribution counts.

mostRecentCollectionWithActivity (ContributionsCollection)

When this collection's time range does not include any activity from the user, use this to get a different collection from an earlier time range that does have activity.

mostRecentCollectionWithoutActivity (ContributionsCollection)

Returns a different contributions collection from an earlier time range than this one that does not have any contributions.

popularIssueContribution (CreatedIssueContribution)

The issue the user opened on GitHub that received the most comments in the specified time frame.

popularPullRequestContribution (CreatedPullRequestContribution)

The pull request the user opened on GitHub that received the most comments in the specified time frame.

pullRequestContributions (CreatedPullRequestContributionConnection!)

Pull request contributions made by the user.

Аргументы для pullRequestContributions

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • excludeFirst (Boolean)

    Should the user's first pull request ever be excluded from the result.

    The default value is false.

  • excludePopular (Boolean)

    Should the user's most commented pull request be excluded from the result.

    The default value is false.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ContributionOrder)

    Ordering options for contributions returned from the connection.

pullRequestContributionsByRepository ([PullRequestContributionsByRepository!]!)

Pull request contributions made by the user, grouped by repository.

Аргументы для pullRequestContributionsByRepository

  • excludeFirst (Boolean)

    Should the user's first pull request ever be excluded from the result.

    The default value is false.

  • excludePopular (Boolean)

    Should the user's most commented pull request be excluded from the result.

    The default value is false.

  • maxRepositories (Int)

    How many repositories should be included.

    The default value is 25.

pullRequestReviewContributions (CreatedPullRequestReviewContributionConnection!)

Pull request review contributions made by the user. Returns the most recently submitted review for each PR reviewed by the user.

Аргументы для pullRequestReviewContributions

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ContributionOrder)

    Ordering options for contributions returned from the connection.

pullRequestReviewContributionsByRepository ([PullRequestReviewContributionsByRepository!]!)

Pull request review contributions made by the user, grouped by repository.

Аргументы для pullRequestReviewContributionsByRepository

  • maxRepositories (Int)

    How many repositories should be included.

    The default value is 25.

repositoryContributions (CreatedRepositoryContributionConnection!)

A list of repositories owned by the user that the user created in this time range.

Аргументы для repositoryContributions

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • excludeFirst (Boolean)

    Should the user's first repository ever be excluded from the result.

    The default value is false.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ContributionOrder)

    Ordering options for contributions returned from the connection.

restrictedContributionsCount (Int!)

A count of contributions made by the user that the viewer cannot access. Only non-zero when the user has chosen to share their private contribution counts.

startedAt (DateTime!)

The beginning date and time of this collection.

totalCommitContributions (Int!)

How many commits were made by the user in this time span.

totalIssueContributions (Int!)

How many issues the user opened.

Аргументы для totalIssueContributions

  • excludeFirst (Boolean)

    Should the user's first issue ever be excluded from this count.

    The default value is false.

  • excludePopular (Boolean)

    Should the user's most commented issue be excluded from this count.

    The default value is false.

totalPullRequestContributions (Int!)

How many pull requests the user opened.

Аргументы для totalPullRequestContributions

  • excludeFirst (Boolean)

    Should the user's first pull request ever be excluded from this count.

    The default value is false.

  • excludePopular (Boolean)

    Should the user's most commented pull request be excluded from this count.

    The default value is false.

totalPullRequestReviewContributions (Int!)

How many pull request reviews the user left.

totalRepositoriesWithContributedCommits (Int!)

How many different repositories the user committed to.

totalRepositoriesWithContributedIssues (Int!)

How many different repositories the user opened issues in.

Аргументы для totalRepositoriesWithContributedIssues

  • excludeFirst (Boolean)

    Should the user's first issue ever be excluded from this count.

    The default value is false.

  • excludePopular (Boolean)

    Should the user's most commented issue be excluded from this count.

    The default value is false.

totalRepositoriesWithContributedPullRequestReviews (Int!)

How many different repositories the user left pull request reviews in.

totalRepositoriesWithContributedPullRequests (Int!)

How many different repositories the user opened pull requests in.

Аргументы для totalRepositoriesWithContributedPullRequests

  • excludeFirst (Boolean)

    Should the user's first pull request ever be excluded from this count.

    The default value is false.

  • excludePopular (Boolean)

    Should the user's most commented pull request be excluded from this count.

    The default value is false.

totalRepositoryContributions (Int!)

How many repositories the user created.

Аргументы для totalRepositoryContributions

  • excludeFirst (Boolean)

    Should the user's first repository ever be excluded from this count.

    The default value is false.

user (User!)

The user who made the contributions in this collection.

CreatedCommitContribution

Object

Represents the contribution a user made by committing to a repository.

CreatedCommitContribution Реализует

Поля для CreatedCommitContribution

Имя.Description

commitCount (Int!)

How many commits were made on this day to this repository by the user.

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt (DateTime!)

When this contribution was made.

repository (Repository!)

The repository the user made a commit in.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.

CreatedCommitContributionConnection

Object

The connection type for CreatedCommitContribution.

Поля для CreatedCommitContributionConnection

Имя.Description

edges ([CreatedCommitContributionEdge])

A list of edges.

nodes ([CreatedCommitContribution])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of commits across days and repositories in the connection.

CreatedCommitContributionEdge

Object

An edge in a connection.

Поля для CreatedCommitContributionEdge

Имя.Description

cursor (String!)

A cursor for use in pagination.

node (CreatedCommitContribution)

The item at the end of the edge.

CreatedIssueContribution

Object

Represents the contribution a user made on GitHub by opening an issue.

CreatedIssueContribution Реализует

Поля для CreatedIssueContribution

Имя.Description

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

issue (Issue!)

The issue that was opened.

occurredAt (DateTime!)

When this contribution was made.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.

CreatedIssueContributionConnection

Object

The connection type for CreatedIssueContribution.

Поля для CreatedIssueContributionConnection

Имя.Description

edges ([CreatedIssueContributionEdge])

A list of edges.

nodes ([CreatedIssueContribution])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CreatedIssueContributionEdge

Object

An edge in a connection.

Поля для CreatedIssueContributionEdge

Имя.Description

cursor (String!)

A cursor for use in pagination.

node (CreatedIssueContribution)

The item at the end of the edge.

CreatedPullRequestContribution

Object

Represents the contribution a user made on GitHub by opening a pull request.

CreatedPullRequestContribution Реализует

Поля для CreatedPullRequestContribution

Имя.Description

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt (DateTime!)

When this contribution was made.

pullRequest (PullRequest!)

The pull request that was opened.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.

CreatedPullRequestContributionConnection

Object

The connection type for CreatedPullRequestContribution.

Поля для CreatedPullRequestContributionConnection

Имя.Description

edges ([CreatedPullRequestContributionEdge])

A list of edges.

nodes ([CreatedPullRequestContribution])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CreatedPullRequestContributionEdge

Object

An edge in a connection.

Поля для CreatedPullRequestContributionEdge

Имя.Description

cursor (String!)

A cursor for use in pagination.

node (CreatedPullRequestContribution)

The item at the end of the edge.

CreatedPullRequestReviewContribution

Object

Represents the contribution a user made by leaving a review on a pull request.

CreatedPullRequestReviewContribution Реализует

Поля для CreatedPullRequestReviewContribution

Имя.Description

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt (DateTime!)

When this contribution was made.

pullRequest (PullRequest!)

The pull request the user reviewed.

pullRequestReview (PullRequestReview!)

The review the user left on the pull request.

repository (Repository!)

The repository containing the pull request that the user reviewed.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.

CreatedPullRequestReviewContributionConnection

Object

The connection type for CreatedPullRequestReviewContribution.

Поля для CreatedPullRequestReviewContributionConnection

Имя.Description

edges ([CreatedPullRequestReviewContributionEdge])

A list of edges.

nodes ([CreatedPullRequestReviewContribution])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CreatedPullRequestReviewContributionEdge

Object

An edge in a connection.

Поля для CreatedPullRequestReviewContributionEdge

Имя.Description

cursor (String!)

A cursor for use in pagination.

node (CreatedPullRequestReviewContribution)

The item at the end of the edge.

CreatedRepositoryContribution

Object

Represents the contribution a user made on GitHub by creating a repository.

CreatedRepositoryContribution Реализует

Поля для CreatedRepositoryContribution

Имя.Description

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt (DateTime!)

When this contribution was made.

repository (Repository!)

The repository that was created.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.

CreatedRepositoryContributionConnection

Object

The connection type for CreatedRepositoryContribution.

Поля для CreatedRepositoryContributionConnection

Имя.Description

edges ([CreatedRepositoryContributionEdge])

A list of edges.

nodes ([CreatedRepositoryContribution])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CreatedRepositoryContributionEdge

Object

An edge in a connection.

Поля для CreatedRepositoryContributionEdge

Имя.Description

cursor (String!)

A cursor for use in pagination.

node (CreatedRepositoryContribution)

The item at the end of the edge.

EnterpriseAdministratorConnection

Object

The connection type for User.

Поля для EnterpriseAdministratorConnection

Имя.Description

edges ([EnterpriseAdministratorEdge])

A list of edges.

nodes ([User])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

EnterpriseAdministratorEdge

Object

A User who is an administrator of an enterprise.

Поля для EnterpriseAdministratorEdge

Имя.Description

cursor (String!)

A cursor for use in pagination.

node (User)

The item at the end of the edge.

role (EnterpriseAdministratorRole!)

The role of the administrator.

EnterpriseOutsideCollaboratorConnection

Object

The connection type for User.

Поля для EnterpriseOutsideCollaboratorConnection

Имя.Description

edges ([EnterpriseOutsideCollaboratorEdge])

A list of edges.

nodes ([User])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

EnterpriseOutsideCollaboratorEdge

Object

A User who is an outside collaborator of an enterprise through one or more organizations.

Поля для EnterpriseOutsideCollaboratorEdge

Имя.Description

cursor (String!)

A cursor for use in pagination.

node (User)

The item at the end of the edge.

repositories (EnterpriseRepositoryInfoConnection!)

The enterprise organization repositories this user is a member of.

Аргументы для repositories

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

EnterpriseTeamMemberConnection

Object

The connection type for User.

Поля для EnterpriseTeamMemberConnection

Имя.Description

edges ([EnterpriseTeamMemberEdge])

A list of edges.

nodes ([User])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

EnterpriseTeamMemberEdge

Object

Represents a user who is a member of an enterprise team.

Поля для EnterpriseTeamMemberEdge

Имя.Description

cursor (String!)

A cursor for use in pagination.

node (User)

N/A

FollowerConnection

Object

The connection type for User.

Поля для FollowerConnection

Имя.Description

edges ([UserEdge])

A list of edges.

nodes ([User])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

FollowingConnection

Object

The connection type for User.

Поля для FollowingConnection

Имя.Description

edges ([UserEdge])

A list of edges.

nodes ([User])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

GenericHovercardContext

Object

A generic hovercard context with a message and icon.

GenericHovercardContext Реализует

Поля для GenericHovercardContext

Имя.Description

message (String!)

A string describing this context.

octicon (String!)

An octicon to accompany this context.

Hovercard

Object

Detail needed to display a hovercard for a user.

Поля для Hovercard

Имя.Description

contexts ([HovercardContext!]!)

Each of the contexts for this hovercard.

JoinedGitHubContribution

Object

Represents a user signing up for a GitHub account.

JoinedGitHubContribution Реализует

Поля для JoinedGitHubContribution

Имя.Description

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt (DateTime!)

When this contribution was made.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.

OrganizationEnterpriseOwnerConnection

Object

The connection type for User.

Поля для OrganizationEnterpriseOwnerConnection

Имя.Description

edges ([OrganizationEnterpriseOwnerEdge])

A list of edges.

nodes ([User])

A list of nodes.