@maxim_mazurok/gapi.client.iam-v1 0.0.20241017 → 0.0.20241104

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://iam.googleapis.com/$discovery/rest?version=v1
-// Revision: 20241017
+// Revision: 20241104
 
 /// <reference types="gapi.client" />
 
@@ -147,11 +147,11 @@ declare namespace gapi.client {
     interface GoogleIamAdminV1WorkforcePoolProviderOidc {
       /** Required. The client ID. Must match the audience claim of the JWT issued by the identity provider. */
       clientId?: string;
-      /** The optional client secret. Required to enable Authorization Code flow for web sign-in. */
+      /** Optional. The optional client secret. Required to enable Authorization Code flow for web sign-in. */
       clientSecret?: GoogleIamAdminV1WorkforcePoolProviderOidcClientSecret;
       /** Required. The OIDC issuer URI. Must be a valid URI using the `https` scheme. */
       issuerUri?: string;
-      /** 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 `jwks_uri` from the discovery document(fetched from the .well-known path of the `issuer_uri`) 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": "" } ] } */
+      /** 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 `jwks_uri` from the discovery document(fetched from the .well-known path of the `issuer_uri`) 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": "" } ] } */
       jwksJson?: string;
       /** Required. Configuration for web single sign-on for the OIDC provider. Here, web sign-in refers to console sign-in and gcloud sign-in through the browser. */
       webSsoConfig?: GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfig;
@@ -161,13 +161,13 @@ declare namespace gapi.client {
       value?: GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValue;
     }
     interface GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValue {
-      /** Input only. The plain text of the client secret value. For security reasons, this field is only used for input and will never be populated in any response. */
+      /** Optional. Input only. The plain text of the client secret value. For security reasons, this field is only used for input and will never be populated in any response. */
       plainText?: string;
       /** Output only. A thumbprint to represent the current client secret value. */
       thumbprint?: string;
     }
     interface GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfig {
-      /** Additional scopes to request for in the OIDC authentication request on top of scopes requested by default. By default, the `openid`, `profile` and `email` scopes that are supported by the identity provider are requested. Each additional scope may be at most 256 characters. A maximum of 10 additional scopes may be configured. */
+      /** Optional. Additional scopes to request for in the OIDC authentication request on top of scopes requested by default. By default, the `openid`, `profile` and `email` scopes that are supported by the identity provider are requested. Each additional scope may be at most 256 characters. A maximum of 10 additional scopes may be configured. */
       additionalScopes?: string[];
       /** Required. The behavior for how OIDC Claims are included in the `assertion` object used for attribute mapping and attribute condition. */
       assertionClaimsBehavior?: string;
@@ -566,11 +566,11 @@ declare namespace gapi.client {
     interface WorkforcePool {
       /** Optional. Configure access restrictions on the workforce pool users. This is an optional field. If specified web sign-in can be restricted to given set of services or programmatic sign-in can be disabled for pool users. */
       accessRestrictions?: AccessRestrictions;
-      /** A user-specified description of the pool. Cannot exceed 256 characters. */
+      /** Optional. A user-specified description of the pool. Cannot exceed 256 characters. */
       description?: string;
-      /** Disables the workforce pool. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again. */
+      /** Optional. Disables the workforce pool. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again. */
       disabled?: boolean;
-      /** A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters. */
+      /** Optional. A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters. */
       displayName?: string;
       /** Output only. Time after which the workforce pool will be permanently purged and cannot be recovered. */
       expireTime?: string;
@@ -578,21 +578,21 @@ declare namespace gapi.client {
       name?: string;
       /** Immutable. The resource name of the parent. Format: `organizations/{org-id}`. */
       parent?: string;
-      /** Duration that the Google Cloud access tokens, console sign-in sessions, and `gcloud` sign-in sessions from this pool are valid. Must be greater than 15 minutes (900s) and less than 12 hours (43200s). If `session_duration` is not configured, minted credentials have a default duration of one hour (3600s). For SAML providers, the lifetime of the token is the minimum of the `session_duration` and the `SessionNotOnOrAfter` claim in the SAML assertion. */
+      /** Optional. Duration that the Google Cloud access tokens, console sign-in sessions, and `gcloud` sign-in sessions from this pool are valid. Must be greater than 15 minutes (900s) and less than 12 hours (43200s). If `session_duration` is not configured, minted credentials have a default duration of one hour (3600s). For SAML providers, the lifetime of the token is the minimum of the `session_duration` and the `SessionNotOnOrAfter` claim in the SAML assertion. */
       sessionDuration?: string;
       /** Output only. The state of the pool. */
       state?: string;
     }
     interface WorkforcePoolProvider {
-      /** A [Common Expression Language](https://opensource.google/projects/cel) 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: * `assertion`: JSON representing the authentication credential issued by the provider. * `google`: The Google attributes mapped from the assertion in the `attribute_mappings`. `google.profile_photo`, `google.display_name` and `google.posix_username` are not supported. * `attribute`: The custom attributes mapped from the assertion in the `attribute_mappings`. The maximum length of the attribute condition expression is 4096 characters. If unspecified, all valid authentication credentials will be accepted. The following example shows how to only allow credentials with a mapped `google.groups` value of `admins`: ``` "'admins' in google.groups" ``` */
+      /** Optional. A [Common Expression Language](https://opensource.google/projects/cel) 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: * `assertion`: JSON representing the authentication credential issued by the provider. * `google`: The Google attributes mapped from the assertion in the `attribute_mappings`. `google.profile_photo`, `google.display_name` and `google.posix_username` are not supported. * `attribute`: The custom attributes mapped from the assertion in the `attribute_mappings`. The maximum length of the attribute condition expression is 4096 characters. If unspecified, all valid authentication credentials will be accepted. The following example shows how to only allow credentials with a mapped `google.groups` value of `admins`: ``` "'admins' in google.groups" ``` */
       attributeCondition?: string;
       /** Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex "^a-zA-Z0-9._{0,31}$". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} 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 workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` 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 `assertion` 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 4KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` */
       attributeMapping?: {[P in string]: string};
-      /** A user-specified description of the provider. Cannot exceed 256 characters. */
+      /** Optional. A user-specified description of the provider. Cannot exceed 256 characters. */
       description?: string;
-      /** Disables the workforce pool provider. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access. */
+      /** Optional. Disables the workforce pool provider. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access. */
       disabled?: boolean;
-      /** A user-specified display name for the provider. Cannot exceed 32 characters. */
+      /** Optional. A user-specified display name for the provider. Cannot exceed 32 characters. */
       displayName?: string;
       /** Output only. Time after which the workload pool provider will be permanently purged and cannot be recovered. */
       expireTime?: string;
@@ -1482,7 +1482,7 @@ declare namespace gapi.client {
         fields?: string;
         /** 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. */
         key?: string;
-        /** The location of the pool to create. Format: `locations/{location}`. */
+        /** Optional. The location of the pool to create. Format: `locations/{location}`. */
         location: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
@@ -1494,7 +1494,7 @@ declare namespace gapi.client {
         upload_protocol?: string;
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
-        /** The ID to use for the pool, which becomes the final component of the resource name. The IDs must be a globally unique string of 6 to 63 lowercase letters, digits, or hyphens. It must start with a letter, and cannot have a trailing hyphen. The prefix `gcp-` is reserved for use by Google, and may not be specified. */
+        /** Optional. The ID to use for the pool, which becomes the final component of the resource name. The IDs must be a globally unique string of 6 to 63 lowercase letters, digits, or hyphens. It must start with a letter, and cannot have a trailing hyphen. The prefix `gcp-` is reserved for use by Google, and may not be specified. */
         workforcePoolId?: string;
         /** Request body */
         resource: WorkforcePool;
@@ -1513,7 +1513,7 @@ declare namespace gapi.client {
           fields?: string;
           /** 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. */
           key?: string;
-          /** The location of the pool to create. Format: `locations/{location}`. */
+          /** Optional. The location of the pool to create. Format: `locations/{location}`. */
           location: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;
@@ -1525,7 +1525,7 @@ declare namespace gapi.client {
           upload_protocol?: string;
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
-          /** The ID to use for the pool, which becomes the final component of the resource name. The IDs must be a globally unique string of 6 to 63 lowercase letters, digits, or hyphens. It must start with a letter, and cannot have a trailing hyphen. The prefix `gcp-` is reserved for use by Google, and may not be specified. */
+          /** Optional. The ID to use for the pool, which becomes the final component of the resource name. The IDs must be a globally unique string of 6 to 63 lowercase letters, digits, or hyphens. It must start with a letter, and cannot have a trailing hyphen. The prefix `gcp-` is reserved for use by Google, and may not be specified. */
           workforcePoolId?: string;
         },
         body: WorkforcePool

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.iam-v1",
-  "version": "0.0.20241017",
+  "version": "0.0.20241104",
   "description": "TypeScript typings for Identity and Access Management (IAM) API v1",
   "repository": {
     "type": "git",