mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
522 lines
35 KiB
HTML
522 lines
35 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_locations-workload-identity-pools-providers-create/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Locations Workload Identity Pools Providers 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 = "Locations Workload Identity Pools Providers Create";
|
|
var mkdocs_page_input_path = "projects_locations-workload-identity-pools-providers-create.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-iam1-cli/projects_locations-workload-identity-pools-providers-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 current"><a class="reference internal current" href="./">Locations Workload Identity Pools Providers Create</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</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"><a class="reference internal" href="../projects_roles-create/">Roles Create</a>
|
|
</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>Locations Workload Identity Pools Providers 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_locations-workload-identity-pools-providers-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 WorkloadIdentityPoolProvider in a WorkloadIdentityPool. You cannot reuse the name of a deleted provider until 30 days after deletion.</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 locations-workload-identity-pools-providers-create ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>Required. The pool to create this provider in.</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>WorkloadIdentityPoolProvider:
|
|
attribute-condition: string
|
|
attribute-mapping: { string: string }
|
|
aws:
|
|
account-id: string
|
|
description: string
|
|
disabled: boolean
|
|
display-name: string
|
|
expire-time: string
|
|
name: string
|
|
oidc:
|
|
allowed-audiences: [string]
|
|
issuer-uri: string
|
|
jwks-json: string
|
|
saml:
|
|
idp-metadata-xml: string
|
|
state: 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 . attribute-condition=lorem</code><ul>
|
|
<li><a href="https://opensource.google/projects/cel">A Common Expression Language</a> expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. The expression must output a boolean representing whether to allow the federation. The following keywords may be referenced in the expressions: * <code>assertion</code>: JSON representing the authentication credential issued by the provider. * <code>google</code>: The Google attributes mapped from the assertion in the <code>attribute_mappings</code>. * <code>attribute</code>: The custom attributes mapped from the assertion in the <code>attribute_mappings</code>. The maximum length of the attribute condition expression is 4096 characters. If unspecified, all valid authentication credential are accepted. The following example shows how to only allow credentials with a mapped <code>google.groups</code> value of <code>admins</code>: <code>&#34;&#39;admins&#39; in google.groups&#34;</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>attribute-mapping=key=est</code><ul>
|
|
<li>Maps attributes from authentication credentials issued by an external identity provider to Google Cloud attributes, such as <code>subject</code> and <code>segment</code>. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * <code>google.subject</code>: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. Cannot exceed 127 bytes. * <code>google.groups</code>: Groups the external identity belongs to. You can grant groups access to resources using an IAM <code>principalSet</code> binding; access applies to all members of the group. You can also provide custom attributes by specifying <code>attribute.{custom_attribute}</code>, where <code>{custom_attribute}</code> is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workload to Google Cloud resources. For example: * <code>google.subject</code>: <code>principal://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/subject/{value}</code> * <code>google.groups</code>: <code>principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/group/{value}</code> * <code>attribute.{custom_attribute}</code>: <code>principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/attribute.{custom_attribute}/{value}</code> Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the <code>assertion</code> keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 8KB. For AWS providers, if no attribute mapping is defined, the following default mapping applies: <code>{ &#34;google.subject&#34;:&#34;assertion.arn&#34;, &#34;attribute.aws_role&#34;: &#34;assertion.arn.contains(&#39;assumed-role&#39;)&#34; &#34; ? assertion.arn.extract(&#39;{account_arn}assumed-role/&#39;)&#34; &#34; + &#39;assumed-role/&#39;&#34; &#34; + assertion.arn.extract(&#39;assumed-role/{role_name}/&#39;)&#34; &#34; : assertion.arn&#34;, }</code> If any custom attribute mappings are defined, they must include a mapping to the <code>google.subject</code> attribute. For OIDC providers, you must supply a custom mapping, which must include the <code>google.subject</code> attribute. For example, the following maps the <code>sub</code> claim of the incoming credential to the <code>subject</code> attribute on a Google token: <code>{&#34;google.subject&#34;: &#34;assertion.sub&#34;}</code></li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>aws account-id=sed</code></p>
|
|
<ul>
|
|
<li>Required. The AWS account ID.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. description=diam</code></p>
|
|
<ul>
|
|
<li>A description for the provider. Cannot exceed 256 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>disabled=true</code><ul>
|
|
<li>Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>display-name=et</code><ul>
|
|
<li>A display name for the provider. Cannot exceed 32 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>expire-time=sed</code><ul>
|
|
<li>Output only. Time after which the workload identity pool provider will be permanently purged and cannot be recovered.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=no</code><ul>
|
|
<li>Output only. The resource name of the provider.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>oidc allowed-audiences=et</code><ul>
|
|
<li>Acceptable values for the <code>aud</code> field (audience) in the OIDC token. Token exchange requests are rejected if the token audience does not match one of the configured values. Each audience may be at most 256 characters. A maximum of 10 audiences may be configured. If this list is empty, the OIDC token audience must be equal to the full canonical resource name of the WorkloadIdentityPoolProvider, with or without the HTTPS prefix. For example: <code>//iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations//workloadIdentityPools//providers/</code></li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>issuer-uri=elitr</code><ul>
|
|
<li>Required. The OIDC issuer URL. Must be an HTTPS endpoint.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>jwks-json=sed</code></p>
|
|
<ul>
|
|
<li>Optional. OIDC JWKs in JSON String format. For details on the definition of a JWK, see https://tools.ietf.org/html/rfc7517. If not set, the <code>jwks_uri</code> from the discovery document(fetched from the .well-known path of the <code>issuer_uri</code>) will be used. Currently, RSA and EC asymmetric keys are supported. The JWK must use following format and include only the following fields: { "keys": [ { "kty": "RSA/EC", "alg": "", "use": "sig", "kid": "", "n": "", "e": "", "x": "", "y": "", "crv": "" } ] }</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..saml idp-metadata-xml=no</code></p>
|
|
<ul>
|
|
<li>Required. SAML Identity provider configuration metadata xml doc. The xml document should comply with <a href="https://www.oasis-open.org/committees/download.php/56785/sstc-saml-metadata-errata-2.0-wd-05.pdf">SAML 2.0 specification</a>. The max size of the acceptable xml document will be bounded to 128k characters. The metadata xml document should satisfy the following constraints: 1) Must contain an Identity Provider Entity ID. 2) Must contain at least one non-expired signing key certificate. 3) For each signing key: a) Valid from should be no more than 7 days from now. b) Valid to should be no more than 15 years in the future. 4) Upto 3 IdP signing keys are allowed in the metadata xml. When updating the provider's metadata xml, at lease one non-expired signing key must overlap with the existing metadata. This requirement is skipped if there are no non-expired signing keys present in the existing metadata</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. state=nonumy</code></p>
|
|
<ul>
|
|
<li>Output only. The state of the provider.</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-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li><strong>-p workload-identity-pool-provider-id=string</strong><ul>
|
|
<li>Required. The ID for the provider, which becomes the final component of the resource name. This value must be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix <code>gcp-</code> is reserved for use by Google, and may not be specified.</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-patch/" class="btn btn-neutral float-left" title="Locations Workload Identity Pools Patch"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_locations-workload-identity-pools-providers-delete/" class="btn btn-neutral float-right" title="Locations Workload Identity Pools Providers 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-patch/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_locations-workload-identity-pools-providers-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>
|