Update the authenticated user | Sample

8 body fields

namestringoptional

The new name of the user.

emailstringoptional

The publicly visible email address of the user.

blogstringoptional

The new blog URL of the user.

twitter_usernamestringoptional

The new Twitter username of the user.

companystringoptional

The new company of the user.

locationstringoptional

The new location of the user.

hireablebooleanoptional

The new hiring availability of the user.

biostringoptional

The new short biography of the user.

6 status codes

200Response

loginstringrequired

idintegerrequired

user_view_typestringoptional

node_idstringrequired

avatar_urlstringrequired

gravatar_idstringrequired

urlstringrequired

html_urlstringrequired

followers_urlstringrequired

following_urlstringrequired

gists_urlstringrequired

starred_urlstringrequired

subscriptions_urlstringrequired

organizations_urlstringrequired

repos_urlstringrequired

events_urlstringrequired

received_events_urlstringrequired

typestringrequired

site_adminbooleanrequired

namestringrequired

companystringrequired

blogstringrequired

locationstringrequired

emailstringrequired

notification_emailstringoptional

hireablebooleanrequired

biostringrequired

twitter_usernamestringoptional

public_reposintegerrequired

public_gistsintegerrequired

followersintegerrequired

followingintegerrequired

created_atstringrequired

updated_atstringrequired

private_gistsintegerrequired

total_private_reposintegerrequired

owned_private_reposintegerrequired

disk_usageintegerrequired

collaboratorsintegerrequired

two_factor_authenticationbooleanrequired

planobjectoptional

business_plusbooleanoptional

ldap_dnstringoptional

304Not modified

401Requires authentication

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

422Validation failed, or the endpoint has been spammed.

messagestringrequired

documentation_urlstringrequired

errorsarray<object>optional

Error handling

A 401 is returned: Requires authentication. A 403 is returned: Forbidden. A 404 is returned: Resource not found. A 422 is returned: Validation failed, or the endpoint has been spammed.

import { Client } from "octri-github";

const client = new Client({
  baseUrl: "https://api.github.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.user.update({
  name: "Untitled",
  email: "jane.doe@example.com",
  blog: "example",
  twitterUsername: "octocat",
  company: "example",
});

{
  "login": "octocat",
  "id": 1,
  "node_id": "MDQ6VXNlcjE=",
  "avatar_url": "https://github.com/images/error/octocat_happy.gif",
  "gravatar_id": "",
  "url": "https://api.github.com/users/octocat",
  "html_url": "https://github.com/octocat",
  "followers_url": "https://api.github.com/users/octocat/followers",
  "following_url": "https://api.github.com/users/octocat/following{/other_user}",
  "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
  "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
  "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
  "organizations_url": "https://api.github.com/users/octocat/orgs",
  "repos_url": "https://api.github.com/users/octocat/repos",
  "events_url": "https://api.github.com/users/octocat/events{/privacy}",
  "received_events_url": "https://api.github.com/users/octocat/received_events",
  "type": "User",
  "site_admin": false,
  "name": "monalisa octocat",
  "company": "GitHub",
  "blog": "https://github.com/blog",
  "location": "San Francisco",
  "email": "octocat@github.com",
  "hireable": false,
  "bio": "There once was...",
  "twitter_username": "monatheoctocat",
  "public_repos": 2,
  "public_gists": 1,
  "followers": 20,
  "following": 0,
  "created_at": "2008-01-14T04:33:35Z",
  "updated_at": "2008-01-14T04:33:35Z",
  "private_gists": 81,
  "total_private_repos": 100,
  "owned_private_repos": 100,
  "disk_usage": 10000,
  "collaborators": 8,
  "two_factor_authentication": true,
  "plan": {
    "name": "Medium",
    "space": 400,
    "private_repos": 20,
    "collaborators": 0
  }
}

Was this helpful?

Request

Response

Errors