Manage user accounts | Admin console

<!doctype html> <html lang="en" dir="ltr"> <head> <meta name="google-signin-client-id" content="721724668570-nbkv1cfusk7kk4eni4pjvepaus73b13t.apps.googleusercontent.com"> <meta name="google-signin-scope" content="profile email https://www.googleapis.com/auth/developerprofiles https://www.googleapis.com/auth/developerprofiles.award"> <meta property="og:site_name" content="Google for Developers"> <meta property="og:type" content="website"><meta name="theme-color" content="#fff"><meta charset="utf-8"> <meta content="IE=Edge" http-equiv="X-UA-Compatible"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="manifest" href="/_pwa/developers/manifest.json" crossorigin="use-credentials"> <link rel="preconnect" href="//www.gstatic.com" crossorigin> <link rel="preconnect" href="//fonts.gstatic.com" crossorigin> <link rel="preconnect" href="//fonts.googleapis.com" crossorigin> <link rel="preconnect" href="//apis.google.com" crossorigin> <link rel="preconnect" href="//www.google-analytics.com" crossorigin><link rel="stylesheet" href="//fonts.googleapis.com/css?family=Google+Sans:400,500|Roboto:400,400italic,500,500italic,700,700italic|Roboto+Mono:400,500,700&display=swap"> <link rel="stylesheet" href="//fonts.googleapis.com/css2?family=Material+Icons&family=Material+Symbols+Outlined&display=block"><link rel="stylesheet" href="https://www.gstatic.com/devrel-devsite/prod/vd2dddc2199cd18ccf014281c77515e1e906f6b98324fd2a8b5fa9e92b09e8018/developers/css/app.css"> <link rel="shortcut icon" href="https://www.gstatic.com/devrel-devsite/prod/vd2dddc2199cd18ccf014281c77515e1e906f6b98324fd2a8b5fa9e92b09e8018/developers/images/favicon-new.png"> <link rel="apple-touch-icon" href="https://www.gstatic.com/devrel-devsite/prod/vd2dddc2199cd18ccf014281c77515e1e906f6b98324fd2a8b5fa9e92b09e8018/developers/images/touchicon-180-new.png"><link rel="canonical" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users"><link rel="search" type="application/opensearchdescription+xml" title="Google for Developers" href="https://developers.google.com/s/opensearch.xml"> <link rel="alternate" hreflang="en" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users" /><link rel="alternate" hreflang="x-default" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users" /><link rel="alternate" hreflang="ar" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=ar" /><link rel="alternate" hreflang="bn" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=bn" /><link rel="alternate" hreflang="zh-Hans" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=zh-cn" /><link rel="alternate" hreflang="zh-Hant" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=zh-tw" /><link rel="alternate" hreflang="fa" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=fa" /><link rel="alternate" hreflang="fr" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=fr" /><link rel="alternate" hreflang="de" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=de" /><link rel="alternate" hreflang="he" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=he" /><link rel="alternate" hreflang="hi" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=hi" /><link rel="alternate" hreflang="id" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=id" /><link rel="alternate" hreflang="it" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=it" /><link rel="alternate" hreflang="ja" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=ja" /><link rel="alternate" hreflang="ko" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=ko" /><link rel="alternate" hreflang="pl" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=pl" /><link rel="alternate" hreflang="pt-BR" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=pt-br" /><link rel="alternate" hreflang="ru" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=ru" /><link rel="alternate" hreflang="es-419" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=es-419" /><link rel="alternate" hreflang="th" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=th" /><link rel="alternate" hreflang="tr" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=tr" /><link rel="alternate" hreflang="vi" href="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users?hl=vi" /><title>Manage user accounts  |  Admin console  |  Google for Developers</title> <meta property="og:title" content="Manage user accounts  |  Admin console  |  Google for Developers"><meta property="og:url" content="https://developers.google.com/admin-sdk/directory/v1/guides/manage-users"><meta property="og:image" content="https://www.gstatic.com/devrel-devsite/prod/vd2dddc2199cd18ccf014281c77515e1e906f6b98324fd2a8b5fa9e92b09e8018/developers/images/opengraph/white.png"> <meta property="og:image:width" content="1200"> <meta property="og:image:height" content="675"><meta property="og:locale" content="en"><meta name="twitter:card" content="summary_large_image"><script type="application/ld+json"> { "@context": "https://schema.org", "@type": "Article", "headline": "Manage user accounts" } </script><script type="application/ld+json"> { "@context": "https://schema.org", "@type": "BreadcrumbList", "itemListElement": [{ "@type": "ListItem", "position": 1, "name": "Google Workspace", "item": "https://developers.google.com/workspace" },{ "@type": "ListItem", "position": 2, "name": "Admin console", "item": "https://developers.google.com/admin-sdk" },{ "@type": "ListItem", "position": 3, "name": "Manage user accounts", "item": "https://developers.google.com/admin-sdk/directory/v1/guides/manage-users" }] } </script> <link rel="stylesheet" href="/extras.css"></head> <body class="" template="page" theme="white" type="article" layout="docs" concierge='closed' display-toc pending> <devsite-progress type="indeterminate" id="app-progress"></devsite-progress> <a href="#main-content" class="skip-link button"> Skip to main content </a> <section class="devsite-wrapper"> <devsite-cookie-notification-bar></devsite-cookie-notification-bar><devsite-header role="banner"> <div class="devsite-header--inner nocontent"> <div class="devsite-top-logo-row-wrapper-wrapper"> <div class="devsite-top-logo-row-wrapper"> <div class="devsite-top-logo-row"> <button type="button" id="devsite-hamburger-menu" class="devsite-header-icon-button button-flat material-icons gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Navigation menu button" visually-hidden aria-label="Open menu"> </button> <div class="devsite-product-name-wrapper"> <a href="https://developers.google.com/workspace"> <div class="devsite-product-logo-container" size="medium" > <picture> <img class="devsite-product-logo" alt="Google Workspace" src="https://fonts.gstatic.com/s/i/productlogos/googleg/v6/16px.svg" srcset=" https://fonts.gstatic.com/s/i/productlogos/googleg/v6/16px.svg" sizes="64px" loading="lazy" > </picture> </div> </a> <ul class="devsite-breadcrumb-list" > <li class="devsite-breadcrumb-item devsite-has-google-wordmark"> <a href="https://developers.google.com/workspace" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Upper Header" data-value="1" track-type="globalNav" track-name="breadcrumb" track-metadata-position="1" track-metadata-eventdetail="Google Workspace" > <svg class="devsite-google-wordmark" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 148 48"> <title>Google</title> <path class="devsite-google-wordmark-svg-path" d="M19.58,37.65c-9.87,0-18.17-8.04-18.17-17.91c0-9.87,8.3-17.91,18.17-17.91c5.46,0,9.35,2.14,12.27,4.94l-3.45,3.45c-2.1-1.97-4.93-3.49-8.82-3.49c-7.21,0-12.84,5.81-12.84,13.02c0,7.21,5.64,13.02,12.84,13.02c4.67,0,7.34-1.88,9.04-3.58c1.4-1.4,2.32-3.41,2.66-6.16H19.58v-4.89h16.47c0.18,0.87,0.26,1.92,0.26,3.06c0,3.67-1.01,8.21-4.24,11.44C28.93,35.9,24.91,37.65,19.58,37.65z M61.78,26.12c0,6.64-5.1,11.53-11.36,11.53s-11.36-4.89-11.36-11.53c0-6.68,5.1-11.53,11.36-11.53S61.78,19.43,61.78,26.12z M56.8,26.12c0-4.15-2.96-6.99-6.39-6.99c-3.43,0-6.39,2.84-6.39,6.99c0,4.11,2.96,6.99,6.39,6.99C53.84,33.11,56.8,30.22,56.8,26.12z M87.25,26.12c0,6.64-5.1,11.53-11.36,11.53c-6.26,0-11.36-4.89-11.36-11.53c0-6.68,5.1-11.53,11.36-11.53C82.15,14.59,87.25,19.43,87.25,26.12zM82.28,26.12c0-4.15-2.96-6.99-6.39-6.99c-3.43,0-6.39,2.84-6.39,6.99c0,4.11,2.96,6.99,6.39,6.99C79.32,33.11,82.28,30.22,82.28,26.12z M112.09,15.29v20.7c0,8.52-5.02,12.01-10.96,12.01c-5.59,0-8.95-3.76-10.22-6.81l4.41-1.83c0.79,1.88,2.71,4.1,5.81,4.1c3.8,0,6.16-2.36,6.16-6.77v-1.66h-0.18c-1.14,1.4-3.32,2.62-6.07,2.62c-5.76,0-11.05-5.02-11.05-11.49c0-6.51,5.28-11.57,11.05-11.57c2.75,0,4.93,1.22,6.07,2.58h0.18v-1.88H112.09z M107.64,26.16c0-4.06-2.71-7.03-6.16-7.03c-3.49,0-6.42,2.97-6.42,7.03c0,4.02,2.93,6.94,6.42,6.94C104.93,33.11,107.64,30.18,107.64,26.16z M120.97,3.06v33.89h-5.07V3.06H120.97z M140.89,29.92l3.93,2.62c-1.27,1.88-4.32,5.11-9.61,5.11c-6.55,0-11.28-5.07-11.28-11.53c0-6.86,4.77-11.53,10.71-11.53c5.98,0,8.91,4.76,9.87,7.34l0.52,1.31l-15.42,6.38c1.18,2.31,3.01,3.49,5.59,3.49C137.79,33.11,139.58,31.84,140.89,29.92zM128.79,25.77l10.31-4.28c-0.57-1.44-2.27-2.45-4.28-2.45C132.24,19.04,128.66,21.31,128.79,25.77z"/> </svg>Workspace </a> </li> </ul> </div> <div class="devsite-top-logo-row-middle"> <div class="devsite-header-upper-tabs"> <devsite-tabs class="upper-tabs"> <nav class="devsite-tabs-wrapper" aria-label="Upper tabs"> <tab > <a href="https://developers.google.com/workspace" class="devsite-tabs-content gc-analytics-event " track-metadata-eventdetail="https://developers.google.com/workspace" track-type="nav" track-metadata-position="nav - home" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Home" track-name="home" > Home </a> </tab> <tab class="devsite-active"> <a href="https://developers.google.com/admin-sdk" class="devsite-tabs-content gc-analytics-event " track-metadata-eventdetail="https://developers.google.com/admin-sdk" track-type="nav" track-metadata-position="nav - admin console" track-metadata-module="primary nav" aria-label="Admin console, selected" data-category="Site-Wide Custom Events" data-label="Tab: Admin console" track-name="admin console" > Admin console </a> </tab> <tab class="devsite-dropdown "> <a href="https://developers.google.com/workspace/products-menu" class="devsite-tabs-content gc-analytics-event " track-metadata-eventdetail="https://developers.google.com/workspace/products-menu" track-type="nav" track-metadata-position="nav - all products" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: All products" track-name="all products" > All products </a> <button aria-haspopup="menu" aria-expanded="false" aria-label="Dropdown menu for All products" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/products-menu" track-metadata-position="nav - all products" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: All products" track-name="all products" class="devsite-tabs-dropdown-toggle devsite-icon devsite-icon-arrow-drop-down"></button> <div class="devsite-tabs-dropdown" role="menu" aria-label="submenu" hidden> <div class="devsite-tabs-dropdown-content"> <div class="devsite-tabs-dropdown-column "> <ul class="devsite-tabs-dropdown-section "> <li class="devsite-nav-title" role="heading" tooltip>Google Workspace apps</li> <li class="devsite-nav-item"> <a href="https://developers.google.com/admin-sdk" track-type="nav" track-metadata-eventdetail="https://developers.google.com/admin-sdk" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="google workspace apps" tooltip data-label="Tab menu: All products - Admin console" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Admin console </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/cloud-search" track-type="nav" track-metadata-eventdetail="https://developers.google.com/cloud-search" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="google workspace apps" tooltip data-category="Workspace top menu navigation" data-label="Tab menu: All products - Cloud Search" > <div class="devsite-nav-item-title"> Cloud Search </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/gmail" track-type="nav" track-metadata-eventdetail="https://developers.google.com/gmail" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="google workspace apps" tooltip data-label="Tab menu: All products - Gmail" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Gmail </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/calendar" track-type="nav" track-metadata-eventdetail="https://developers.google.com/calendar" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="google workspace apps" tooltip data-label="Tab menu: All products - Google Calendar" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Calendar </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/chat" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/chat" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="google workspace apps" tooltip data-label="Tab menu: All products - Google Chat" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Chat </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/classroom" track-type="nav" track-metadata-eventdetail="https://developers.google.com/classroom" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="google workspace apps" tooltip data-label="Tab menu: All products - Google Classroom" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Classroom </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/docs" track-type="nav" track-metadata-eventdetail="https://developers.google.com/docs" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="google workspace apps" tooltip data-label="Tab menu: All products - Google Docs" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Docs </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/drive" track-type="nav" track-metadata-eventdetail="https://developers.google.com/drive" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="google workspace apps" tooltip data-label="Tab menu: All products - Google Drive" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Drive </div> </a> </li> </ul> </div> <div class="devsite-tabs-dropdown-column "> <ul class="devsite-tabs-dropdown-section "> <li class="devsite-nav-title" role="heading" tooltip> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/forms" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/forms" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline=" " tooltip data-category="Workspace top menu navigation" data-label="Tab menu: All products - Google Forms" > <div class="devsite-nav-item-title"> Google Forms </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/keep" track-type="nav" track-metadata-eventdetail="https://developers.google.com/keep" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline=" " tooltip data-label="Tab menu: All products - Google Keep" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Keep </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/meet" track-type="nav" track-metadata-eventdetail="https://developers.google.com/meet" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline=" " tooltip data-label="Tab menu: All products - Google Meet" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Meet </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/sheets" track-type="nav" track-metadata-eventdetail="https://developers.google.com/sheets" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline=" " tooltip data-label="Tab menu: All products - Google Sheets" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Sheets </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/sites" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/sites" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline=" " tooltip data-category="Workspace top menu navigation" data-label="Tab menu: All products - Google Sites" > <div class="devsite-nav-item-title"> Google Sites </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/slides" track-type="nav" track-metadata-eventdetail="https://developers.google.com/slides" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline=" " tooltip data-label="Tab menu: All products - Google Slides" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Slides </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/tasks" track-type="nav" track-metadata-eventdetail="https://developers.google.com/tasks" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline=" " tooltip data-label="Tab menu: All products - Google Tasks" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Tasks </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/vault" track-type="nav" track-metadata-eventdetail="https://developers.google.com/vault" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline=" " tooltip data-label="Tab menu: All products - Google Vault" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Vault </div> </a> </li> </ul> </div> <div class="devsite-tabs-dropdown-column "> <ul class="devsite-tabs-dropdown-section "> <li class="devsite-nav-title" role="heading" tooltip>Extend, automate & share</li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/add-ons" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/add-ons" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="extend, automate & share" tooltip data-label="Tab menu: All products - Add-ons" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Add-ons </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/apps-script" track-type="nav" track-metadata-eventdetail="https://developers.google.com/apps-script" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="extend, automate & share" tooltip data-label="Tab menu: All products - Apps Script" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Apps Script </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/chat/overview" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/chat/overview" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="extend, automate & share" tooltip data-category="Workspace top menu navigation" data-label="Tab menu: All products - Chat apps" > <div class="devsite-nav-item-title"> Chat apps </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/drive/api/guides/about-apps" track-type="nav" track-metadata-eventdetail="https://developers.google.com/drive/api/guides/about-apps" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="extend, automate & share" tooltip data-category="Workspace top menu navigation" data-label="Tab menu: All products - Drive apps" > <div class="devsite-nav-item-title"> Drive apps </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/marketplace" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/marketplace" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="extend, automate & share" tooltip data-label="Tab menu: All products - Marketplace" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Marketplace </div> </a> </li> </ul> </div> </div> </div> </tab> <tab class="devsite-dropdown "> <a href="https://developers.google.com/workspace/resources-menu" class="devsite-tabs-content gc-analytics-event " track-metadata-eventdetail="https://developers.google.com/workspace/resources-menu" track-type="nav" track-metadata-position="nav - resources" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Resources" track-name="resources" > Resources </a> <button aria-haspopup="menu" aria-expanded="false" aria-label="Dropdown menu for Resources" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/resources-menu" track-metadata-position="nav - resources" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Resources" track-name="resources" class="devsite-tabs-dropdown-toggle devsite-icon devsite-icon-arrow-drop-down"></button> <div class="devsite-tabs-dropdown" role="menu" aria-label="submenu" hidden> <div class="devsite-tabs-dropdown-content"> <div class="devsite-tabs-dropdown-column "> <ul class="devsite-tabs-dropdown-section "> <li class="devsite-nav-title" role="heading" tooltip>Tools</li> <li class="devsite-nav-item"> <a href="https://admin.google.com/" track-type="nav" track-metadata-eventdetail="https://admin.google.com/" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="tools" tooltip data-label="Tab menu: Resources - Admin console" data-category="Workspace top menu navigation" target="admin-console" > <div class="devsite-nav-item-title"> Admin console </div> </a> </li> <li class="devsite-nav-item"> <a href="https://script.google.com/" track-type="nav" track-metadata-eventdetail="https://script.google.com/" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="tools" tooltip target="_blank" data-label="Tab menu: Resources - Apps Script dashboard" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Apps Script dashboard </div> </a> </li> <li class="devsite-nav-item"> <a href="https://console.cloud.google.com/workspace-api" track-type="nav" track-metadata-eventdetail="https://console.cloud.google.com/workspace-api" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="tools" tooltip data-label="Tab menu: Resources - Google Cloud console" data-category="Workspace top menu navigation" target="console" > <div class="devsite-nav-item-title"> Google Cloud console </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/explore" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/explore" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="tools" tooltip data-label="Tab menu: Resources - APIs Explorer" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> APIs Explorer </div> </a> </li> <li class="devsite-nav-item"> <a href="https://addons.gsuite.google.com/uikit/builder" track-type="nav" track-metadata-eventdetail="https://addons.gsuite.google.com/uikit/builder" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="tools" tooltip data-category="Workspace top menu navigation" target="_blank" data-label="Tab menu: Resources - Card Builder" > <div class="devsite-nav-item-title"> Card Builder </div> </a> </li> </ul> </div> <div class="devsite-tabs-dropdown-column "> <ul class="devsite-tabs-dropdown-section "> <li class="devsite-nav-title" role="heading" tooltip>Training & support</li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/guides/get-started" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/guides/get-started" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="training & support" tooltip data-label="Tab menu: Resources - How to get started" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> How to get started </div> </a> </li> <li class="devsite-nav-item"> <a href="https://codelabs.developers.google.com/?product=googleworkspace" track-type="nav" track-metadata-eventdetail="https://codelabs.developers.google.com/?product=googleworkspace" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="training & support" tooltip target="_blank" data-label="Tab menu: Resources - Codelabs" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Codelabs </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/support" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/support" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="training & support" tooltip data-label="Tab menu: Resources - Developer support" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Developer support </div> </a> </li> </ul> </div> <div class="devsite-tabs-dropdown-column "> <ul class="devsite-tabs-dropdown-section "> <li class="devsite-nav-title" role="heading" tooltip>Updates</li> <li class="devsite-nav-item"> <a href="https://developers.googleblog.com/search/?query=Google+Workspace" track-type="nav" track-metadata-eventdetail="https://developers.googleblog.com/search/?query=Google+Workspace" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="updates" tooltip data-label="Tab menu: Resources - Blog" target="_blank" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Blog </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/preview" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/preview" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="updates" tooltip data-label="Tab menu: Resources - Developer previews" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Developer Previews </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/newsletters" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/newsletters" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="updates" tooltip data-category="Workspace top menu navigation" data-label="Tab menu: Resources - Newsletter" > <div class="devsite-nav-item-title"> Newsletter </div> </a> </li> <li class="devsite-nav-item"> <a href="https://twitter.com/workspacedevs" track-type="nav" track-metadata-eventdetail="https://twitter.com/workspacedevs" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="updates" tooltip data-category="Workspace top menu navigation" data-label="Tab menu: Resources - X (Twitter)" target="_blank" > <div class="devsite-nav-item-title"> X (Twitter) </div> </a> </li> <li class="devsite-nav-item"> <a href="https://www.youtube.com/channel/UCUcg6az6etU_gRtZVAhBXaw" track-type="nav" track-metadata-eventdetail="https://www.youtube.com/channel/UCUcg6az6etU_gRtZVAhBXaw" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="updates" tooltip target="_blank" data-category="Workspace top menu navigation" data-label="Tab menu: Resources - YouTube" > <div class="devsite-nav-item-title"> YouTube </div> </a> </li> </ul> </div> </div> </div> </tab> </nav> </devsite-tabs> </div> <devsite-search enable-signin enable-search enable-suggestions enable-query-completion project-name="Admin console" tenant-name="Google for Developers" project-scope="/admin-sdk" url-scoped="https://developers.google.com/s/results/admin-sdk" > <form class="devsite-search-form" action="https://developers.google.com/s/results" method="GET"> <div class="devsite-search-container"> <button type="button" search-open class="devsite-search-button devsite-header-icon-button button-flat material-icons" aria-label="Open search"></button> <div class="devsite-searchbox"> <input aria-activedescendant="" aria-autocomplete="list" aria-label="Search" aria-expanded="false" aria-haspopup="listbox" autocomplete="off" class="devsite-search-field devsite-search-query" name="q" placeholder="Search" role="combobox" type="text" value="" > <div class="devsite-search-image material-icons" aria-hidden="true"> </div> <div class="devsite-search-shortcut-icon-container" aria-hidden="true"> <kbd class="devsite-search-shortcut-icon">/</kbd> </div> </div> </div> </form> <button type="button" search-close class="devsite-search-button devsite-header-icon-button button-flat material-icons" aria-label="Close search"></button> </devsite-search> </div> <devsite-language-selector> <ul role="presentation"> <li role="presentation"> <a role="menuitem" lang="en" >English</a> </li> <li role="presentation"> <a role="menuitem" lang="de" >Deutsch</a> </li> <li role="presentation"> <a role="menuitem" lang="es" >Español</a> </li> <li role="presentation"> <a role="menuitem" lang="es_419" >Español – América Latina</a> </li> <li role="presentation"> <a role="menuitem" lang="fr" >Français</a> </li> <li role="presentation"> <a role="menuitem" lang="id" >Indonesia</a> </li> <li role="presentation"> <a role="menuitem" lang="it" >Italiano</a> </li> <li role="presentation"> <a role="menuitem" lang="pl" >Polski</a> </li> <li role="presentation"> <a role="menuitem" lang="pt_br" >Português – Brasil</a> </li> <li role="presentation"> <a role="menuitem" lang="vi" >Tiếng Việt</a> </li> <li role="presentation"> <a role="menuitem" lang="tr" >Türkçe</a> </li> <li role="presentation"> <a role="menuitem" lang="ru" >Русский</a> </li> <li role="presentation"> <a role="menuitem" lang="he" >עברית</a> </li> <li role="presentation"> <a role="menuitem" lang="ar" >العربيّة</a> </li> <li role="presentation"> <a role="menuitem" lang="fa" >فارسی</a> </li> <li role="presentation"> <a role="menuitem" lang="hi" >हिंदी</a> </li> <li role="presentation"> <a role="menuitem" lang="bn" >বাংলা</a> </li> <li role="presentation"> <a role="menuitem" lang="th" >ภาษาไทย</a> </li> <li role="presentation"> <a role="menuitem" lang="zh_cn" >中文 – 简体</a> </li> <li role="presentation"> <a role="menuitem" lang="zh_tw" >中文 – 繁體</a> </li> <li role="presentation"> <a role="menuitem" lang="ja" >日本語</a> </li> <li role="presentation"> <a role="menuitem" lang="ko" >한국어</a> </li> </ul> </devsite-language-selector> <devsite-user enable-profiles fp-auth id="devsite-user"> Sign in </devsite-user> </div> </div> </div> <div class="devsite-collapsible-section "> <div class="devsite-header-background"> <div class="devsite-product-id-row" > <div class="devsite-product-description-row"> <ul class="devsite-breadcrumb-list" > <li class="devsite-breadcrumb-item "> <a href="https://developers.google.com/admin-sdk" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Lower Header" data-value="1" track-type="globalNav" track-name="breadcrumb" track-metadata-position="1" track-metadata-eventdetail="Admin console" > Admin console </a> </li> </ul> </div> </div> <div class="devsite-doc-set-nav-row"> <devsite-tabs class="lower-tabs"> <nav class="devsite-tabs-wrapper" aria-label="Lower tabs"> <tab > <a href="https://developers.google.com/admin-sdk" class="devsite-tabs-content gc-analytics-event " track-metadata-eventdetail="https://developers.google.com/admin-sdk" track-type="nav" track-metadata-position="nav - overview" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Overview" track-name="overview" > Overview </a> </tab> <tab class="devsite-active"> <a href="https://developers.google.com/admin-sdk/overview" class="devsite-tabs-content gc-analytics-event " track-metadata-eventdetail="https://developers.google.com/admin-sdk/overview" track-type="nav" track-metadata-position="nav - guides" track-metadata-module="primary nav" aria-label="Guides, selected" data-category="Site-Wide Custom Events" data-label="Tab: Guides" track-name="guides" > Guides </a> </tab> <tab > <a href="https://developers.google.com/admin-sdk/reference-overview" class="devsite-tabs-content gc-analytics-event " track-metadata-eventdetail="https://developers.google.com/admin-sdk/reference-overview" track-type="nav" track-metadata-position="nav - reference" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Reference" track-name="reference" > Reference </a> </tab> <tab > <a href="https://developers.google.com/admin-sdk/support" class="devsite-tabs-content gc-analytics-event " track-metadata-eventdetail="https://developers.google.com/admin-sdk/support" track-type="nav" track-metadata-position="nav - support" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Support" track-name="support" > Support </a> </tab> </nav> </devsite-tabs> </div> </div> </div> </div> </devsite-header> <devsite-book-nav scrollbars > <div class="devsite-book-nav-filter" > <input type="text" placeholder="Filter" aria-label="Type to filter" role="searchbox"> </div> <nav class="devsite-book-nav devsite-nav nocontent" aria-label="Side menu"> <div class="devsite-mobile-header"> <button type="button" id="devsite-close-nav" class="devsite-header-icon-button button-flat material-icons gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Close navigation" aria-label="Close navigation"> </button> <div class="devsite-product-name-wrapper"> <a href="https://developers.google.com/workspace"> <div class="devsite-product-logo-container" size="medium" > <picture> <img class="devsite-product-logo" alt="Google Workspace" src="https://fonts.gstatic.com/s/i/productlogos/googleg/v6/16px.svg" srcset=" https://fonts.gstatic.com/s/i/productlogos/googleg/v6/16px.svg" sizes="64px" loading="lazy" > </picture> </div> </a> <ul class="devsite-breadcrumb-list" > <li class="devsite-breadcrumb-item devsite-has-google-wordmark"> <a href="https://developers.google.com/workspace" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Upper Header" data-value="1" track-type="globalNav" track-name="breadcrumb" track-metadata-position="1" track-metadata-eventdetail="Google Workspace" > <svg class="devsite-google-wordmark" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 148 48"> <title>Google</title> <path class="devsite-google-wordmark-svg-path" d="M19.58,37.65c-9.87,0-18.17-8.04-18.17-17.91c0-9.87,8.3-17.91,18.17-17.91c5.46,0,9.35,2.14,12.27,4.94l-3.45,3.45c-2.1-1.97-4.93-3.49-8.82-3.49c-7.21,0-12.84,5.81-12.84,13.02c0,7.21,5.64,13.02,12.84,13.02c4.67,0,7.34-1.88,9.04-3.58c1.4-1.4,2.32-3.41,2.66-6.16H19.58v-4.89h16.47c0.18,0.87,0.26,1.92,0.26,3.06c0,3.67-1.01,8.21-4.24,11.44C28.93,35.9,24.91,37.65,19.58,37.65z M61.78,26.12c0,6.64-5.1,11.53-11.36,11.53s-11.36-4.89-11.36-11.53c0-6.68,5.1-11.53,11.36-11.53S61.78,19.43,61.78,26.12z M56.8,26.12c0-4.15-2.96-6.99-6.39-6.99c-3.43,0-6.39,2.84-6.39,6.99c0,4.11,2.96,6.99,6.39,6.99C53.84,33.11,56.8,30.22,56.8,26.12z M87.25,26.12c0,6.64-5.1,11.53-11.36,11.53c-6.26,0-11.36-4.89-11.36-11.53c0-6.68,5.1-11.53,11.36-11.53C82.15,14.59,87.25,19.43,87.25,26.12zM82.28,26.12c0-4.15-2.96-6.99-6.39-6.99c-3.43,0-6.39,2.84-6.39,6.99c0,4.11,2.96,6.99,6.39,6.99C79.32,33.11,82.28,30.22,82.28,26.12z M112.09,15.29v20.7c0,8.52-5.02,12.01-10.96,12.01c-5.59,0-8.95-3.76-10.22-6.81l4.41-1.83c0.79,1.88,2.71,4.1,5.81,4.1c3.8,0,6.16-2.36,6.16-6.77v-1.66h-0.18c-1.14,1.4-3.32,2.62-6.07,2.62c-5.76,0-11.05-5.02-11.05-11.49c0-6.51,5.28-11.57,11.05-11.57c2.75,0,4.93,1.22,6.07,2.58h0.18v-1.88H112.09z M107.64,26.16c0-4.06-2.71-7.03-6.16-7.03c-3.49,0-6.42,2.97-6.42,7.03c0,4.02,2.93,6.94,6.42,6.94C104.93,33.11,107.64,30.18,107.64,26.16z M120.97,3.06v33.89h-5.07V3.06H120.97z M140.89,29.92l3.93,2.62c-1.27,1.88-4.32,5.11-9.61,5.11c-6.55,0-11.28-5.07-11.28-11.53c0-6.86,4.77-11.53,10.71-11.53c5.98,0,8.91,4.76,9.87,7.34l0.52,1.31l-15.42,6.38c1.18,2.31,3.01,3.49,5.59,3.49C137.79,33.11,139.58,31.84,140.89,29.92zM128.79,25.77l10.31-4.28c-0.57-1.44-2.27-2.45-4.28-2.45C132.24,19.04,128.66,21.31,128.79,25.77z"/> </svg>Workspace </a> </li> </ul> </div> </div> <div class="devsite-book-nav-wrapper"> <div class="devsite-mobile-nav-top"> <ul class="devsite-nav-list"> <li class="devsite-nav-item"> <a href="/workspace" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Tab: Home" track-name="home" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Home" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Home </a> </li> <li class="devsite-nav-item"> <a href="/admin-sdk" class="devsite-nav-title gc-analytics-event devsite-nav-active" data-category="Site-Wide Custom Events" data-label="Tab: Admin console" track-name="admin console" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Admin console" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Admin console </a> <ul class="devsite-nav-responsive-tabs"> <li class="devsite-nav-item"> <a href="/admin-sdk" class="devsite-nav-title gc-analytics-event devsite-nav-has-children " data-category="Site-Wide Custom Events" data-label="Tab: Overview" track-name="overview" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Overview" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Overview </a> </li> <li class="devsite-nav-item"> <a href="/admin-sdk/overview" class="devsite-nav-title gc-analytics-event devsite-nav-has-children devsite-nav-active" data-category="Site-Wide Custom Events" data-label="Tab: Guides" track-name="guides" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Guides" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Guides </a> </li> <li class="devsite-nav-item"> <a href="/admin-sdk/reference-overview" class="devsite-nav-title gc-analytics-event devsite-nav-has-children " data-category="Site-Wide Custom Events" data-label="Tab: Reference" track-name="reference" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Reference" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Reference </a> </li> <li class="devsite-nav-item"> <a href="/admin-sdk/support" class="devsite-nav-title gc-analytics-event devsite-nav-has-children " data-category="Site-Wide Custom Events" data-label="Tab: Support" track-name="support" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Support" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Support </a> </li> </ul> </li> <li class="devsite-nav-item"> <a href="/workspace/products-menu" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Tab: All products" track-name="all products" data-category="Site-Wide Custom Events" data-label="Responsive Tab: All products" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> All products </a> <ul class="devsite-nav-responsive-tabs devsite-nav-has-menu "> <li class="devsite-nav-item"> More </li> </ul> </li> <li class="devsite-nav-item"> <a href="/workspace/resources-menu" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Tab: Resources" track-name="resources" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Resources" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Resources </a> <ul class="devsite-nav-responsive-tabs devsite-nav-has-menu "> <li class="devsite-nav-item"> More </li> </ul> </li> </ul> </div> <div class="devsite-mobile-nav-bottom"> <ul class="devsite-nav-list" menu="_book"> <li class="devsite-nav-item"><a href="/admin-sdk/overview" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/overview" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/overview" >Overview</a></li> <li class="devsite-nav-item devsite-nav-external"><a href="/workspace/guides/get-started" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/guides/get-started" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/guides/get-started" target="_blank">Get started</a></li> <li class="devsite-nav-item devsite-nav-external"><a href="/workspace/guides/configure-oauth-consent" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/guides/configure-oauth-consent" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/guides/configure-oauth-consent" target="_blank">Configure OAuth consent</a></li> <li class="devsite-nav-item devsite-nav-heading"><div class="devsite-nav-title devsite-nav-title-no-path"> Organization structure & resources </div></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Directory API </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides" >Overview</a></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/prerequisites" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/prerequisites" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/prerequisites" >Prerequisites</a></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/authorizing" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/authorizing" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/authorizing" >Choose scopes</a></li><li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Quickstarts </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/quickstart/js" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/quickstart/js" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/quickstart/js" >JavaScript</a></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/quickstart/go" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/quickstart/go" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/quickstart/go" >Go</a></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/quickstart/apps-script" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/quickstart/apps-script" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/quickstart/apps-script" >Google Apps Script</a></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/quickstart/java" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/quickstart/java" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/quickstart/java" >Java</a></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/quickstart/nodejs" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/quickstart/nodejs" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/quickstart/nodejs" >Node.js</a></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/quickstart/python" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/quickstart/python" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/quickstart/python" >Python</a></li></ul></div></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/libraries" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/libraries" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/libraries" >Install client libraries</a></li><li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Manage devices & browsers </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/manage-chrome-browsers" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/manage-chrome-browsers" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/manage-chrome-browsers" >Chrome browsers</a></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/manage-chrome-devices" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/manage-chrome-devices" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/manage-chrome-devices" >Chrome devices</a></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/manage-mobile-devices" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/manage-mobile-devices" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/manage-mobile-devices" >Mobile devices</a></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/search-devices" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/search-devices" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/search-devices" >Search for devices</a></li></ul></div></li><li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Manage groups & members </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/manage-groups" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/manage-groups" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/manage-groups" >Groups</a></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/manage-group-members" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/manage-group-members" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/manage-group-members" >Group members</a></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/search-groups" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/search-groups" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/search-groups" >Search for Groups</a></li></ul></div></li><li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Manage structure </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/manage-org-units" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/manage-org-units" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/manage-org-units" >Manage organizational units</a></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/manage-roles" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/manage-roles" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/manage-roles" >Manage roles</a></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/manage-customers" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/manage-customers" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/manage-customers" >Manage customers</a></li></ul></div></li><li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Manage users & aliases </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/manage-users" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/manage-users" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/manage-users" >User accounts</a></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/manage-user-aliases" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/manage-user-aliases" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/manage-user-aliases" >User aliases</a></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/manage-schemas" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/manage-schemas" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/manage-schemas" >Custom user fields</a></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/search-users" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/search-users" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/search-users" >Search for users</a></li></ul></div></li><li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Troubleshoot </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/troubleshoot-authentication-authorization" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/troubleshoot-authentication-authorization" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/troubleshoot-authentication-authorization" >Troubleshoot authentication and authorization</a></li><li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/troubleshoot-error-codes" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/troubleshoot-error-codes" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/troubleshoot-error-codes" >Troubleshoot error codes</a></li></ul></div></li></ul></div></li> <li class="devsite-nav-item devsite-nav-external"><a href="https://cloud.google.com/identity/docs" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: https://cloud.google.com/identity/docs" track-type="bookNav" track-name="click" track-metadata-eventdetail="https://cloud.google.com/identity/docs" target="_blank">Cloud Identity API</a></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Data Transfer API </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/data-transfer" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/data-transfer" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/data-transfer" >Overview</a></li><li class="devsite-nav-item"><a href="/admin-sdk/data-transfer/v1/libraries" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/data-transfer/v1/libraries" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/data-transfer/v1/libraries" >Install client libraries</a></li><li class="devsite-nav-item"><a href="/admin-sdk/data-transfer/v1/transfer-data" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/data-transfer/v1/transfer-data" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/data-transfer/v1/transfer-data" >Transfer data</a></li></ul></div></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Contact Delegation API </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/contact-delegation/guides" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/contact-delegation/guides" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/contact-delegation/guides" >Overview</a></li><li class="devsite-nav-item"><a href="/admin-sdk/contact-delegation/guides/manage-delegates" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/contact-delegation/guides/manage-delegates" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/contact-delegation/guides/manage-delegates" >Manage contact delegates</a></li></ul></div></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Groups Settings API </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/groups-settings/concepts" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/groups-settings/concepts" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/groups-settings/concepts" >Overview</a></li><li class="devsite-nav-item"><a href="/admin-sdk/groups-settings/libraries" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/groups-settings/libraries" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/groups-settings/libraries" >Install client libraries</a></li><li class="devsite-nav-item"><a href="/admin-sdk/groups-settings/auth" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/groups-settings/auth" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/groups-settings/auth" >Choose scopes</a></li><li class="devsite-nav-item"><a href="/admin-sdk/groups-settings/manage" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/groups-settings/manage" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/groups-settings/manage" >Retrieve & update settings for Google Groups</a></li></ul></div></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Groups Migration API </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/groups-migration/v1/guides/overview" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/groups-migration/v1/guides/overview" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/groups-migration/v1/guides/overview" >Overview</a></li><li class="devsite-nav-item"><a href="/admin-sdk/groups-migration/v1/guides/prerequisites" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/groups-migration/v1/guides/prerequisites" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/groups-migration/v1/guides/prerequisites" >Prerequisites</a></li><li class="devsite-nav-item"><a href="/admin-sdk/groups-migration/v1/guides/authorizing" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/groups-migration/v1/guides/authorizing" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/groups-migration/v1/guides/authorizing" >Choose scopes</a></li><li class="devsite-nav-item"><a href="/admin-sdk/groups-migration/v1/libraries" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/groups-migration/v1/libraries" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/groups-migration/v1/libraries" >Install client libraries</a></li><li class="devsite-nav-item"><a href="/admin-sdk/groups-migration/v1/guides/manage-email-migrations" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/groups-migration/v1/guides/manage-email-migrations" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/groups-migration/v1/guides/manage-email-migrations" >Migrate emails</a></li></ul></div></li> <li class="devsite-nav-item devsite-nav-external"><a href="/people" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /people" track-type="bookNav" track-name="click" track-metadata-eventdetail="/people" target="_blank">People API</a></li> <li class="devsite-nav-item devsite-nav-heading"><div class="devsite-nav-title devsite-nav-title-no-path"> Audits, usage & security </div></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Reports API </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/get-start/overview" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/get-start/overview" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/get-start/overview" >Overview</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reports/auth" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/auth" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/auth" >Choose scopes</a></li><li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Quickstarts </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/quickstart/js" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/quickstart/js" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/quickstart/js" >JavaScript</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/quickstart/go" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/quickstart/go" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/quickstart/go" >Go</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/quickstart/apps-script" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/quickstart/apps-script" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/quickstart/apps-script" >Google Apps Script</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/quickstart/java" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/quickstart/java" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/quickstart/java" >Java</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/quickstart/nodejs" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/quickstart/nodejs" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/quickstart/nodejs" >Node.js</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/quickstart/python" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/quickstart/python" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/quickstart/python" >Python</a></li></ul></div></li><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/libraries" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/libraries" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/libraries" >Install client libraries</a></li><li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Audit activity </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/guides/manage-audit-admin" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/guides/manage-audit-admin" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/guides/manage-audit-admin" >Admin</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/guides/manage-audit-mobile" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/guides/manage-audit-mobile" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/guides/manage-audit-mobile" >Devices</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/guides/manage-audit-drive" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/guides/manage-audit-drive" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/guides/manage-audit-drive" >Drive</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/guides/manage-audit-login" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/guides/manage-audit-login" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/guides/manage-audit-login" >Logins</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/guides/manage-audit-tokens" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/guides/manage-audit-tokens" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/guides/manage-audit-tokens" >OAuth Tokens</a></li></ul></div></li><li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Monitor apps usage </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/guides/manage-usage-customers" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/guides/manage-usage-customers" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/guides/manage-usage-customers" >Customers</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/guides/manage-usage-users" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/guides/manage-usage-users" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/guides/manage-usage-users" >Users</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/guides/manage-usage-entities" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/guides/manage-usage-entities" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/guides/manage-usage-entities" >Entities</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/updated-drive-metrics" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/updated-drive-metrics" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/updated-drive-metrics" >Update Docs & Drive metrics</a></li><li class="devsite-nav-item devsite-nav-external"><a href="https://support.google.com/a/answer/7061566" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: https://support.google.com/a/answer/7061566" track-type="bookNav" track-name="click" track-metadata-eventdetail="https://support.google.com/a/answer/7061566" target="_blank">Data retention & lag times</a></li></ul></div></li><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/guides/batch" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/guides/batch" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/guides/batch" >Send batch requests</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/guides/push" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/guides/push" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/guides/push" >Push notifications</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reports/v1/guides/troubleshoot-authentication-authorization" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reports/v1/guides/troubleshoot-authentication-authorization" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reports/v1/guides/troubleshoot-authentication-authorization" >Troubleshoot authentication & authorization</a></li></ul></div></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Alert Center API </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/alertcenter/guides" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/alertcenter/guides" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/alertcenter/guides" >Overview</a></li><li class="devsite-nav-item"><a href="/admin-sdk/alertcenter/guides/auth" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/alertcenter/guides/auth" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/alertcenter/guides/auth" >Choose scopes</a></li><li class="devsite-nav-item"><a href="/admin-sdk/alertcenter/guides/libraries" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/alertcenter/guides/libraries" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/alertcenter/guides/libraries" >Install client libraries</a></li><li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Quickstart </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/alertcenter/quickstart/java" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/alertcenter/quickstart/java" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/alertcenter/quickstart/java" >Java</a></li></ul></div></li><li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Set up alerts & notifications </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/alertcenter/guides/notifications" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/alertcenter/guides/notifications" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/alertcenter/guides/notifications" >Send notifications</a></li><li class="devsite-nav-item"><a href="/admin-sdk/alertcenter/guides/query-filters" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/alertcenter/guides/query-filters" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/alertcenter/guides/query-filters" >Filter queries</a></li></ul></div></li><li class="devsite-nav-item"><a href="/admin-sdk/alertcenter/guides/errors" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/alertcenter/guides/errors" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/alertcenter/guides/errors" >Troubleshoot errors</a></li></ul></div></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Email Audit API </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/email-audit/overview" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/email-audit/overview" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/email-audit/overview" >Overview</a></li><li class="devsite-nav-item"><a href="/admin-sdk/email-audit/auth" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/email-audit/auth" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/email-audit/auth" >Choose scopes</a></li><li class="devsite-nav-item"><a href="/admin-sdk/email-audit/monitor-email" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/email-audit/monitor-email" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/email-audit/monitor-email" >Monitor emails</a></li><li class="devsite-nav-item"><a href="/admin-sdk/email-audit/download-mailbox" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/email-audit/download-mailbox" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/email-audit/download-mailbox" >Download a mailbox</a></li></ul></div></li> <li class="devsite-nav-item devsite-nav-heading"><div class="devsite-nav-title devsite-nav-title-no-path"> Domains & licenses </div></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Reseller API </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/how-tos/concepts" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/how-tos/concepts" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/how-tos/concepts" >Overview</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/how-tos/prerequisites" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/how-tos/prerequisites" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/how-tos/prerequisites" >Prerequisites</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/how-tos/authorize" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/how-tos/authorize" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/how-tos/authorize" >Choose scopes</a></li><li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Quickstarts </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/quickstart/js" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/quickstart/js" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/quickstart/js" >JavaScript</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/quickstart/go" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/quickstart/go" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/quickstart/go" >Go</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/quickstart/apps-script" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/quickstart/apps-script" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/quickstart/apps-script" >Google Apps Script</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/quickstart/java" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/quickstart/java" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/quickstart/java" >Java</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/quickstart/nodejs" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/quickstart/nodejs" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/quickstart/nodejs" >Node.js</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/quickstart/python" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/quickstart/python" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/quickstart/python" >Python</a></li></ul></div></li><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/libraries" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/libraries" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/libraries" >Install client libraries</a></li><li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Manage customers </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/codelab/end-to-end" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/codelab/end-to-end" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/codelab/end-to-end" >Provision a customer</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/how-tos/manage_customers" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/how-tos/manage_customers" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/how-tos/manage_customers" >Order a new customer account</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/how-tos/retrieve-update-customers" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/how-tos/retrieve-update-customers" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/how-tos/retrieve-update-customers" >Retrieve & update a customer's account information</a></li></ul></div></li><li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Manage subscriptions </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/how-tos/create-subscription" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/how-tos/create-subscription" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/how-tos/create-subscription" >Create or transfer a subscription</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/how-tos/change-subscription-status" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/how-tos/change-subscription-status" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/how-tos/change-subscription-status" >Change a subscription status</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/how-tos/manage_subscriptions" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/how-tos/manage_subscriptions" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/how-tos/manage_subscriptions" >Retrieve & update a subscription</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/how-tos/push" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/how-tos/push" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/how-tos/push" >Push notifications</a></li></ul></div></li><li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Troubleshoot </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/troubleshoot-authentication-authorization" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/troubleshoot-authentication-authorization" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/troubleshoot-authentication-authorization" >Troubleshoot authentication & authorization</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/support/reseller_api_common_errors" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/support/reseller_api_common_errors" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/support/reseller_api_common_errors" >Troubleshoot Reseller API errors</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/support/directory_api_common_errors" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/support/directory_api_common_errors" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/support/directory_api_common_errors" >Troubleshoot Directory API errors</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/support/site_verification_api_common_errors" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/support/site_verification_api_common_errors" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/support/site_verification_api_common_errors" >Troubleshoot Site Verification API errros</a></li><li class="devsite-nav-item"><a href="/admin-sdk/reseller/v1/support/enterprise_license_manager_api_common_errors" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/reseller/v1/support/enterprise_license_manager_api_common_errors" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/reseller/v1/support/enterprise_license_manager_api_common_errors" >Troubleshoot Enterprise License Manager API</a></li></ul></div></li></ul></div></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Enterprise License Manager API </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/licensing/v1/how-tos/concepts" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/licensing/v1/how-tos/concepts" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/licensing/v1/how-tos/concepts" >Overview</a></li><li class="devsite-nav-item"><a href="/admin-sdk/licensing/v1/libraries" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/licensing/v1/libraries" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/licensing/v1/libraries" >Install client libraries</a></li><li class="devsite-nav-item"><a href="/admin-sdk/licensing/v1/how-tos/authorizing" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/licensing/v1/how-tos/authorizing" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/licensing/v1/how-tos/authorizing" >Choose scopes</a></li><li class="devsite-nav-item"><a href="/admin-sdk/licensing/v1/how-tos/using" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/licensing/v1/how-tos/using" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/licensing/v1/how-tos/using" >Manage licenses</a></li><li class="devsite-nav-item"><a href="/admin-sdk/licensing/v1/how-tos/batch" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/licensing/v1/how-tos/batch" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/licensing/v1/how-tos/batch" >Send batch requests</a></li></ul></div></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Admin Settings API </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/admin-settings/auth" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/admin-settings/auth" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/admin-settings/auth" >Choose scopes</a></li><li class="devsite-nav-item"><a href="/admin-sdk/admin-settings" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/admin-settings" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/admin-settings" >Manage SSO and email routing</a></li></ul></div></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Domain Shared Contacts API </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/domain-shared-contacts/overview" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/domain-shared-contacts/overview" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/domain-shared-contacts/overview" >Overview</a></li><li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Manage shared contacts </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/domain-shared-contacts/create-shared-contacts" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/domain-shared-contacts/create-shared-contacts" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/domain-shared-contacts/create-shared-contacts" >Create shared contacts</a></li><li class="devsite-nav-item"><a href="/admin-sdk/domain-shared-contacts/get-shared-contacts" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/domain-shared-contacts/get-shared-contacts" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/domain-shared-contacts/get-shared-contacts" >Get shared contacts</a></li><li class="devsite-nav-item"><a href="/admin-sdk/domain-shared-contacts/update-delete-shared-contacts" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/domain-shared-contacts/update-delete-shared-contacts" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/domain-shared-contacts/update-delete-shared-contacts" >Update or delete shared contacts</a></li></ul></div></li><li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Manage photos of shared contacts </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/domain-shared-contacts/get-photo-shared-contacts" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/domain-shared-contacts/get-photo-shared-contacts" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/domain-shared-contacts/get-photo-shared-contacts" >Get a photo for a shared contact</a></li><li class="devsite-nav-item"><a href="/admin-sdk/domain-shared-contacts/update-delete-photo-shared-contacts" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/domain-shared-contacts/update-delete-photo-shared-contacts" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/domain-shared-contacts/update-delete-photo-shared-contacts" >Update or delete a photo for a shared contact</a></li></ul></div></li><li class="devsite-nav-item"><a href="/admin-sdk/domain-shared-contacts/troubleshoot" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/domain-shared-contacts/troubleshoot" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/domain-shared-contacts/troubleshoot" >Troubleshoot</a></li></ul></div></li> <li class="devsite-nav-item devsite-nav-heading"><div class="devsite-nav-title devsite-nav-title-no-path"> Chrome browsers & printers </div></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Chrome Printer Management API </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/admin-sdk/chrome-printer/guides" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/chrome-printer/guides" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/chrome-printer/guides" >Overview</a></li><li class="devsite-nav-item"><a href="/admin-sdk/chrome-printer/guides/get-started" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/chrome-printer/guides/get-started" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/chrome-printer/guides/get-started" >Get started</a></li><li class="devsite-nav-item"><a href="/admin-sdk/chrome-printer/guides/manage-printers" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/chrome-printer/guides/manage-printers" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/chrome-printer/guides/manage-printers" >Create & manage printers</a></li><li class="devsite-nav-item"><a href="/admin-sdk/chrome-printer/guides/manage-print-servers" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/chrome-printer/guides/manage-print-servers" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/chrome-printer/guides/manage-print-servers" >Create & manage print servers</a></li></ul></div></li> <li class="devsite-nav-item devsite-nav-external"><a href="https://support.google.com/chrome/a/answer/9681204?ref_topic=9301744" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: https://support.google.com/chrome/a/answer/9681204?ref_topic=9301744" track-type="bookNav" track-name="click" track-metadata-eventdetail="https://support.google.com/chrome/a/answer/9681204?ref_topic=9301744" target="_blank">Chrome Enterprise Core API</a></li> <li class="devsite-nav-item devsite-nav-external"><a href="https://support.google.com/chrome/a/answer/9949706?ref_topic=9301744" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: https://support.google.com/chrome/a/answer/9949706?ref_topic=9301744" track-type="bookNav" track-name="click" track-metadata-eventdetail="https://support.google.com/chrome/a/answer/9949706?ref_topic=9301744" target="_blank">Chrome Browser Enrollment Token API</a></li> <li class="devsite-nav-item devsite-nav-heading"><div class="devsite-nav-title devsite-nav-title-no-path"> Best practices </div></li> <li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/push" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/push" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/push" >Push notifications</a></li> <li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/batch" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/batch" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/batch" >Send batch requests</a></li> <li class="devsite-nav-item"><a href="/admin-sdk/directory/v1/guides/performance" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /admin-sdk/directory/v1/guides/performance" track-type="bookNav" track-name="click" track-metadata-eventdetail="/admin-sdk/directory/v1/guides/performance" >Performance tips</a></li> </ul> <ul class="devsite-nav-list" menu="All products" aria-label="Side menu" hidden> <li class="devsite-nav-item devsite-nav-heading"> Google Workspace apps </li> <li class="devsite-nav-item"> <a href="/admin-sdk" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Admin console" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Admin console </a> </li> <li class="devsite-nav-item"> <a href="/cloud-search" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Cloud Search" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Cloud Search </a> </li> <li class="devsite-nav-item"> <a href="/gmail" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Gmail" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Gmail </a> </li> <li class="devsite-nav-item"> <a href="/calendar" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Calendar" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Google Calendar </a> </li> <li class="devsite-nav-item"> <a href="/workspace/chat" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Chat" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Google Chat </a> </li> <li class="devsite-nav-item"> <a href="/classroom" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Classroom" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Google Classroom </a> </li> <li class="devsite-nav-item"> <a href="/docs" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Docs" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Google Docs </a> </li> <li class="devsite-nav-item"> <a href="/drive" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Drive" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Google Drive </a> </li> <li class="devsite-nav-item devsite-nav-heading"> </li> <li class="devsite-nav-item"> <a href="/workspace/forms" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Forms" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Google Forms </a> </li> <li class="devsite-nav-item"> <a href="/keep" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Keep" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Google Keep </a> </li> <li class="devsite-nav-item"> <a href="/meet" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Meet" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Google Meet </a> </li> <li class="devsite-nav-item"> <a href="/sheets" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Sheets" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Google Sheets </a> </li> <li class="devsite-nav-item"> <a href="/workspace/sites" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Sites" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Google Sites </a> </li> <li class="devsite-nav-item"> <a href="/slides" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Slides" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Google Slides </a> </li> <li class="devsite-nav-item"> <a href="/tasks" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Tasks" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Google Tasks </a> </li> <li class="devsite-nav-item"> <a href="/vault" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Vault" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Google Vault </a> </li> <li class="devsite-nav-item devsite-nav-heading"> Extend, automate & share </li> <li class="devsite-nav-item"> <a href="/workspace/add-ons" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Add-ons" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Add-ons </a> </li> <li class="devsite-nav-item"> <a href="/apps-script" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Apps Script" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Apps Script </a> </li> <li class="devsite-nav-item"> <a href="/workspace/chat/overview" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Chat apps" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Chat apps </a> </li> <li class="devsite-nav-item"> <a href="/drive/api/guides/about-apps" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Drive apps" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Drive apps </a> </li> <li class="devsite-nav-item"> <a href="/workspace/marketplace" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Marketplace" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Marketplace </a> </li> </ul> <ul class="devsite-nav-list" menu="Resources" aria-label="Side menu" hidden> <li class="devsite-nav-item devsite-nav-heading"> Tools </li> <li class="devsite-nav-item"> <a href="https://admin.google.com/" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Admin console" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Admin console </a> </li> <li class="devsite-nav-item"> <a href="https://script.google.com/" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Apps Script dashboard" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Apps Script dashboard </a> </li> <li class="devsite-nav-item"> <a href="https://console.cloud.google.com/workspace-api" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Cloud console" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Google Cloud console </a> </li> <li class="devsite-nav-item"> <a href="/workspace/explore" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: APIs Explorer" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> APIs Explorer </a> </li> <li class="devsite-nav-item"> <a href="https://addons.gsuite.google.com/uikit/builder" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Card Builder" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Card Builder </a> </li> <li class="devsite-nav-item devsite-nav-heading"> Training & support </li> <li class="devsite-nav-item"> <a href="/workspace/guides/get-started" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: How to get started" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> How to get started </a> </li> <li class="devsite-nav-item"> <a href="https://codelabs.developers.google.com/?product=googleworkspace" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Codelabs" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Codelabs </a> </li> <li class="devsite-nav-item"> <a href="/workspace/support" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Developer support" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Developer support </a> </li> <li class="devsite-nav-item devsite-nav-heading"> Updates </li> <li class="devsite-nav-item"> <a href="https://developers.googleblog.com/search/?query=Google+Workspace" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Blog" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Blog </a> </li> <li class="devsite-nav-item"> <a href="/workspace/preview" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Developer Previews" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Developer Previews </a> </li> <li class="devsite-nav-item"> <a href="/workspace/newsletters" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Newsletter" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Newsletter </a> </li> <li class="devsite-nav-item"> <a href="https://twitter.com/workspacedevs" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: X (Twitter)" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> X (Twitter) </a> </li> <li class="devsite-nav-item"> <a href="https://www.youtube.com/channel/UCUcg6az6etU_gRtZVAhBXaw" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: YouTube" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> YouTube </a> </li> </ul> </div> </div> </nav> </devsite-book-nav> <section id="gc-wrapper"> <main role="main" id="main-content" class="devsite-main-content" has-book-nav > <devsite-content> <article class="devsite-article"> <div class="devsite-article-meta nocontent" role="navigation"> <ul class="devsite-breadcrumb-list" aria-label="Breadcrumb"> <li class="devsite-breadcrumb-item "> <a href="https://developers.google.com/" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Breadcrumbs" data-value="1" track-type="globalNav" track-name="breadcrumb" track-metadata-position="1" track-metadata-eventdetail="" > Home </a> </li> <li class="devsite-breadcrumb-item "> <div class="devsite-breadcrumb-guillemet material-icons" aria-hidden="true"></div> <a href="https://developers.google.com/workspace" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Breadcrumbs" data-value="2" track-type="globalNav" track-name="breadcrumb" track-metadata-position="2" track-metadata-eventdetail="Google Workspace" > Google Workspace </a> </li> <li class="devsite-breadcrumb-item "> <div class="devsite-breadcrumb-guillemet material-icons" aria-hidden="true"></div> <a href="https://developers.google.com/admin-sdk" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Breadcrumbs" data-value="3" track-type="globalNav" track-name="breadcrumb" track-metadata-position="3" track-metadata-eventdetail="Admin console" > Admin console </a> </li> <li class="devsite-breadcrumb-item "> <div class="devsite-breadcrumb-guillemet material-icons" aria-hidden="true"></div> <a href="https://developers.google.com/admin-sdk/overview" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Breadcrumbs" data-value="4" track-type="globalNav" track-name="breadcrumb" track-metadata-position="4" track-metadata-eventdetail="" > Guides </a> </li> </ul> <devsite-thumb-rating position="header"> </devsite-thumb-rating> </div> <devsite-feedback position="header" project-name="Admin console" product-id="717201" bucket="admin-console" context="" version="t-devsite-webserver-20250218-r02-rc00.467092460105212566" data-label="Send Feedback Button" track-type="feedback" track-name="sendFeedbackLink" track-metadata-position="header" class="nocontent" project-icon="https://fonts.gstatic.com/s/i/productlogos/admin_2020q4/v4/web-64dp/logo_admin_2020q4_color_1x_web_64dp.png" > <button> Send feedback </button> </devsite-feedback> <h1 class="devsite-page-title" tabindex="-1"> Manage user accounts </h1> <devsite-feature-tooltip ack-key="AckCollectionsBookmarkTooltipDismiss" analytics-category="Site-Wide Custom Events" analytics-action-show="Callout Profile displayed" analytics-action-close="Callout Profile dismissed" analytics-label="Create Collection Callout" class="devsite-page-bookmark-tooltip nocontent" dismiss-button="true" id="devsite-collections-dropdown" dismiss-button-text="Dismiss" close-button-text="Got it"> <devsite-bookmark></devsite-bookmark> Stay organized with collections Save and categorize content based on your preferences. </devsite-feature-tooltip> <devsite-key-takeaways></devsite-key-takeaways> <div class="devsite-page-title-meta"><devsite-view-release-notes></devsite-view-release-notes></div> <devsite-toc class="devsite-nav" depth="2" devsite-toc-embedded > </devsite-toc> <div class="devsite-article-body clearfix "> The Directory API provides programmatic methods for creating, updating, and deleting users. You can also get information about individual users or lists of users who meet specified criteria. Following are examples of some basic user operations. <h2 id="create_user" data-text="Create a user account" tabindex="-1">Create a user account</h2> You can add a user account to any of your Google Workspace account's domains. Before adding a user account, confirm the <a href="https://support.google.com/a/topic/9196">domain ownership</a>. If you upgraded your personal Gmail account to a business email account with your own domain name, you can't create new user accounts until you unlock additional Google Workspace settings. For details, see <a href="https://support.google.com/a/answer/10018989">G Suite business email accounts updated to G Suite Basic</a>. To create a user account using one of your domains, use the following <code translate="no" dir="ltr">POST</code> request and include the authorization described in <a href="/workspace/guides/auth-overview">Learn about authentication and authorization</a>. You can view the available scopes for the Directory API in the <a href="/identity/protocols/oauth2/scopes#admin-directory" target="_blank">OAuth 2.0 scopes list</a>. For the request query string properties, see the <a href="/admin-sdk/directory/reference/rest/v1/users/insert"><code translate="no" dir="ltr">users.insert()</code></a> method. <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>POST https://admin.googleapis.com/admin/directory/v1/users</pre></devsite-code> All create requests require you to submit the information needed to fulfill the request. If you are using client libraries, they convert the data objects from your chosen language into JSON data formatted objects. <h3 id="json-request" data-text="JSON request" tabindex="-1">JSON request</h3> The following JSON shows a sample request to create a user. For the full list of request and response properties, see the <a href="/admin-sdk/directory/v1/reference/users">API Reference</a>. <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="Carbon">{ "primaryEmail": "liz@example.com", "name": { "givenName": "Elizabeth", "familyName": "Smith" }, "suspended": false, "password": "new user password", "hashFunction": "SHA-1", "changePasswordAtNextLogin": false, "ipWhitelisted": false, "ims": [ { "type": "work", "protocol": "gtalk", "im": "liz_im@talk.example.com", "primary": true } ], "emails": [ { "address": "liz@example.com", "type": "home", "customType": "", "primary": true } ], "addresses": [ { "type": "work", "customType": "", "streetAddress": "1600 Amphitheatre Parkway", "locality": "Mountain View", "region": "CA", "postalCode": "94043" } ], "externalIds": [ { "value": "12345", "type": "custom", "customType": "employee" } ], "organizations": [ { "name": "Google Inc.", "title": "SWE", "primary": true, "type": "work", "description": "Software engineer" } ], "phones": [ { "value": "+1 nnn nnn nnnn", "type": "work" } ], "orgUnitPath": "/corp/engineering", "includeInGlobalAddressList": true }</pre></devsite-code> If your query rate for creation requests is too high, you might receive HTTP <code translate="no" dir="ltr">503</code> responses from the API server indicating that your quota has been exceeded. If you get these responses, use an <a href="/admin-sdk/directory/v1/limits">exponential back-off algorithm</a> to retry your requests. Things to note about a new account are: <ul> <li>If the Google account has purchased mail licenses, the new user account is automatically assigned a mailbox. This assignment may take a few minutes to be completed and activated. </li> <li>Editing a read-only field in a request, such as <code translate="no" dir="ltr">isAdmin</code>, is silently ignored by the API service. </li> <li>The maximum number of domains allowed in an account is 600 (1 primary domain + 599 additional domains) </li> <li>If a user was not assigned to a specific organizational unit when the user account was created, the account is in the top-level organizational unit. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the <a href="http://support.google.com/a/bin/answer.py?answer=182433&topic=1227584&ctx=topic">administration help center</a>. For more infomation about moving a user to a different organization, see <a href="#update_user">Update a user</a>. </li> <li>A <code translate="no" dir="ltr">password</code> is required for new user accounts. If a <code translate="no" dir="ltr">hashFunction</code> is specified, the password must be a valid hash key. If it's not specified, the password should be in clear text and between 8–100 ASCII characters. For more information, see the <a href="/admin-sdk/directory/v1/reference/users">API Reference</a>. </li> <li>For users on a flexible plan for Google Workspace, creating users using this API will have monetary impact, and will result in charges to your customer billing account. For more information, see the <a href="/admin-sdk/directory/v1/limits#billing">API billing information</a>. </li> <li>A Google Workspace account can include any of your domains. In a multiple domain account, users in one domain can share services with users in other account domains. For more information about users in multiple domains, see the <a href="/admin-sdk/directory/v1/limits#multi_domains">API multiple domain information</a>. </li> <li>There might be conflicting accounts. Check to see if anyone you plan to add already has a Google Account. Then follow steps to avoid conflicts with those accounts. See <a href="https://support.google.com/a/answer/7062710">Find and resolve conflicting accounts</a>. </li> <li>There might be visitor accounts. If users invite people outside your organization who don't have Google Accounts to collaborate on Drive, they'll receive visitor accounts, in the format visitor's_username@your_domain.com. If you add a user with the same username as a visitor account, the account will be converted to a full Google Workspace account. The account will keep its current Drive file permissions. See <a href="https://support.google.com/drive/answer/9195194">Share documents with visitors</a>. </li> </ul> A successful response returns an <a href="http://wikipedia.org/wiki/List_of_HTTP_status_codes">HTTP 200 status code</a>. Along with the status code, the response returns the properties for the new user account. <h2 id="update_user" data-text="Update a user account" tabindex="-1">Update a user account</h2> To update a user account, use the following <code translate="no" dir="ltr">PUT</code> request and include the authorization described in <a href="/admin-sdk/directory/v1/guides/authorizing">Authorize requests</a>. The <code translate="no" dir="ltr">userKey</code> can be the user's primary email address, the unique user <code translate="no" dir="ltr">id</code>, or one of the user's alias email addresses. <code translate="no" dir="ltr">PUT https://admin.googleapis.com/admin/directory/v1/users/<var translate="no">userKey</var></code> Both the request and response body contain an instance of <a href="/admin-sdk/directory/reference/rest/v1/users#User"><code translate="no" dir="ltr">User</code></a>. However, the Directory API supports <a href="/admin-sdk/directory/v1/guides/performance#patch">patch semantics</a>, so you only need to submit the updated fields in your request. <aside class="note">Note: For repeating fields that contain arrays, like <code translate="no" dir="ltr">emails</code>, individual items in the array can't be patched piecemeal; the field must be supplied in the request body with the desired values for all items, otherwise <code translate="no" dir="ltr">null</code> items are cleared and other items might be unintentionally added or updated.</aside> <h3 id="sample_request" data-text="Sample request" tabindex="-1">Sample request</h3> In the example below, the user's <code translate="no" dir="ltr">givenName</code> was "Elizabeth" when the user account was created, and only a work email address was provided. <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="JSON"><code translate="no" dir="ltr">{ "name": { "givenName": "Elizabeth", "familyName": "Smith" }, "emails": [ { "address": "liz@example.com", "type": "work", "primary": true } ] } </code></pre></devsite-code> The request below updates <code translate="no" dir="ltr">givenName</code> from "Elizabeth" to "Liz", and also adds a home email address. Note that both email addresses are provided fully because the field is an array. <code translate="no" dir="ltr">PUT https://admin.googleapis.com/admin/directory/v1/users/liz@example.com</code> <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="JSON"><code translate="no" dir="ltr">{ "name": { "givenName": "Liz", }, "emails": [ { "address": "liz@example.com", "type": "work", "primary": true }, { "address": "liz@home.com", "type": "home" } ] } </code></pre></devsite-code> A successful response returns an <a href="http://wikipedia.org/wiki/List_of_HTTP_status_codes"><code translate="no" dir="ltr">HTTP 200</code> status code</a> and a <a href="/admin-sdk/directory/reference/rest/v1/users#resource:-user"><code translate="no" dir="ltr">User</code></a> resource with the updated fields. Be aware of the following when updating a user's account name: <ul> <li>Renaming a user account changes the user's primary email address and the domain used when retrieving this user's information. Before renaming a user, we recommend that you sign out the user from all browser sessions and services.</li> <li>The process of renaming a user account can take up to 10 minutes to propagate across all services.</li> <li>When you rename a user, the old user name is retained as an alias to ensure continuous mail delivery in the case of email forwarding settings, and is not available as a new user name.</li> <li>In general, we also recommend not using the user email address as a key for persistent data because the email address is subject to change.</li> <li>For a full list of the effects of renaming a user across Google Workspace apps, see the <a href="https://support.google.com/a/answer/2622985">Admin help center</a>.</li> </ul> <h2 id="make_admin" data-text="Make a user an administrator" tabindex="-1">Make a user an administrator</h2> To make user into a super administrator, use the following <code translate="no" dir="ltr">POST</code> request and include the authorization described in <a href="/admin-sdk/directory/v1/guides/authorizing">Authorize requests</a>. The <code translate="no" dir="ltr">userKey</code> can be the user's primary email address, the unique user <code translate="no" dir="ltr">id</code>, or one of the user's alias email addresses. For the request and response properties, see <a href="/admin-sdk/directory/v1/reference/users/makeAdmin">API Reference</a>. For more information about a super administrator, see the <a href="http://support.google.com/a/bin/answer.py?answer=33325">administration help center</a>. <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>POST https://admin.googleapis.com/admin/directory/v1/users/userKey/makeAdmin</pre></devsite-code> <aside class="note">Notes: The user must first exist before being made a super administrator. This operation can only be performed by an account's super administrator; delegated administrators cannot promote users to administrative roles. For information about using the Admin console to change an administrator's role, see the <a href="http://support.google.com/a/bin/answer.py?answer=33325">administration help center</a>.</aside> <h3 id="json-request_1" data-text="JSON request" tabindex="-1">JSON request</h3> In this example, user whose <code translate="no" dir="ltr">userKey</code> is liz@example.com has become a super administrator: <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/makeAdmin </pre></devsite-code> <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="Text only">{ "status": true }</pre></devsite-code> A successful response returns an <a href="http://wikipedia.org/wiki/List_of_HTTP_status_codes">HTTP 200 status code</a>. <h2 id="user-relationships" data-text="Manage user relationships" tabindex="-1">Manage user relationships</h2> The Directory API uses the <code translate="no" dir="ltr">relations</code> field to define different types of relationships between users. In a business setting, people commonly use this field for manager-employee and assistant relationships, but the field supports many other types as well. The relationship displays in the "Related people" card of the user in any Google Workspace application that supports the card. For examples of where the card is visible, see <a href="https://support.google.com/a/answer/6191788">Add information to a user’s Directory profile</a>. <h3 id="create-relationship" data-text="Create a relationship between users" tabindex="-1">Create a relationship between users</h3> You can define a relationship in only one direction, starting from the "owning" user, whose record includes the <code translate="no" dir="ltr">relations</code> field. The <code translate="no" dir="ltr">type</code> describes the relationship of the other person to the owning user. For example, in a manager-employee relationship, the employee is the owning user and you add a <code translate="no" dir="ltr">relations</code> field to their account with the <code translate="no" dir="ltr">manager</code> type. For allowed types, see the <a href="/admin-sdk/directory/reference/rest/v1/users"><code translate="no" dir="ltr">User</code></a> object reference. Set up the relationship by <a href="#create_user">creating</a> or <a href="#update_user">updating</a> the owning user with a JSON request body that includes the <code translate="no" dir="ltr">relations</code> field. You can create multiple relationships in one request. <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="JSON"><code translate="no" dir="ltr">{ "relations": [ { "value": "<var translate="no">EMAIL_ADDRESS_RELATION_1</var>", "type": "manager" }, { "value": "<var translate="no">EMAIL_ADDRESS_RELATION_2</var>", "type": "dotted_line_manager" } ] } </code></pre></devsite-code> <h3 id="update-relationship" data-text="Update or delete a relationship" tabindex="-1">Update or delete a relationship</h3> You can only updated the <code translate="no" dir="ltr">relations</code> field can only be updated as a whole—you can't address the individual people listed to change the relationship type or to remove them. In the example above, to remove the existing manager relationship and make the dotted-line manager the owning user's manager, update the owning user's account with all of the field's values as you now want them. <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="JSON"><code translate="no" dir="ltr">{ "relations": [ { "value": "<var translate="no">EMAIL_ADDRESS_RELATION_2</var>", "type": "manager" } ] } </code></pre></devsite-code> To remove all of the owning user's relationships, set <code translate="no" dir="ltr">relations</code> to be empty: <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="JSON"><code translate="no" dir="ltr">{ "relations": [] } </code></pre></devsite-code> <h2 id="get_user" data-text="Retrieve a user" tabindex="-1">Retrieve a user</h2> To retrieve a user, use the following <code translate="no" dir="ltr">GET</code> request and include the authorization described in <a href="/admin-sdk/directory/v1/guides/authorizing">Authorize requests</a>. The <code translate="no" dir="ltr">userKey</code> can be the user's primary email address, the unique user <code translate="no" dir="ltr">id</code>, or one of the user's alias email addresses. For the request and response properties, see the <a href="/admin-sdk/directory/v1/reference/users/get">API Reference</a>. <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>GET https://admin.googleapis.com/admin/directory/v1/users/userKey</pre></devsite-code> This example returns the user account properties for the user whose primary or alias email address is liz@example.com: <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com </pre></devsite-code> <h3 id="json-response" data-text="JSON response" tabindex="-1">JSON response</h3> A successful response returns an <a href="http://wikipedia.org/wiki/List_of_HTTP_status_codes">HTTP 200 status code</a>. Along with the status code, the response returns the properties for the user account. <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="Carbon">{ "kind": "directory#user", "id": "the unique user id", "primaryEmail": "liz@example.com", "name": { "givenName": "Liz", "familyName": "Smith", "fullName": "Liz Smith" }, "isAdmin": true, "isDelegatedAdmin": false, "lastLoginTime": "2013-02-05T10:30:03.325Z", "creationTime": "2010-04-05T17:30:04.325Z", "agreedToTerms": true, "hashFunction": "SHA-1", "suspended": false, "changePasswordAtNextLogin": false, "ipWhitelisted": false, "ims": [ { "type": "work", "protocol": "gtalk", "im": "lizim@talk.example.com", "primary": true } ], "emails": [ { "address": "liz@example.com", "type": "home", "customType": "", "primary": true } ], "addresses": [ { "type": "work", "customType": "", "streetAddress": "1600 Amphitheatre Parkway", "locality": "Mountain View", "region": "CA", "postalCode": "94043" } ], "externalIds": [ { "value": "employee number", "type": "custom", "customType": "office" } ], "organizations": [ { "name": "Google Inc.", "title": "SWE", "primary": true, "customType": "", "description": "Software engineer" } ], "phones": [ { "value": "+1 nnn nnn nnnn", "type": "work" } ], "aliases": [ "lizsmith@example.com", "lsmith@example.com" ], "nonEditableAliases": [ "liz@test.com" ], "customerId": "C03az79cb", "orgUnitPath": "corp/engineering", "isMailboxSetup": true, "includeInGlobalAddressList": true }</pre></devsite-code> <h2 id="get_all_domain_users" data-text="Retrieve all users in a domain" tabindex="-1">Retrieve all users in a domain</h2> To retrieve all users in the same domain, use the following <code translate="no" dir="ltr">GET</code> request and include the authorization described in <a href="/admin-sdk/directory/v1/guides/authorizing">Authorize requests</a>. For readability, this example uses line returns: <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>GET https://admin.googleapis.com/admin/directory/v1/users ?domain=primary domain name&pageToken=token for next results page &maxResults=max number of results per page &orderBy=email, givenName, or familyName &sortOrder=ascending or descending &query=email, givenName, or familyName:the query's value*</pre></devsite-code> For the request and response properties, see the <a href="/admin-sdk/directory/v1/reference/users/list">API Reference</a>. <h3 id="json-response_1" data-text="JSON response" tabindex="-1">JSON response</h3> In this example, all users in the example.com domain are returned with a maximum of 2 user domains per response page. There is a <code translate="no" dir="ltr">nextPageToken</code> for the follow-on list of users in this response. By default, the system returns a list of 100 users in the alphabetical order of the user's email address: <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>GET https://admin.googleapis.com/admin/directory/v1/users?domain=example.com&maxResults=2 </pre></devsite-code> A successful response returns an <a href="http://wikipedia.org/wiki/List_of_HTTP_status_codes">HTTP 200 status code</a>. Along with the status code, the response returns 2 user accounts in the example.com domain (<code translate="no" dir="ltr">maxResults=2</code>): <aside class="note"> Note: When retrieving all users in a domain, the value of <code translate="no" dir="ltr">lastLoginTime</code> might be inaccurate. To get the most accurate value for <code translate="no" dir="ltr">lastLoginTime</code>, <a href="#get_user">retrieve a user</a> instead. </aside> <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="Carbon">{ "kind": "directory#users", "users": [ { "kind": "directory#user", "id": "the unique user id", "primaryEmail": "liz@example.com", "name": { "givenName": "Liz", "familyName": "Smith", "fullName": "Liz Smith" }, "isAdmin": true, "isDelegatedAdmin": false, "lastLoginTime": "2013-02-05T10:30:03.325Z", "creationTime": "2010-04-05T17:30:04.325Z", "agreedToTerms": true, "hashFunction": "SHA-1", "suspended": false, "changePasswordAtNextLogin": false, "ipWhitelisted": false, "ims": [ { "type": "work", "protocol": "gtalk", "im": "lizim@talk.example.com", "primary": true } ], "emails": [ { "address": "liz@example.com", "type": "work", "customType": "", "primary": true } ], "addresses": [ { "type": "work", "customType": "", "streetAddress": "1600 Amphitheatre Parkway", "locality": "Mountain View", "region": "CA", "postalCode": "94043" } ], "externalIds": [ { "value": "employee number", "type": "custom", "customType": "office" } ], "organizations": [ { "name": "Google Inc.", "title": "SWE", "primary": true, "customType": "", "description": "Software engineer" } ], "phones": [ { "value": "+1 nnn nnn nnnn", "type": "work" } ], "aliases": [ "lizsmith@example.com", "lsmith@example.com" ], "nonEditableAliases": [ "liz@test.com" ], "customerId": "C03az79cb", "orgUnitPath": "corp/engineering", "isMailboxSetup": true, "includeInGlobalAddressList": true }, { "kind": "directory#user", "id": "user unique ID", "primaryEmail": "admin2@example.com", "name": { "givenName": "admin", "familyName": "two", "fullName": "admin two" }, "isAdmin": true, "isDelegatedAdmin": true, "lastLoginTime": "2013-02-05T10:30:03.325Z", "creationTime": "2010-04-05T17:30:04.325Z", "agreedToTerms": true, "hashFunction": "SHA-1", "suspended": true, "suspensionReason": "ADMIN", "changePasswordAtNextLogin": false, "ipWhitelisted": false, "emails": [ { "address": "admin2@example.com", "type": "work", "customType": "", "primary": true } ], "externalIds": [ { "value": "contractor license number", "type": "custom", "customType": "work" } ], "aliases": [ "second_admin@example.com" ], "nonEditableAliases": [ "admin@test.com" ], "customerId": "C03az79cb", "orgUnitPath": "corp/engineering", "isMailboxSetup": true, "includeInGlobalAddressList": true } ], "nextPageToken": "next page token" }</pre></devsite-code> <h2 id="get_all_users" data-text="Retrieve all account users" tabindex="-1">Retrieve all account users</h2> To retrieve all users in an account which can consist of multiple domains, use the following <code translate="no" dir="ltr">GET</code> request and include the authorization described in <a href="/admin-sdk/directory/v1/guides/authorizing">Authorize requests</a>. For readability, this example uses line returns: <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>GET https://admin.googleapis.com/admin/directory/v1/users ?customer=my_customer or customerId&pageToken=token for next results page &maxResults=max number of results per page &orderBy=email, givenName, or familyName &sortOrder=ascending or descending &query=user attributes</pre></devsite-code> <ul> <li>The <code translate="no" dir="ltr">customer</code> query string is the <code translate="no" dir="ltr">my_customer</code> or the <code translate="no" dir="ltr">customerId</code> value. </li> <li>Use the string <code translate="no" dir="ltr">my_customer</code> to represent your account's <code translate="no" dir="ltr">customerId</code>. </li> <li>As a reseller administrator, use the resold customer's <code translate="no" dir="ltr">customerId</code>. For the <code translate="no" dir="ltr">customerId</code>, use the account's primary domain name in the <a href="#get_all_domain_users">Retrieve all users in a domain</a> operation's request. The resulting response has the <code translate="no" dir="ltr">customerId</code> value. </li> <li>The optional <code translate="no" dir="ltr">orderBy</code> query string determines whether the list is sorted by the user's primary email address, family name or given name. When using <code translate="no" dir="ltr">orderBy</code>, you can also use the <code translate="no" dir="ltr">sortOrder</code> query string to list the results in ascending or descending order. </li> <li>The optional <code translate="no" dir="ltr">query</code> query string allows searching over many fields in a user profile, including both core and custom fields. See <a href="/admin-sdk/directory/v1/guides/search-users">Search for Users</a> for examples.</li> </ul> For the request and response properties, see the <a href="/admin-sdk/directory/v1/reference/users/list">API Reference</a>. In this example, an account administrator is requesting all users in the account be returned with one user entry on each response page. The <code translate="no" dir="ltr">nextPageToken</code> goes to the follow-on page of results: <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>GET https://admin.googleapis.com/admin/directory/v1/users?customer=my_customer&maxResults=1 </pre></devsite-code> In this example, a reseller administrator is requesting all users in a resold account which has the <code translate="no" dir="ltr">customerId</code> value of <code translate="no" dir="ltr">C03az79cb</code>. <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>GET https://admin.googleapis.com/admin/directory/v1/users?customer=C03az79cb&maxResults=1 </pre></devsite-code> <h3 id="json-response_2" data-text="JSON response" tabindex="-1">JSON response</h3> A successful response returns an <a href="http://wikipedia.org/wiki/List_of_HTTP_status_codes">HTTP 200 status code</a>. Along with the status code, the response returns all the users in this account: <aside class="note"> Note: When retrieving all account users, the value of <code translate="no" dir="ltr">lastLoginTime</code> might be inaccurate. To get the most accurate value for <code translate="no" dir="ltr">lastLoginTime</code>, <a href="#get_user">retrieve a user</a> instead. </aside> <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="Carbon">{ "kind": "directory#users", "users": [ { "kind": "directory#user", "id": "the unique user id", "username": "admin2@example.com", "name": { "givenName": "admin", "familyName": "two", "fullName": "admin two" }, "isAdmin": true, "isDelegatedAdmin": true, "lastLoginTime": "2013-02-05T10:30:03.325Z", "creationTime": "2010-04-05T17:30:04.325Z", "agreedToTerms": true, "hashFunction": "SHA-1", "suspended": false, "changePasswordAtNextLogin": false, "ipWhitelisted": false, "emails": [ { "address": "admin2@example.com", "type": "work", "customType": "", "primary": true } ], "externalIds": [ { "value": "employee number", "type": "custom", "customType": "office" } ], "aliases": [ "second_admin@example.com" ], "nonEditableAliases": [ "another_admin@test.com" ], "customerId": "C03az79cb", "orgUnitPath": "/", "isMailboxSetup": true, "includeInGlobalAddressList": true }, { "kind": "directory#user", "id": "the unique user id", "username": "liz@example.com", "name": { "givenName": "Elizabeth", "familyName": "Smith", "fullName": "Elizabeth Smith" }, "isAdmin": false, "isDelegatedAdmin": false, "lastLoginTime": "1336509883546", "creationTime": "1404802800000", "agreedToTerms": false, "hashFunction": "SHA-1", "suspended": false, "changePasswordAtNextLogin": false, "ipWhitelisted": false, "emails": [ { "address": "liz@example.com", "type": "home", "customType": "", "primary": true } ], "externalIds": [ { "value": "employee number", "type": "custom", "customType": "bank" } ], "relations": [ { "value": "liz", "type": "friend", "customType": "" } ], "aliases": [ "lizsmith@example.com", "lsmith@example.com" ], "nonEditableAliases": [ "liz@test.com" ], "customerId": "C03az79cb", "orgUnitPath": "/", "isMailboxSetup": true, "includeInGlobalAddressList": true }, { "kind": "directory#user", "id": "the unique user id", "username": "test3@example.com", "name": { "givenName": "Tester", "familyName": "Three", "fullName": "Tester Three" }, "isAdmin": false, "isDelegatedAdmin": false, "lastLoginTime": "1336509883546", "creationTime": "1404802800000", "agreedToTerms": true, "hashFunction": "SHA-1", "suspended": false, "changePasswordAtNextLogin": false, "ipWhitelisted": false, "emails": [ { "address": "test@example.com", "type": "work", "customType": "", "primary": true } ], "externalIds": [ { "value": "employee number", "type": "custom", "customType": "office" } ], "aliases": [ "tester3@example.com" ], "nonEditableAliases": [ "third@test.com" ], "customerId": "C03az79cb", "orgUnitPath": "/", "isMailboxSetup": true, "includeInGlobalAddressList": true }, { "kind": "directory#user", "id": "the unique user id", "username": "work_admin@example.com", "name": { "givenName": "Admin", "familyName": "Work", "fullName": "Admin Work" }, "isAdmin": true, "isDelegatedAdmin": true, "lastLoginTime": "1336509883546", "creationTime": "1404802800000", "agreedToTerms": true, "hashFunction": "SHA-1", "suspended": false, "changePasswordAtNextLogin": false, "ipWhitelisted": false, "emails": [ { "address": "work_admin@example.com", "type": "work", "customType": "", "primary": true } ], "externalIds": [ { "value": "employee number", "type": "custom", "customType": "office" } ], "aliases": [ "my_alias@example.com" ], "nonEditableAliases": [ "other_alias@test.com" ], "customerId": "C03az79cb", "orgUnitPath": "/", "isMailboxSetup": true, "includeInGlobalAddressList": true } ], "nextPageToken": "NNNNN" }</pre></devsite-code> <h2 id="get_deleted_users" data-text="Retrieve recently deleted users" tabindex="-1">Retrieve recently deleted users</h2> To retrieve all users deleted within the span of the last 20 days from an account or from one of the account's domains, use the following <code translate="no" dir="ltr">GET</code> requests and include the authorization described in <a href="/admin-sdk/directory/v1/guides/authorizing">Authorize requests</a>. To undelete a user, see <a href="#undelete_user">Undelete a user</a>. To retrieve users deleted within the span of the last 20 days from the account's primary domain or a subdomain, use the following <code translate="no" dir="ltr">GET</code> request. The <code translate="no" dir="ltr">domain</code> query string is the domain's primary domain name. For the user request and response properties, see the <a href="/admin-sdk/directory/v1/reference/users/list">API Reference</a>. And, for readability, this example uses line returns: <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>GET https://admin.googleapis.com/admin/directory/v1/users ?domain=primary domain name&pageToken=token for next results page &maxResults=max number of results per page &showDeleted=true</pre></devsite-code> <aside class="note">Note: With the <code translate="no" dir="ltr">showDeleted=false</code> setting, the request returns the same response as <a href="#get_all_domain_users">Retrieve all users in a domain</a>.</aside> If an account has multiple domains, you can retrieve users deleted within the span of the last 20 days from the whole account, use the following <code translate="no" dir="ltr">GET</code> request. For readability, this example uses line returns: <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>GET https://admin.googleapis.com/admin/directory/v1/users ?customer=my_customer or customerId&pageToken=token for next results page &maxResults=max number of results per page&showDeleted=true</pre></devsite-code> <ul> <li>The <code translate="no" dir="ltr">customer</code> query string is the <code translate="no" dir="ltr">my_customer</code> or the <code translate="no" dir="ltr">customerId</code> value. </li> <li>As an account administrator, use the string <code translate="no" dir="ltr">my_customer</code> to represent your account's <code translate="no" dir="ltr">customerId</code>. </li> <li>As a reseller administrator, use the resold customer's <code translate="no" dir="ltr">customerId</code>. For the <code translate="no" dir="ltr">customerId</code>, use the account's primary domain name in the <a href="#get_all_domain_users">Retrieve all users in a domain</a> operation's request. The resulting response has the <code translate="no" dir="ltr">customerId</code> value. </li> </ul> For the request and response properties, see the <a href="/admin-sdk/directory/v1/reference/users">API Reference</a>. <aside class="note">Note: With the <code translate="no" dir="ltr">showDeleted=false</code> setting, the request returns the same response as <a href="#get_all_users">Retrieve all account users</a>. For the user request and response properties, see the <a href="/admin-sdk/directory/v1/reference/users/list">API Reference</a>.</aside> In this example, an account administrator is requesting all deleted users in the account: <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>GET https://admin.googleapis.com/admin/directory/v1/users?customer=my_customer&showDeleted=true </pre></devsite-code> <h3 id="json-response_3" data-text="JSON response" tabindex="-1">JSON response</h3> A successful response returns an <a href="http://wikipedia.org/wiki/List_of_HTTP_status_codes">HTTP 200 status code</a>. Along with the status code, the response returns all the account users deleted within the last 20 days: <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="Transact-SQL">{ "kind": "directory#users", "users": [ { "kind": "directory#user", "id": "the unique user id", "primaryEmail": "user1@example.com" }, { "kind": "directory#user", "id": "the unique user id", "primaryEmail": "user3@example.com" } ], "nextPageToken": "token for next page of deleted users" }</pre></devsite-code> <h2 id="get_photo" data-text="Retrieve a user's photo" tabindex="-1">Retrieve a user's photo</h2> The API retrieves one photo thumbnail, the latest Google profile photo. To retrieve the user's lastest photo, use the following <code translate="no" dir="ltr">GET</code> request and include the authorization described in <a href="/admin-sdk/directory/v1/guides/authorizing">Authorize requests</a>. The <code translate="no" dir="ltr">userKey</code> can be the user's primary email address, the user <code translate="no" dir="ltr">id</code>, or any of the user's alias emails. For the request and response properties, see the <a href="/admin-sdk/directory/v1/reference/users/photos/get">API Reference</a>. <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>GET https://admin.googleapis.com/admin/directory/v1/users/userKey/photos/thumbnail</pre></devsite-code> In this example, the latest photo of liz@example.com is returned: <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/photos/thumbnail</pre></devsite-code> <h3 id="json-response_4" data-text="JSON Response" tabindex="-1">JSON Response</h3> A successful response returns an <a href="http://wikipedia.org/wiki/List_of_HTTP_status_codes">HTTP 200 status code</a>. <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="Carbon">{ "kind": "directory#user#photo", "id": "the unique user id", "primaryEmail": "liz@example.com", "mimeType": "the photo mime type", "height": "the photo height in pixels", "width": "the photo width in pixels", "photoData": "web safe base64 encoded photo data" }</pre></devsite-code> The API's web safe base64 encoding of your photos is similar to the <a href="http://tools.ietf.org/html/rfc4648#section-5">RFC 4648 'base64url'</a>. This means: <ul> <li>The slash (/) character is replaced with the underscore (_) character.</li> <li>The plus sign (+) character is replaced with the hyphen (-) character.</li> <li>The equals sign (=) character is replaced with the asterisk (*).</li> <li>For padding, the period (.) character is used instead of the RFC-4648 baseURL definition which uses the equals sign (=) for padding. This is done to simplify URL-parsing. </li> <li>Whatever the size of the photo being uploaded, the API downsizes it proportionally to 96x96 pixels.</li> </ul> If you need to create compatible links from JavaScript, the <a href="https://developers.google.com/closure/library/docs/gettingstarted">Google Closure Library</a> includes <a href="http://closure-library.googlecode.com/svn/docs/closure_goog_crypt_base64.js.html">Base64 encoding and decoding functions</a> which are released under the Apache license. <h2 id="retrieve_users_non_admin" data-text="Retrieve a user as a non-administrator" tabindex="-1">Retrieve a user as a non-administrator</h2> While user accounts can only be modified by administrators, any user on the domain can read user profiles. A non-admin user can make a <a href="/admin-sdk/directory/v1/reference/users/get"><code translate="no" dir="ltr">users.get</code></a> or <a href="/admin-sdk/directory/v1/reference/users/list"><code translate="no" dir="ltr">users.list</code></a> request with the <code translate="no" dir="ltr">viewType</code> parameter equal to <code translate="no" dir="ltr">domain_public</code> to retrieve a user's public profile. The scope <code translate="no" dir="ltr">https://www.googleapis.com/auth/admin.directory.user.readonly</code> is ideal for this use case. The <code translate="no" dir="ltr">domain_public</code> view permits a non-admin user to access a standard set of core fields. For a custom field, you can choose whether it should be public or private when defining the schema. <aside class="note">Note: <a href="https://support.google.com/a/answer/60218">Contact sharing</a> must be enabled for the domain and individual users with <a href="https://support.google.com/a/answer/1285988"> contact sharing disabled</a> will not be returned in the results.</aside> <h2 id="update_photo" data-text="Update a user's photo" tabindex="-1">Update a user's photo</h2> To update a user's photo, use the following <code translate="no" dir="ltr">PUT</code> request and include the authorization described in <a href="/admin-sdk/directory/v1/guides/authorizing">Authorize requests</a>. The <code translate="no" dir="ltr">userKey</code> can be the user's primary email address, the user <code translate="no" dir="ltr">id</code>, or any of the user aliases' emails. For the request and response properties, see the <a href="/admin-sdk/directory/v1/reference/users/photos/update">API Reference</a>. <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>PUT https://admin.googleapis.com/admin/directory/v1/users/userKey/photos/thumbnail</pre></devsite-code> In this example, liz@example.com photo is updated: <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>PUT https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/photos/thumbnail</pre></devsite-code> <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="Text only">{ "photoData": "web safe base64 encoded photo data" }</pre></devsite-code> When updating a photo, the <code translate="no" dir="ltr">height</code> and <code translate="no" dir="ltr">width</code> are ignored by the API. <aside class="note">Note:The API also supports the <a href="/admin-sdk/directory/v1/guides/performance#patch">patch semantics</a>.</aside> <h3 id="json-response_5" data-text="JSON Response" tabindex="-1">JSON Response</h3> A successful response returns an <a href="http://wikipedia.org/wiki/List_of_HTTP_status_codes">HTTP 200 status code</a>. <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="Carbon">{ "kind": "directory#user#photo", "id": "the unique user id", "primaryEmail": "liz@example.com", "mimeType": "the photo mime type", "height": "the photo height in pixels", "width": "the photo width in pixels", "photoData": "web safe base64 encoded photo data" }</pre></devsite-code> <h2 id="delete_photo" data-text="Delete a user's photo" tabindex="-1">Delete a user's photo</h2> To delete a user's photo, use the following <code translate="no" dir="ltr">DELETE</code> request and include the authorization described in <a href="/admin-sdk/directory/v1/guides/authorizing">Authorize requests</a>. The <code translate="no" dir="ltr">userKey</code> can be the user's primary email address, the user <code translate="no" dir="ltr">id</code>, or any of the user aliases' emails. For the request and response properties, see the <a href="/admin-sdk/directory/v1/reference/users/photos/delete">API Reference</a>. <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/photos/thumbnail</pre></devsite-code> Once deleted, the user's photo is not shown. Wherever a user's photo is required, a silhouette will be shown instead. <h2 id="delete_user" data-text="Delete a user account" tabindex="-1">Delete a user account</h2> To delete a user account, use the following <code translate="no" dir="ltr">DELETE</code> request and include the authorization described in <a href="/admin-sdk/directory/v1/guides/authorizing">Authorize requests</a>. The <code translate="no" dir="ltr">userKey</code> can be the user's primary email address, the unique user <code translate="no" dir="ltr">id</code>, or one of the user's alias email addresses. For the request and response properties, see the <a href="/admin-sdk/directory/v1/reference/users/delete">API Reference</a>. <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey</pre></devsite-code> In this example, the liz@example.com user account is deleted: <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com </pre></devsite-code> A successful response only returns an <a href="http://wikipedia.org/wiki/List_of_HTTP_status_codes">HTTP 200 status code</a>. Important things to consider before deleting a user: <ul> <li>The deleted user will no longer be able to log in.</li> <li>For more information about user account deletion, please refer to the <a href="http://support.google.com/a/bin/answer.py?answer=33314">administration help center</a>.</li> </ul> <aside class="note"> Note: If the user you're trying to delete is under legal hold using Google Vault, you can't delete them and the API returns an error: "Could not delete user due to legal hold. Please contact your Vault administrator." </aside> <h2 id="undelete_user" data-text="Undelete a user account" tabindex="-1">Undelete a user account</h2> A user deleted in the last 20 days must meet certain <a href="http://support.google.com/a/bin/answer.py?answer=1397578">conditions before the user's account can be restored</a>. To undelete a user account, use the following <code translate="no" dir="ltr">POST</code> request and include the authorization described in <a href="/admin-sdk/directory/v1/guides/authorizing">Authorize requests</a>. The <code translate="no" dir="ltr">userKey</code> is the unique user <code translate="no" dir="ltr">id</code> found in the response of the <a href="#get_deleted_users">Retrieve users deleted within the past 20 days</a> operation. The user's primary email address or one of the user's alias email addresses cannot be used in the <code translate="no" dir="ltr">userKey</code> for this operation. For the request and response properties, see the <a href="/admin-sdk/directory/v1/reference/users/undelete">API Reference</a>. <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>POST https://admin.googleapis.com/admin/directory/v1/users/userKey/undelete</pre></devsite-code> <aside class="note">Note: Only an account's super administrator can undelete a user account.</aside> In this example, the user, liz@example.com, is undeleted. All of this user's previous account properties are restored: <div></div><devsite-code><pre translate="no" dir="ltr" is-upgraded>POST https://admin.googleapis.com/admin/directory/v1/users/12309329403209438205/undelete </pre></devsite-code> A successful response only returns an <a href="http://wikipedia.org/wiki/List_of_HTTP_status_codes">HTTP 204 status code</a>. To see the undeleted user's account, use the <a href="#get_user">Retrieve a user</a> operation. <devsite-hats-survey class="nocontent" hats-id="tjcU6Eo960eGRuQsCn30RAQXzQQM" listnr-id="717201"></devsite-hats-survey> </div> <devsite-recommendations display="in-page" hidden yield> </devsite-recommendations> <devsite-thumb-rating position="footer"> </devsite-thumb-rating> <devsite-feedback position="footer" project-name="Admin console" product-id="717201" bucket="admin-console" context="" version="t-devsite-webserver-20250218-r02-rc00.467092460105212566" data-label="Send Feedback Button" track-type="feedback" track-name="sendFeedbackLink" track-metadata-position="footer" class="nocontent" project-icon="https://fonts.gstatic.com/s/i/productlogos/admin_2020q4/v4/web-64dp/logo_admin_2020q4_color_1x_web_64dp.png" > <button> Send feedback </button> </devsite-feedback> <devsite-recommendations id="recommendations-link" yield></devsite-recommendations> <div class="devsite-floating-action-buttons"> </div> </article> <devsite-content-footer class="nocontent"> Except as otherwise noted, the content of this page is licensed under the <a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 License</a>, and code samples are licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0 License</a>. For details, see the <a href="https://developers.google.com/site-policies">Google Developers Site Policies</a>. Java is a registered trademark of Oracle and/or its affiliates. Last updated 2025-01-15 UTC. </devsite-content-footer> <devsite-notification > </devsite-notification> <div class="devsite-content-data"> <template class="devsite-thumb-rating-feedback"> <devsite-feedback position="thumb-rating" project-name="Admin console" product-id="717201" bucket="admin-console" context="" version="t-devsite-webserver-20250218-r02-rc00.467092460105212566" data-label="Send Feedback Button" track-type="feedback" track-name="sendFeedbackLink" track-metadata-position="thumb-rating" class="nocontent" project-icon="https://fonts.gstatic.com/s/i/productlogos/admin_2020q4/v4/web-64dp/logo_admin_2020q4_color_1x_web_64dp.png" > <button> Need to tell us more? </button> </devsite-feedback> </template> <template class="devsite-content-data-template"> [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-15 UTC."],[[["The Google Admin SDK Directory API enables programmatic management of Google Workspace user accounts, including creating, updating, and deleting users."],["User data can be retrieved individually or in bulk for domains or entire accounts, with options to filter and sort results."],["User photos can be updated or deleted via the API, with support for retrieving thumbnails."],["Non-admin users can access public user profiles if contact sharing is enabled, using specific scopes and view types."],["User accounts can be deleted and potentially undeleted within a specific timeframe, subject to certain conditions and administrator privileges."]]],[]] </template> </div> </devsite-content> </main> <devsite-footer-promos class="devsite-footer"> <nav class="devsite-footer-promos nocontent" aria-label="Promotions"> <ul class="devsite-footer-promos-list"> <li class="devsite-footer-promo"> <a href="https://developers.googleblog.com/search/?query=Google+Workspace" class="devsite-footer-promo-title gc-analytics-event" data-category="Site-Wide Custom Events" target="_blank" data-category="Workspace Footer" data-label="Promo - Google Workspace Developers Blog" > <picture> <img class="devsite-footer-promo-icon" src="https://www.gstatic.com/images/branding/product/2x/google_cloud_64dp.png" loading="lazy" alt="Blog"> </picture> Blog </a> <div class="devsite-footer-promo-description">Read the Google Workspace Developers blog</div> </li> <li class="devsite-footer-promo"> <a href="https://twitter.com/workspacedevs" class="devsite-footer-promo-title gc-analytics-event" data-category="Site-Wide Custom Events" target="_blank" data-category="Workspace Footer" data-label="Promo - Google Workspace on X (Twitter)" > <picture> <img class="devsite-footer-promo-icon" src="/static/site-assets/logo-x.svg" loading="lazy" alt="X (Twitter)"> </picture> X (Twitter) </a> <div class="devsite-footer-promo-description">Follow @workspacedevs on X (Twitter)</div> </li> <li class="devsite-footer-promo"> <a href="https://github.com/googleworkspace" class="devsite-footer-promo-title gc-analytics-event" data-category="Site-Wide Custom Events" data-category="Workspace Footer" target="_blank" data-label="Promo - Google Workspace Github" > <picture> <img class="devsite-footer-promo-icon" src="/static/site-assets/logo-github.svg" loading="lazy" alt="Code Samples"> </picture> Code Samples </a> <div class="devsite-footer-promo-description">Explore our sample apps or copy them to build your own</div> </li> <li class="devsite-footer-promo"> <a href="https://codelabs.developers.google.com/?product=googleworkspace" class="devsite-footer-promo-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Promo - Google Workspace Codelabs" target="_blank" data-category="Workspace Footer" > <picture> <img class="devsite-footer-promo-icon" src="/static/site-assets/developers-logo-color.svg" loading="lazy" alt="Codelabs"> </picture> Codelabs </a> <div class="devsite-footer-promo-description">Try a guided, hands-on coding experience</div> </li> <li class="devsite-footer-promo"> <a href="https://www.youtube.com/channel/UCUcg6az6etU_gRtZVAhBXaw" class="devsite-footer-promo-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Promo - Google Workspace on YouTube" target="_blank" data-category="Workspace Footer" > <picture> <img class="devsite-footer-promo-icon" src="/static/site-assets/logo-youtube.svg" loading="lazy" alt="Videos"> </picture> Videos </a> <div class="devsite-footer-promo-description">Subscribe to our YouTube channel</div> </li> </ul> </nav> </devsite-footer-promos> <devsite-footer-linkboxes class="devsite-footer"> <nav class="devsite-footer-linkboxes nocontent" aria-label="Footer links"> <ul class="devsite-footer-linkboxes-list"> <li class="devsite-footer-linkbox "> <h3 class="devsite-footer-linkbox-heading no-link">Google Workspace for Developers</h3> <ul class="devsite-footer-linkbox-list"> <li class="devsite-footer-linkbox-item"> <a href="/workspace" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Linkbox - Platform overview"data-category="Workspace Footer"> Platform overview </a> </li> <li class="devsite-footer-linkbox-item"> <a href="/workspace/products" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-category="Workspace Footer"data-label="Linkbox - Developer products"> Developer products </a> </li> <li class="devsite-footer-linkbox-item"> <a href="/workspace/support" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Linkbox - Developer support"data-category="Workspace Footer"> Developer support </a> </li> <li class="devsite-footer-linkbox-item"> <a href="/workspace/terms" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-category="Workspace Footer"data-label="Linkbox - Terms of Service"> Terms of Service </a> </li> </ul> </li> <li class="devsite-footer-linkbox "> <h3 class="devsite-footer-linkbox-heading no-link">Tools</h3> <ul class="devsite-footer-linkbox-list"> <li class="devsite-footer-linkbox-item"> <a href="https://admin.google.com/" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Linkbox - Admin console"target="admin-console"data-category="Workspace Footer"> Admin console </a> </li> <li class="devsite-footer-linkbox-item"> <a href="https://script.google.com/" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" target="_blank"data-category="Workspace Footer"data-label="Linkbox - Apps Script Dashboard"> Apps Script Dashboard </a> </li> <li class="devsite-footer-linkbox-item"> <a href="https://console.cloud.google.com/workspace-api" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Linkbox - Google Cloud console"target="console"data-category="Workspace Footer"> Google Cloud console </a> </li> <li class="devsite-footer-linkbox-item"> <a href="/workspace/explore" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Linkbox - APIs Explorer"data-category="Workspace Footer"> APIs Explorer </a> </li> </ul> </li> <li class="devsite-footer-linkbox "> <h3 class="devsite-footer-linkbox-heading no-link">Connect</h3> <ul class="devsite-footer-linkbox-list"> <li class="devsite-footer-linkbox-item"> <a href="https://developers.googleblog.com/search/?query=Google+Workspace" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" target="_blank"data-category="Workspace Footer"data-label="Linkbox - Blog"> Blog </a> </li> <li class="devsite-footer-linkbox-item"> <a href="/workspace/newsletters" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Linkbox - Newsletter"data-category="Workspace Footer"> Newsletter </a> </li> <li class="devsite-footer-linkbox-item"> <a href="https://twitter.com/workspacedevs" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" target="_blank"data-category="Workspace Footer"data-label="Linkbox - X (Twitter)"> X (Twitter) </a> </li> <li class="devsite-footer-linkbox-item"> <a href="https://www.youtube.com/channel/UCUcg6az6etU_gRtZVAhBXaw" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Linkbox - YouTube"target="_blank"data-category="Workspace Footer"> YouTube </a> </li> </ul> </li> </ul> </nav> </devsite-footer-linkboxes> <devsite-footer-utility class="devsite-footer"> <div class="devsite-footer-utility nocontent"> <nav class="devsite-footer-sites" aria-label="Other Google Developers websites"> <a href="https://developers.google.com/" class="devsite-footer-sites-logo-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Google Developers Link"> <picture> <img class="devsite-footer-sites-logo" src="https://www.gstatic.com/devrel-devsite/prod/vd2dddc2199cd18ccf014281c77515e1e906f6b98324fd2a8b5fa9e92b09e8018/developers/images/lockup-google-for-developers.svg" loading="lazy" alt="Google Developers"> </picture> </a> <ul class="devsite-footer-sites-list"> <li class="devsite-footer-sites-item"> <a href="//developer.android.com" class="devsite-footer-sites-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Android Link" > Android </a> </li> <li class="devsite-footer-sites-item"> <a href="//developer.chrome.com/home" class="devsite-footer-sites-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Chrome Link" > Chrome </a> </li> <li class="devsite-footer-sites-item"> <a href="//firebase.google.com" class="devsite-footer-sites-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Firebase Link" > Firebase </a> </li> <li class="devsite-footer-sites-item"> <a href="//cloud.google.com" class="devsite-footer-sites-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Google Cloud Platform Link" > Google Cloud Platform </a> </li> <li class="devsite-footer-sites-item"> <a href="//ai.google.dev/" class="devsite-footer-sites-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Google AI Link" > Google AI </a> </li> <li class="devsite-footer-sites-item"> <a href="/products" class="devsite-footer-sites-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer All products Link" > All products </a> </li> </ul> </nav> <nav class="devsite-footer-utility-links" aria-label="Utility links"> <ul class="devsite-footer-utility-list"> <li class="devsite-footer-utility-item "> <a class="devsite-footer-utility-link gc-analytics-event" href="/terms/site-terms" data-category="Site-Wide Custom Events" data-label="Footer Terms link" > Terms </a> </li> <li class="devsite-footer-utility-item "> <a class="devsite-footer-utility-link gc-analytics-event" href="//policies.google.com/privacy" data-category="Site-Wide Custom Events" data-label="Footer Privacy link" > Privacy </a> </li> <li class="devsite-footer-utility-item glue-cookie-notification-bar-control"> <a class="devsite-footer-utility-link gc-analytics-event" href="#" data-category="Site-Wide Custom Events" data-label="Footer Manage cookies link" aria-hidden="true" > Manage cookies </a> </li> <li class="devsite-footer-utility-item devsite-footer-utility-button"> Sign up for the Google for Developers newsletter <a class="devsite-footer-utility-link gc-analytics-event" href="/newsletter/subscribe" data-category="Site-Wide Custom Events" data-label="Footer Subscribe link" > Subscribe </a> </li> </ul> <devsite-language-selector> <ul role="presentation"> <li role="presentation"> <a role="menuitem" lang="en" >English</a> </li> <li role="presentation"> <a role="menuitem" lang="de" >Deutsch</a> </li> <li role="presentation"> <a role="menuitem" lang="es" >Español</a> </li> <li role="presentation"> <a role="menuitem" lang="es_419" >Español – América Latina</a> </li> <li role="presentation"> <a role="menuitem" lang="fr" >Français</a> </li> <li role="presentation"> <a role="menuitem" lang="id" >Indonesia</a> </li> <li role="presentation"> <a role="menuitem" lang="it" >Italiano</a> </li> <li role="presentation"> <a role="menuitem" lang="pl" >Polski</a> </li> <li role="presentation"> <a role="menuitem" lang="pt_br" >Português – Brasil</a> </li> <li role="presentation"> <a role="menuitem" lang="vi" >Tiếng Việt</a> </li> <li role="presentation"> <a role="menuitem" lang="tr" >Türkçe</a> </li> <li role="presentation"> <a role="menuitem" lang="ru" >Русский</a> </li> <li role="presentation"> <a role="menuitem" lang="he" >עברית</a> </li> <li role="presentation"> <a role="menuitem" lang="ar" >العربيّة</a> </li> <li role="presentation"> <a role="menuitem" lang="fa" >فارسی</a> </li> <li role="presentation"> <a role="menuitem" lang="hi" >हिंदी</a> </li> <li role="presentation"> <a role="menuitem" lang="bn" >বাংলা</a> </li> <li role="presentation"> <a role="menuitem" lang="th" >ภาษาไทย</a> </li> <li role="presentation"> <a role="menuitem" lang="zh_cn" >中文 – 简体</a> </li> <li role="presentation"> <a role="menuitem" lang="zh_tw" >中文 – 繁體</a> </li> <li role="presentation"> <a role="menuitem" lang="ja" >日本語</a> </li> <li role="presentation"> <a role="menuitem" lang="ko" >한국어</a> </li> </ul> </devsite-language-selector> </nav> </div> </devsite-footer-utility> <devsite-panel></devsite-panel> <devsite-concierge data-info-panel data-ai-panel data-api-explorer-panel > </devsite-concierge> </section></section> <devsite-sitemask></devsite-sitemask> <devsite-snackbar></devsite-snackbar> <devsite-tooltip ></devsite-tooltip> <devsite-heading-link></devsite-heading-link> <devsite-analytics> <script type="application/json" analytics>[{"dimensions": {"dimension1": "Signed out", "dimension4": "Admin console", "dimension6": "en", "dimension5": "en", "dimension3": false, "dimension11": false}, "gaid": "UA-24532603-1", "metrics": {"ratings_count": "metric2", "ratings_value": "metric1"}, "purpose": 1}]</script> <script type="application/json" tag-management>{"at": "True", "ga4": [{"id": "G-272J68FCRF", "purpose": 1}, {"id": "G-YYP88VSJWR", "purpose": 0}], "ga4p": [{"id": "G-272J68FCRF", "purpose": 1}], "gtm": [], "parameters": {"internalUser": "False", "language": {"machineTranslated": "False", "requested": "en", "served": "en"}, "pageType": "article", "projectName": "Admin console", "signedIn": "False", "tenant": "developers", "recommendations": {"sourcePage": "", "sourceType": 0, "sourceRank": 0, "sourceIdenticalDescriptions": 0, "sourceTitleWords": 0, "sourceDescriptionWords": 0, "experiment": ""}, "experiment": {"ids": ""}}}</script> </devsite-analytics> <devsite-badger></devsite-badger> <script nonce="/jG2nUVMAyB5Ncwd6qSPQPwESnpWcH"> (function(d,e,v,s,i,t,E){d['GoogleDevelopersObject']=i; t=e.createElement(v);t.async=1;t.src=s;E=e.getElementsByTagName(v)[0]; E.parentNode.insertBefore(t,E);})(window, document, 'script', 'https://www.gstatic.com/devrel-devsite/prod/vd2dddc2199cd18ccf014281c77515e1e906f6b98324fd2a8b5fa9e92b09e8018/developers/js/app_loader.js', '[1,"en",null,"/js/devsite_app_module.js","https://www.gstatic.com/devrel-devsite/prod/vd2dddc2199cd18ccf014281c77515e1e906f6b98324fd2a8b5fa9e92b09e8018","https://www.gstatic.com/devrel-devsite/prod/vd2dddc2199cd18ccf014281c77515e1e906f6b98324fd2a8b5fa9e92b09e8018/developers","https://developers-dot-devsite-v2-prod.appspot.com",null,null,["/_pwa/developers/manifest.json","https://www.gstatic.com/devrel-devsite/prod/vd2dddc2199cd18ccf014281c77515e1e906f6b98324fd2a8b5fa9e92b09e8018/images/video-placeholder.svg","https://www.gstatic.com/devrel-devsite/prod/vd2dddc2199cd18ccf014281c77515e1e906f6b98324fd2a8b5fa9e92b09e8018/developers/images/favicon-new.png","https://fonts.googleapis.com/css?family=Google+Sans:400,500|Roboto:400,400italic,500,500italic,700,700italic|Roboto+Mono:400,500,700&display=swap"],1,null,[1,6,8,12,14,17,21,25,50,52,63,70,75,76,80,87,91,92,93,97,98,100,101,102,103,104,105,107,108,109,110,112,113,117,118,120,122,124,125,126,127,129,130,131,132,133,134,135,136,138,140,141,147,148,149,151,152,156,157,158,159,161,163,164,168,169,170,179,180,182,183,186,191,193,196],"AIzaSyAP-jjEJBzmIyKR4F-3XITp8yM9T1gEEI8","AIzaSyB6xiKGDR5O3Ak2okS4rLkauxGUG7XP0hg","developers.google.com","AIzaSyAQk0fBONSGUqCNznf6Krs82Ap1-NV6J4o","AIzaSyCCxcqdrZ_7QMeLCRY20bh_SXdAYqy70KY",null,null,null,["Profiles__enable_completequiz_endpoint","CloudShell__cloud_shell_button","Profiles__enable_public_developer_profiles","Profiles__enable_complete_playlist_endpoint","MiscFeatureFlags__enable_firebase_utm","Search__enable_ai_search_summaries_restricted","Cloud__enable_cloudx_experiment_ids","Profiles__enable_page_saving","Cloud__enable_cloud_dlp_service","CloudShell__cloud_code_overflow_menu","Search__enable_suggestions_from_borg","Search__enable_ai_eligibility_checks","Experiments__reqs_query_experiments","Profiles__enable_release_notes_notifications","Cloud__enable_cloud_shell_fte_user_flow","Cloud__enable_llm_concierge_chat","Profiles__enable_recognition_badges","Search__enable_ai_search_summaries","Profiles__enable_awarding_url","MiscFeatureFlags__enable_variable_operator","MiscFeatureFlags__enable_view_transitions","Profiles__require_profile_eligibility_for_signin","Cloud__enable_cloudx_ping","Cloud__enable_legacy_calculator_redirect","TpcFeatures__enable_unmirrored_page_left_nav","Profiles__enable_completecodelab_endpoint","Cloud__enable_free_trial_server_call","Profiles__enable_profile_collections","Concierge__enable_pushui","Analytics__enable_clearcut_logging","MiscFeatureFlags__emergency_css","Concierge__enable_concierge_restricted","TpcFeatures__enable_mirror_tenant_redirects","MiscFeatureFlags__developers_footer_image","Profiles__enable_stripe_subscription_management","MiscFeatureFlags__enable_project_variables","Cloud__enable_cloud_facet_chat","Search__enable_dynamic_content_confidential_banner","Profiles__enable_dashboard_curated_recommendations","MiscFeatureFlags__developers_footer_dark_image","EngEduTelemetry__enable_engedu_telemetry","DevPro__enable_cloud_innovators_plus","Concierge__enable_key_takeaways","BookNav__enable_tenant_cache_key","Concierge__enable_concierge","Profiles__enable_join_program_group_endpoint","Significatio__enable_by_tenant","Cloud__enable_cloud_shell","Search__enable_page_map","MiscFeatureFlags__enable_explain_this_code","DevPro__enable_developer_subscriptions","Profiles__enable_developer_profiles_callout"],null,null,"AIzaSyBLEMok-5suZ67qRPzx0qUtbnLmyT_kCVE","https://developerscontentserving-pa.clients6.google.com","AIzaSyCM4QpTRSqP5qI4Dvjt4OAScIN8sOUlO-k","https://developerscontentsearch-pa.clients6.google.com",1,4,null,"https://developerprofiles-pa.clients6.google.com",[1,"developers","Google for Developers","developers.google.com",null,"developers-dot-devsite-v2-prod.appspot.com",null,null,[1,1,[1],null,null,null,null,null,null,null,null,[1],null,null,null,null,null,null,[1],[1,null,null,[1,20],"/recommendations/information"],null,null,null,[1,1,1],[1,1,null,1,1]],null,[null,null,null,null,null,null,"/images/lockup-new.svg","/images/touchicon-180-new.png",null,null,null,null,1,null,null,null,null,null,null,null,null,1,null,null,null,"/images/lockup-dark-theme-new.svg",[]],[],null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,[6,1,14,15,20,22,23,29,32,36],null,[[null,null,null,[3,7,10,2,39,17,4,32,24,11,12,13,34,15,25],null,null,[1,[["docType","Choose a content type",[["Tutorial",null,null,null,null,null,null,null,null,"Tutorial"],["Guide",null,null,null,null,null,null,null,null,"Guide"],["Sample",null,null,null,null,null,null,null,null,"Sample"]]],["product","Choose a product",[["Android",null,null,null,null,null,null,null,null,"Android"],["ARCore",null,null,null,null,null,null,null,null,"ARCore"],["ChromeOS",null,null,null,null,null,null,null,null,"ChromeOS"],["Firebase",null,null,null,null,null,null,null,null,"Firebase"],["Flutter",null,null,null,null,null,null,null,null,"Flutter"],["Assistant",null,null,null,null,null,null,null,null,"Google Assistant"],["GoogleCloud",null,null,null,null,null,null,null,null,"Google Cloud"],["GoogleMapsPlatform",null,null,null,null,null,null,null,null,"Google Maps Platform"],["GooglePay",null,null,null,null,null,null,null,null,"Google Pay & Google Wallet"],["GooglePlay",null,null,null,null,null,null,null,null,"Google Play"],["Tensorflow",null,null,null,null,null,null,null,null,"TensorFlow"]]],["category","Choose a topic",[["AiAndMachineLearning",null,null,null,null,null,null,null,null,"AI and Machine Learning"],["Data",null,null,null,null,null,null,null,null,"Data"],["Enterprise",null,null,null,null,null,null,null,null,"Enterprise"],["Gaming",null,null,null,null,null,null,null,null,"Gaming"],["Mobile",null,null,null,null,null,null,null,null,"Mobile"],["Web",null,null,null,null,null,null,null,null,"Web"]]]]]],[1,1],null,1],[[["UA-24532603-1"],["UA-22084204-5"],null,null,["UA-24532603-5"],null,null,[["G-272J68FCRF"],null,null,[["G-272J68FCRF",2]]],[["UA-24532603-1",2]],null,[["UA-24532603-5",2]],null,1],[[4,3],[5,4],[6,5],[15,12],[11,8],[13,10],[12,9],[14,11],[16,13],[3,2],[1,1]],[[2,2],[1,1]]],null,4,null,null,null,null,null,null,null,null,null,null,null,null,null,"developers.devsite.google"],null,"pk_live_5170syrHvgGVmSx9sBrnWtA5luvk9BwnVcvIi7HizpwauFG96WedXsuXh790rtij9AmGllqPtMLfhe2RSwD6Pn38V00uBCydV4m",1]') </script> <devsite-a11y-announce></devsite-a11y-announce> </body> </html>

CINXE.COM

Manage user accounts | Admin console | Google for Developers