GitHub v3 REST API

Application Grant

object

The authorization associated with an OAuth Access.

idintegerrequired

Example:1

urlstring(uri)required

Example:https://api.github.com/applications/grants/1

appobjectrequired
Show Child Parameters
created_atstring(date-time)required

Example:2011-09-06T17:26:27Z

updated_atstring(date-time)required

Example:2011-09-06T20:39:23Z

scopesarray[string]required

Example:public_repo

userobject

Simple User

Show Child Parameters
Example

Authorization

object

The authorization for an OAuth app, GitHub App, or a Personal Access Token.

idintegerrequired
urlstring(uri)required
scopesarray[string]required

A list of scopes that this authorization is in.

tokenstringrequired
token_last_eightstringrequired
hashed_tokenstringrequired
appobjectrequired
Show Child Parameters
notestringrequired
note_urlstring(uri)required
updated_atstring(date-time)required
created_atstring(date-time)required
fingerprintstringrequired
userobject

Simple User

Show Child Parameters
installationobject
Show Child Parameters
Example

Code Of Conduct

object

Code Of Conduct

keystringrequired

Example:contributor_covenant

namestringrequired

Example:Contributor Covenant

urlstring(uri)required

Example:https://api.github.com/codes_of_conduct/contributor_covenant

bodystring

Example:# Contributor Covenant Code of Conduct ## Our Pledge In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. ## Our Standards Examples of behavior that contributes to creating a positive environment include: * Using welcoming and inclusive language * Being respectful of differing viewpoints and experiences * Gracefully accepting constructive criticism * Focusing on what is best for the community * Showing empathy towards other community members Examples of unacceptable behavior by participants include: * The use of sexualized language or imagery and unwelcome sexual attention or advances * Trolling, insulting/derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or electronic address, without explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting ## Our Responsibilities Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. ## Scope This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] [homepage]: http://contributor-covenant.org [version]: http://contributor-covenant.org/version/1/4/

html_urlstring(uri)required
Example

announcement-message

string

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see “Basic writing and formatting syntax.”

Example

announcement-expiration

string

The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

Example