mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
385 lines
20 KiB
HTML
385 lines
20 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-classroom1-cli/invitations_create/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Create - classroom v5.0.4+20240227</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Create";
|
|
var mkdocs_page_input_path = "invitations_create.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-classroom1-cli/invitations_create/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> classroom v5.0.4+20240227
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Courses</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_aliases-create/">Aliases Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_aliases-delete/">Aliases Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_aliases-list/">Aliases List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_announcements-create/">Announcements Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_announcements-delete/">Announcements Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_announcements-get/">Announcements Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_announcements-list/">Announcements List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_announcements-modify-assignees/">Announcements Modify Assignees</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_announcements-patch/">Announcements Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-create/">Course Work Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-delete/">Course Work Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-get/">Course Work Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-list/">Course Work List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-modify-assignees/">Course Work Modify Assignees</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-patch/">Course Work Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-student-submissions-get/">Course Work Student Submissions Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-student-submissions-list/">Course Work Student Submissions List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-student-submissions-modify-attachments/">Course Work Student Submissions Modify Attachments</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-student-submissions-patch/">Course Work Student Submissions Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-student-submissions-reclaim/">Course Work Student Submissions Reclaim</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-student-submissions-return/">Course Work Student Submissions Return</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-student-submissions-turn-in/">Course Work Student Submissions Turn In</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-materials-create/">Course Work Materials Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-materials-delete/">Course Work Materials Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-materials-get/">Course Work Materials Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-materials-list/">Course Work Materials List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-materials-patch/">Course Work Materials Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_patch/">Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_students-create/">Students Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_students-delete/">Students Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_students-get/">Students Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_students-list/">Students List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_teachers-create/">Teachers Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_teachers-delete/">Teachers Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_teachers-get/">Teachers Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_teachers-list/">Teachers List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_topics-create/">Topics Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_topics-delete/">Topics Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_topics-get/">Topics Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_topics-list/">Topics List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_topics-patch/">Topics Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../courses_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Invitations</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../invitations_accept/">Accept</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Create</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../invitations_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../invitations_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../invitations_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Registrations</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../registrations_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../registrations_delete/">Delete</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">User Profiles</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../user-profiles_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../user-profiles_guardian-invitations-create/">Guardian Invitations Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../user-profiles_guardian-invitations-get/">Guardian Invitations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../user-profiles_guardian-invitations-list/">Guardian Invitations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../user-profiles_guardian-invitations-patch/">Guardian Invitations Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../user-profiles_guardians-delete/">Guardians Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../user-profiles_guardians-get/">Guardians Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../user-profiles_guardians-list/">Guardians List</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">classroom v5.0.4+20240227</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Invitations »</li>
|
|
<li>Create</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/classroom1-cli/edit/master/docs/invitations_create.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<p>Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * <code>PERMISSION_DENIED</code> if the requesting user is not permitted to create invitations for this course or for access errors. * <code>NOT_FOUND</code> if the course or the user does not exist. * <code>FAILED_PRECONDITION</code>: * if the requested user's account is disabled. * if the user already has this role or a role with greater permissions. * for the following request errors: * IneligibleOwner * <code>ALREADY_EXISTS</code> if an invitation for the specified user and course already exists.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/classroom.rosters</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/classroom.rosters</em>.
|
|
You can set the scope for this method like this: <code>classroom1 --scope <scope> invitations create ...</code></p>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
|
|
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>Invitation:
|
|
course-id: string
|
|
id: string
|
|
role: string
|
|
user-id: string
|
|
|
|
</code></pre>
|
|
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
|
<ul>
|
|
<li><code>-r . course-id=kasd</code><ul>
|
|
<li>Identifier of the course to invite the user to.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>id=sadipscing</code><ul>
|
|
<li>Identifier assigned by Classroom. Read-only.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>role=tempor</code><ul>
|
|
<li>Role to invite the user to have. Must not be <code>COURSE_ROLE_UNSPECIFIED</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>user-id=sea</code><ul>
|
|
<li>Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal <code>&#34;me&#34;</code>, indicating the requesting user</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p $-xgafv=string</strong></p>
|
|
<ul>
|
|
<li>V1 error format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p access-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth access token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p callback=string</strong></p>
|
|
<ul>
|
|
<li>JSONP</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../invitations_accept/" class="btn btn-neutral float-left" title="Accept"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../invitations_delete/" class="btn btn-neutral float-right" title="Delete">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/classroom1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../invitations_accept/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../invitations_delete/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|