mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 12:51:55 +01:00
53 lines
21 KiB
HTML
53 lines
21 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `api` mod in crate `google_iap1`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_iap1::api - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../google_iap1/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module api</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class="location"><a href="../index.html">google_iap1</a></p><div id="sidebar-vars" data-name="api" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">google_iap1</a>::<wbr><a class="mod" href="">api</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/google_iap1/api.rs.html#1-4688" title="goto source code">[src]</a></span></h1><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||
<table><tr class="module-item"><td><a class="struct" href="struct.AccessDeniedPageSettings.html" title="google_iap1::api::AccessDeniedPageSettings struct">AccessDeniedPageSettings</a></td><td class="docblock-short"><p>Custom content configuration for access denied page. IAP allows customers to define a custom URI to use as the error page when access is denied to users. If IAP prevents access to this page, the default IAP error page will be displayed instead.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessSettings.html" title="google_iap1::api::AccessSettings struct">AccessSettings</a></td><td class="docblock-short"><p>Access related settings for IAP protected apps.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ApplicationSettings.html" title="google_iap1::api::ApplicationSettings struct">ApplicationSettings</a></td><td class="docblock-short"><p>Wrapper over application specific settings for IAP.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Binding.html" title="google_iap1::api::Binding struct">Binding</a></td><td class="docblock-short"><p>Associates <code>members</code> with a <code>role</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Brand.html" title="google_iap1::api::Brand struct">Brand</a></td><td class="docblock-short"><p>OAuth brand data. NOTE: Only contains a portion of the data that describes a brand.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CloudIAP.html" title="google_iap1::api::CloudIAP struct">CloudIAP</a></td><td class="docblock-short"><p>Central instance to access all CloudIAP related resource activities</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CorsSettings.html" title="google_iap1::api::CorsSettings struct">CorsSettings</a></td><td class="docblock-short"><p>Allows customers to configure HTTP request paths that'll allow HTTP OPTIONS call to bypass authentication and authorization.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CsmSettings.html" title="google_iap1::api::CsmSettings struct">CsmSettings</a></td><td class="docblock-short"><p>Configuration for RCTokens generated for CSM workloads protected by IAP. RCTokens are IAP generated JWTs that can be verified at the application. The RCToken is primarily used for ISTIO deployments, and can be scoped to a single mesh by configuring the audience field accordingly</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Empty.html" title="google_iap1::api::Empty struct">Empty</a></td><td class="docblock-short"><p>A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for <code>Empty</code> is empty JSON object <code>{}</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Expr.html" title="google_iap1::api::Expr struct">Expr</a></td><td class="docblock-short"><p>Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GcipSettings.html" title="google_iap1::api::GcipSettings struct">GcipSettings</a></td><td class="docblock-short"><p>Allows customers to configure tenant_id for GCIP instance per-app.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GetIamPolicyRequest.html" title="google_iap1::api::GetIamPolicyRequest struct">GetIamPolicyRequest</a></td><td class="docblock-short"><p>Request message for <code>GetIamPolicy</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GetPolicyOptions.html" title="google_iap1::api::GetPolicyOptions struct">GetPolicyOptions</a></td><td class="docblock-short"><p>Encapsulates settings provided to GetIamPolicy.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.IapSettings.html" title="google_iap1::api::IapSettings struct">IapSettings</a></td><td class="docblock-short"><p>The IAP configurable settings.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.IdentityAwareProxyClient.html" title="google_iap1::api::IdentityAwareProxyClient struct">IdentityAwareProxyClient</a></td><td class="docblock-short"><p>Contains the data that describes an Identity Aware Proxy owned client.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListBrandsResponse.html" title="google_iap1::api::ListBrandsResponse struct">ListBrandsResponse</a></td><td class="docblock-short"><p>Response message for ListBrands.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListIdentityAwareProxyClientsResponse.html" title="google_iap1::api::ListIdentityAwareProxyClientsResponse struct">ListIdentityAwareProxyClientsResponse</a></td><td class="docblock-short"><p>Response message for ListIdentityAwareProxyClients.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MethodGetIamPolicyCall.html" title="google_iap1::api::MethodGetIamPolicyCall struct">MethodGetIamPolicyCall</a></td><td class="docblock-short"><p>Gets the access control policy for an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MethodGetIapSettingCall.html" title="google_iap1::api::MethodGetIapSettingCall struct">MethodGetIapSettingCall</a></td><td class="docblock-short"><p>Gets the IAP settings on a particular IAP protected resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MethodMethods.html" title="google_iap1::api::MethodMethods struct">MethodMethods</a></td><td class="docblock-short"><p>A builder providing access to all free methods, which are not associated with a particular resource.
|
||
It is not used directly, but through the <code>CloudIAP</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MethodSetIamPolicyCall.html" title="google_iap1::api::MethodSetIamPolicyCall struct">MethodSetIamPolicyCall</a></td><td class="docblock-short"><p>Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MethodTestIamPermissionCall.html" title="google_iap1::api::MethodTestIamPermissionCall struct">MethodTestIamPermissionCall</a></td><td class="docblock-short"><p>Returns permissions that a caller has on the Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MethodUpdateIapSettingCall.html" title="google_iap1::api::MethodUpdateIapSettingCall struct">MethodUpdateIapSettingCall</a></td><td class="docblock-short"><p>Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless the <code>update_mask</code> is set.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OAuthSettings.html" title="google_iap1::api::OAuthSettings struct">OAuthSettings</a></td><td class="docblock-short"><p>Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Policy.html" title="google_iap1::api::Policy struct">Policy</a></td><td class="docblock-short"><p>An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A <code>Policy</code> is a collection of <code>bindings</code>. A <code>binding</code> binds one or more <code>members</code> to a single <code>role</code>. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A <code>role</code> is a named list of permissions; each <code>role</code> can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a <code>binding</code> can also specify a <code>condition</code>, which is a logical expression that allows access to a resource only if the expression evaluates to <code>true</code>. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the <a href="https://cloud.google.com/iam/help/conditions/resource-policies">IAM documentation</a>. <strong>JSON example:</strong> { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } <strong>YAML example:</strong> bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the <a href="https://cloud.google.com/iam/docs/">IAM documentation</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PolicyDelegationSettings.html" title="google_iap1::api::PolicyDelegationSettings struct">PolicyDelegationSettings</a></td><td class="docblock-short"><p>PolicyDelegationConfig allows google-internal teams to use IAP for apps hosted in a tenant project. Using these settings, the app can delegate permission check to happen against the linked customer project. This is only ever supposed to be used by google internal teams, hence the restriction on the proto.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PolicyName.html" title="google_iap1::api::PolicyName struct">PolicyName</a></td><td class="docblock-short"><p>There is no detailed description.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectBrandCreateCall.html" title="google_iap1::api::ProjectBrandCreateCall struct">ProjectBrandCreateCall</a></td><td class="docblock-short"><p>Constructs a new OAuth brand for the project if one does not exist. The created brand is "internal only", meaning that OAuth clients created under it only accept requests from users who belong to the same G Suite organization as the project. The brand is created in an un-reviewed status. NOTE: The "internal only" status can be manually changed in the Google Cloud console. Requires that a brand does not already exist for the project, and that the specified support email is owned by the caller.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectBrandGetCall.html" title="google_iap1::api::ProjectBrandGetCall struct">ProjectBrandGetCall</a></td><td class="docblock-short"><p>Retrieves the OAuth brand of the project.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectBrandIdentityAwareProxyClientCreateCall.html" title="google_iap1::api::ProjectBrandIdentityAwareProxyClientCreateCall struct">ProjectBrandIdentityAwareProxyClientCreateCall</a></td><td class="docblock-short"><p>Creates an Identity Aware Proxy (IAP) OAuth client. The client is owned by IAP. Requires that the brand for the project exists and that it is set for internal-only use.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectBrandIdentityAwareProxyClientDeleteCall.html" title="google_iap1::api::ProjectBrandIdentityAwareProxyClientDeleteCall struct">ProjectBrandIdentityAwareProxyClientDeleteCall</a></td><td class="docblock-short"><p>Deletes an Identity Aware Proxy (IAP) OAuth client. Useful for removing obsolete clients, managing the number of clients in a given project, and cleaning up after tests. Requires that the client is owned by IAP.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectBrandIdentityAwareProxyClientGetCall.html" title="google_iap1::api::ProjectBrandIdentityAwareProxyClientGetCall struct">ProjectBrandIdentityAwareProxyClientGetCall</a></td><td class="docblock-short"><p>Retrieves an Identity Aware Proxy (IAP) OAuth client. Requires that the client is owned by IAP.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectBrandIdentityAwareProxyClientListCall.html" title="google_iap1::api::ProjectBrandIdentityAwareProxyClientListCall struct">ProjectBrandIdentityAwareProxyClientListCall</a></td><td class="docblock-short"><p>Lists the existing clients for the brand.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectBrandIdentityAwareProxyClientResetSecretCall.html" title="google_iap1::api::ProjectBrandIdentityAwareProxyClientResetSecretCall struct">ProjectBrandIdentityAwareProxyClientResetSecretCall</a></td><td class="docblock-short"><p>Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the secret was compromised. Requires that the client is owned by IAP.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectBrandListCall.html" title="google_iap1::api::ProjectBrandListCall struct">ProjectBrandListCall</a></td><td class="docblock-short"><p>Lists the existing brands for the project.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMethods.html" title="google_iap1::api::ProjectMethods struct">ProjectMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>project</em> resources.
|
||
It is not used directly, but through the <code>CloudIAP</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ResetIdentityAwareProxyClientSecretRequest.html" title="google_iap1::api::ResetIdentityAwareProxyClientSecretRequest struct">ResetIdentityAwareProxyClientSecretRequest</a></td><td class="docblock-short"><p>The request sent to ResetIdentityAwareProxyClientSecret.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Resource.html" title="google_iap1::api::Resource struct">Resource</a></td><td class="docblock-short"><p>There is no detailed description.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SetIamPolicyRequest.html" title="google_iap1::api::SetIamPolicyRequest struct">SetIamPolicyRequest</a></td><td class="docblock-short"><p>Request message for <code>SetIamPolicy</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TestIamPermissionsRequest.html" title="google_iap1::api::TestIamPermissionsRequest struct">TestIamPermissionsRequest</a></td><td class="docblock-short"><p>Request message for <code>TestIamPermissions</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TestIamPermissionsResponse.html" title="google_iap1::api::TestIamPermissionsResponse struct">TestIamPermissionsResponse</a></td><td class="docblock-short"><p>Response message for <code>TestIamPermissions</code> method.</p>
|
||
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
|
||
<table><tr class="module-item"><td><a class="enum" href="enum.Scope.html" title="google_iap1::api::Scope enum">Scope</a></td><td class="docblock-short"><p>Identifies the an OAuth2 authorization scope.
|
||
A scope is needed when requesting an
|
||
<a href="https://developers.google.com/youtube/v3/guides/authentication">authorization token</a>.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="google_iap1"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |