mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
478 lines
29 KiB
HTML
478 lines
29 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-iam1-cli/projects_roles-create/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Roles Create - Iam v5.0.4+20240220</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 = "Roles Create";
|
|
var mkdocs_page_input_path = "projects_roles-create.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-iam1-cli/projects_roles-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"> Iam v5.0.4+20240220
|
|
</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">Iam Policies</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../iam-policies_lint-policy/">Lint Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../iam-policies_query-auditable-services/">Query Auditable Services</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Locations</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-create/">Workforce Pools Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-delete/">Workforce Pools Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-get/">Workforce Pools Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-get-iam-policy/">Workforce Pools Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-list/">Workforce Pools List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-operations-get/">Workforce Pools Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-patch/">Workforce Pools Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-create/">Workforce Pools Providers Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-delete/">Workforce Pools Providers Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-get/">Workforce Pools Providers Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-keys-create/">Workforce Pools Providers Keys Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-keys-delete/">Workforce Pools Providers Keys Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-keys-get/">Workforce Pools Providers Keys Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-keys-list/">Workforce Pools Providers Keys List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-keys-operations-get/">Workforce Pools Providers Keys Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-keys-undelete/">Workforce Pools Providers Keys Undelete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-list/">Workforce Pools Providers List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-operations-get/">Workforce Pools Providers Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-patch/">Workforce Pools Providers Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-undelete/">Workforce Pools Providers Undelete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-set-iam-policy/">Workforce Pools Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-subjects-delete/">Workforce Pools Subjects Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-subjects-operations-get/">Workforce Pools Subjects Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-subjects-undelete/">Workforce Pools Subjects Undelete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-test-iam-permissions/">Workforce Pools Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-undelete/">Workforce Pools Undelete</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Organizations</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_roles-create/">Roles Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_roles-delete/">Roles Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_roles-get/">Roles Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_roles-list/">Roles List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_roles-patch/">Roles Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_roles-undelete/">Roles Undelete</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Permissions</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../permissions_query-testable-permissions/">Query Testable Permissions</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Projects</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-create/">Locations Workload Identity Pools Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-delete/">Locations Workload Identity Pools Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-get/">Locations Workload Identity Pools Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-list/">Locations Workload Identity Pools List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-namespaces-managed-identities-operations-get/">Locations Workload Identity Pools Namespaces Managed Identities Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-namespaces-managed-identities-workload-sources-operations-get/">Locations Workload Identity Pools Namespaces Managed Identities Workload Sources Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-namespaces-operations-get/">Locations Workload Identity Pools Namespaces Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-operations-get/">Locations Workload Identity Pools Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-patch/">Locations Workload Identity Pools Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-create/">Locations Workload Identity Pools Providers Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-delete/">Locations Workload Identity Pools Providers Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-get/">Locations Workload Identity Pools Providers Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-keys-create/">Locations Workload Identity Pools Providers Keys Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-keys-delete/">Locations Workload Identity Pools Providers Keys Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-keys-get/">Locations Workload Identity Pools Providers Keys Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-keys-list/">Locations Workload Identity Pools Providers Keys List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-keys-operations-get/">Locations Workload Identity Pools Providers Keys Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-keys-undelete/">Locations Workload Identity Pools Providers Keys Undelete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-list/">Locations Workload Identity Pools Providers List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-operations-get/">Locations Workload Identity Pools Providers Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-patch/">Locations Workload Identity Pools Providers Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-undelete/">Locations Workload Identity Pools Providers Undelete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-undelete/">Locations Workload Identity Pools Undelete</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Roles Create</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_roles-delete/">Roles Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_roles-get/">Roles Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_roles-list/">Roles List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_roles-patch/">Roles Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_roles-undelete/">Roles Undelete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-create/">Service Accounts Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-delete/">Service Accounts Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-disable/">Service Accounts Disable</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-enable/">Service Accounts Enable</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-get/">Service Accounts Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-get-iam-policy/">Service Accounts Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-keys-create/">Service Accounts Keys Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-keys-delete/">Service Accounts Keys Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-keys-disable/">Service Accounts Keys Disable</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-keys-enable/">Service Accounts Keys Enable</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-keys-get/">Service Accounts Keys Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-keys-list/">Service Accounts Keys List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-keys-upload/">Service Accounts Keys Upload</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-list/">Service Accounts List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-patch/">Service Accounts Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-set-iam-policy/">Service Accounts Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-sign-blob/">Service Accounts Sign Blob</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-sign-jwt/">Service Accounts Sign Jwt</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-test-iam-permissions/">Service Accounts Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-undelete/">Service Accounts Undelete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-update/">Service Accounts Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Roles</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../roles_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../roles_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../roles_query-grantable-roles/">Query Grantable Roles</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="..">Iam v5.0.4+20240220</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>Projects »</li>
|
|
<li>Roles Create</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/iam1-cli/edit/master/docs/projects_roles-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 a new custom Role.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
|
|
You can set the scope for this method like this: <code>iam1 --scope <scope> projects roles-create ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>The <code>parent</code> parameter's value depends on the target resource for the request, namely <a href="https://cloud.google.com/iam/reference/rest/v1/projects.roles"><code>projects</code></a> or <a href="https://cloud.google.com/iam/reference/rest/v1/organizations.roles"><code>organizations</code></a>. Each resource type's <code>parent</code> value format is described below: * <a href="https://cloud.google.com/iam/reference/rest/v1/projects.roles/create"><code>projects.roles.create()</code></a>: <code>projects/{PROJECT_ID}</code>. This method creates project-level <a href="https://cloud.google.com/iam/docs/understanding-custom-roles">custom roles</a>. Example request URL: <code>https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles</code> * <a href="https://cloud.google.com/iam/reference/rest/v1/organizations.roles/create"><code>organizations.roles.create()</code></a>: <code>organizations/{ORGANIZATION_ID}</code>. This method creates organization-level <a href="https://cloud.google.com/iam/docs/understanding-custom-roles">custom roles</a>. Example request URL: <code>https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles</code> Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<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>CreateRoleRequest:
|
|
role:
|
|
deleted: boolean
|
|
description: string
|
|
etag: string
|
|
included-permissions: [string]
|
|
name: string
|
|
stage: string
|
|
title: string
|
|
role-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 .role deleted=false</code><ul>
|
|
<li>The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>description=lorem</code><ul>
|
|
<li>Optional. A human-readable description for the role.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>etag=ea</code><ul>
|
|
<li>Used to perform a consistent read-modify-write.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>included-permissions=stet</code><ul>
|
|
<li>The names of the permissions this role grants when bound in an IAM policy.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=dolores</code><ul>
|
|
<li>The name of the role. When <code>Role</code> is used in <code>CreateRole</code>, the role name must not be set. When <code>Role</code> is used in output and other input such as <code>UpdateRole</code>, the role name is the complete path. For example, <code>roles/logging.viewer</code> for predefined roles, <code>organizations/{ORGANIZATION_ID}/roles/my-role</code> for organization-level custom roles, and <code>projects/{PROJECT_ID}/roles/my-role</code> for project-level custom roles.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>stage=eos</code><ul>
|
|
<li>The current launch stage of the role. If the <code>ALPHA</code> launch stage has been selected for a role, the <code>stage</code> field will not be included in the returned definition for the role.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>title=et</code></p>
|
|
<ul>
|
|
<li>Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. role-id=sea</code></p>
|
|
<ul>
|
|
<li>The role ID to use for this role. A role ID may contain alphanumeric characters, underscores (<code>_</code>), and periods (<code>.</code>). It must contain a minimum of 3 characters and a maximum of 64 characters.</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="../projects_locations-workload-identity-pools-undelete/" class="btn btn-neutral float-left" title="Locations Workload Identity Pools Undelete"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_roles-delete/" class="btn btn-neutral float-right" title="Roles 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/iam1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_locations-workload-identity-pools-undelete/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_roles-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>
|