googleapis
Version:
Google APIs Client Library for Node.js
913 lines • 713 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace iam_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
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;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Identity and Access Management (IAM) API
*
* Manages identity and access control for Google Cloud resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. Enabling this API also enables the IAM Service Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API.
*
* @example
* ```js
* const {google} = require('googleapis');
* const iam = google.iam('v1');
* ```
*/
export class Iam {
context: APIRequestContext;
iamPolicies: Resource$Iampolicies;
locations: Resource$Locations;
organizations: Resource$Organizations;
permissions: Resource$Permissions;
projects: Resource$Projects;
roles: Resource$Roles;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Access related restrictions on the workforce pool.
*/
export interface Schema$AccessRestrictions {
/**
* Optional. Immutable. Services allowed for web sign-in with the workforce pool. If not set by default there are no restrictions.
*/
allowedServices?: Schema$ServiceConfig[];
/**
* Optional. Disable programmatic sign-in by disabling token issue via the Security Token API endpoint. See [Security Token Service API] (https://cloud.google.com/iam/docs/reference/sts/rest).
*/
disableProgrammaticSignin?: boolean | null;
}
/**
* Request message for AddAttestationRule.
*/
export interface Schema$AddAttestationRuleRequest {
/**
* Required. The attestation rule to be added.
*/
attestationRule?: Schema$AttestationRule;
}
/**
* Audit log information specific to Cloud IAM admin APIs. This message is serialized as an `Any` type in the `ServiceData` message of an `AuditLog` message.
*/
export interface Schema$AdminAuditData {
/**
* The permission_delta when when creating or updating a Role.
*/
permissionDelta?: Schema$PermissionDelta;
}
/**
* Defines which workloads can receive an identity within a pool. When an AttestationRule is defined under a managed identity, matching workloads may receive that identity.
*/
export interface Schema$AttestationRule {
/**
* Optional. A single workload operating on Google Cloud. For example: `//compute.googleapis.com/projects/123/uid/zones/us-central1-a/instances/12345`.
*/
googleCloudResource?: string | null;
}
/**
* Contains information about an auditable service.
*/
export interface Schema$AuditableService {
/**
* Public name of the service. For example, the service name for IAM is 'iam.googleapis.com'.
*/
name?: string | null;
}
/**
* Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
*/
export interface Schema$AuditConfig {
/**
* The configuration for logging of each type of permission.
*/
auditLogConfigs?: Schema$AuditLogConfig[];
/**
* Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
*/
service?: string | null;
}
/**
* Audit log information specific to Cloud IAM. This message is serialized as an `Any` type in the `ServiceData` message of an `AuditLog` message.
*/
export interface Schema$AuditData {
/**
* Policy delta between the original policy and the newly set policy.
*/
policyDelta?: Schema$PolicyDelta;
}
/**
* Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \} ] \} This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
*/
export interface Schema$AuditLogConfig {
/**
* Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
*/
exemptedMembers?: string[] | null;
/**
* The log type that this config enables.
*/
logType?: string | null;
}
/**
* Represents an Amazon Web Services identity provider.
*/
export interface Schema$Aws {
/**
* Required. The AWS account ID.
*/
accountId?: string | null;
}
/**
* Associates `members`, or principals, with a `role`.
*/
export interface Schema$Binding {
/**
* The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
condition?: Schema$Expr;
/**
* Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
*/
members?: string[] | null;
/**
* Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
*/
role?: string | null;
}
/**
* One delta entry for Binding. Each individual change (only one member in each entry) to a binding will be a separate entry.
*/
export interface Schema$BindingDelta {
/**
* The action that was performed on a Binding. Required
*/
action?: string | null;
/**
* The condition that is associated with this binding.
*/
condition?: Schema$Expr;
/**
* A single identity requesting access for a Google Cloud resource. Follows the same format of Binding.members. Required
*/
member?: string | null;
/**
* Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
*/
role?: string | null;
}
/**
* The request to create a new role.
*/
export interface Schema$CreateRoleRequest {
/**
* The Role resource to create.
*/
role?: Schema$Role;
/**
* The role ID to use for this role. A role ID may contain alphanumeric characters, underscores (`_`), and periods (`.`). It must contain a minimum of 3 characters and a maximum of 64 characters.
*/
roleId?: string | null;
}
/**
* The service account key create request.
*/
export interface Schema$CreateServiceAccountKeyRequest {
/**
* Which type of key and algorithm to use for the key. The default is currently a 2K RSA key. However this may change in the future.
*/
keyAlgorithm?: string | null;
/**
* The output format of the private key. The default value is `TYPE_GOOGLE_CREDENTIALS_FILE`, which is the Google Credentials File format.
*/
privateKeyType?: string | null;
}
/**
* The service account create request.
*/
export interface Schema$CreateServiceAccountRequest {
/**
* Required. The account id that is used to generate the service account email address and a stable unique id. It is unique within a project, must be 6-30 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035.
*/
accountId?: string | null;
/**
* The ServiceAccount resource to create. Currently, only the following values are user assignable: `display_name` and `description`.
*/
serviceAccount?: Schema$ServiceAccount;
}
/**
* The service account key disable request.
*/
export interface Schema$DisableServiceAccountKeyRequest {
/**
* Optional. Usable by internal google services only. An extended_status_message can be used to include additional information about the key, such as its private key data being exposed on a public repository like GitHub.
*/
extendedStatusMessage?: string | null;
/**
* Optional. Describes the reason this key is being disabled. If unspecified, the default value of SERVICE_ACCOUNT_KEY_DISABLE_REASON_USER_INITIATED will be used.
*/
serviceAccountKeyDisableReason?: string | null;
}
/**
* The service account disable request.
*/
export interface Schema$DisableServiceAccountRequest {
}
/**
* 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); \}
*/
export interface Schema$Empty {
}
/**
* The service account key enable request.
*/
export interface Schema$EnableServiceAccountKeyRequest {
}
/**
* The service account enable request.
*/
export interface Schema$EnableServiceAccountRequest {
}
/**
* 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.
*/
export interface Schema$Expr {
/**
* Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string | null;
/**
* Textual representation of an expression in Common Expression Language syntax.
*/
expression?: string | null;
/**
* Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string | null;
/**
* Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
*/
title?: string | null;
}
/**
* Extended status can store additional metadata. For example, for keys disabled due to their private key data being expoesed we may include a message with more information about the exposure.
*/
export interface Schema$ExtendedStatus {
/**
* The key for this extended status.
*/
key?: string | null;
/**
* The value for the extended status.
*/
value?: string | null;
}
/**
* Request message for `GetIamPolicy` method.
*/
export interface Schema$GetIamPolicyRequest {
/**
* OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
*/
options?: Schema$GetPolicyOptions;
}
/**
* Encapsulates settings provided to GetIamPolicy.
*/
export interface Schema$GetPolicyOptions {
/**
* Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
requestedPolicyVersion?: number | null;
}
/**
* Represents the OAuth 2.0 client credential configuration for retrieving additional user attributes that are not present in the initial authentication credentials from the identity provider, for example, groups. See https://datatracker.ietf.org/doc/html/rfc6749#section-4.4 for more details on client credentials grant flow.
*/
export interface Schema$GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client {
/**
* Required. Represents the IdP and type of claims that should be fetched.
*/
attributesType?: string | null;
/**
* Required. The OAuth 2.0 client ID for retrieving extra attributes from the identity provider. Required to get the Access Token using client credentials grant flow.
*/
clientId?: string | null;
/**
* Required. The OAuth 2.0 client secret for retrieving extra attributes from the identity provider. Required to get the Access Token using client credentials grant flow.
*/
clientSecret?: Schema$GoogleIamAdminV1WorkforcePoolProviderOidcClientSecret;
/**
* Required. The OIDC identity provider's issuer URI. Must be a valid URI using the `https` scheme. Required to get the OIDC discovery document.
*/
issuerUri?: string | null;
/**
* Optional. Represents the parameters to control which claims are fetched from an IdP.
*/
queryParameters?: Schema$GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2ClientQueryParameters;
}
/**
* Represents the parameters to control which claims are fetched from an IdP.
*/
export interface Schema$GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2ClientQueryParameters {
/**
* Optional. The filter used to request specific records from the IdP. By default, all of the groups that are associated with a user are fetched. For Microsoft Entra ID, you can add `$search` query parameters using [Keyword Query Language] (https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). To learn more about `$search` querying in Microsoft Entra ID, see [Use the `$search` query parameter] (https://learn.microsoft.com/en-us/graph/search-query-parameter). Additionally, Workforce Identity Federation automatically adds the following [`$filter` query parameters] (https://learn.microsoft.com/en-us/graph/filter-query-parameter), based on the value of `attributes_type`. Values passed to `filter` are converted to `$search` query parameters. Additional `$filter` query parameters cannot be added using this field. * `AZURE_AD_GROUPS_MAIL`: `mailEnabled` and `securityEnabled` filters are applied. * `AZURE_AD_GROUPS_ID`: `securityEnabled` filter is applied.
*/
filter?: string | null;
}
/**
* Represents an OpenID Connect 1.0 identity provider.
*/
export interface Schema$GoogleIamAdminV1WorkforcePoolProviderOidc {
/**
* Required. The client ID. Must match the audience claim of the JWT issued by the identity provider.
*/
clientId?: string | null;
/**
* Optional. The optional client secret. Required to enable Authorization Code flow for web sign-in.
*/
clientSecret?: Schema$GoogleIamAdminV1WorkforcePoolProviderOidcClientSecret;
/**
* Required. The OIDC issuer URI. Must be a valid URI using the `https` scheme.
*/
issuerUri?: string | null;
/**
* 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 that is fetched from the well-known path of the `issuer_uri`, will be used. RSA and EC asymmetric keys are supported. The JWK must use the following format and include only the following fields: { "keys": [ { "kty": "RSA/EC", "alg": "", "use": "sig", "kid": "", "n": "", "e": "", "x": "", "y": "", "crv": "" \} ] \}
*/
jwksJson?: string | null;
/**
* 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?: Schema$GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfig;
}
/**
* Representation of a client secret configured for the OIDC provider.
*/
export interface Schema$GoogleIamAdminV1WorkforcePoolProviderOidcClientSecret {
/**
* The value of the client secret.
*/
value?: Schema$GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValue;
}
/**
* Representation of the value of the client secret.
*/
export interface Schema$GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValue {
/**
* 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 | null;
/**
* Output only. A thumbprint to represent the current client secret value.
*/
thumbprint?: string | null;
}
/**
* Configuration for web single sign-on for the OIDC provider.
*/
export interface Schema$GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfig {
/**
* 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[] | null;
/**
* Required. The behavior for how OIDC Claims are included in the `assertion` object used for attribute mapping and attribute condition.
*/
assertionClaimsBehavior?: string | null;
/**
* Required. The Response Type to request for in the OIDC Authorization Request for web sign-in. The `CODE` Response Type is recommended to avoid the Implicit Flow, for security reasons.
*/
responseType?: string | null;
}
/**
* Represents a SAML identity provider.
*/
export interface Schema$GoogleIamAdminV1WorkforcePoolProviderSaml {
/**
* Required. SAML Identity provider configuration metadata xml doc. The xml document should comply with [SAML 2.0 specification](https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf). 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 25 years in the future. 4) Up to 3 IdP signing keys are allowed in the metadata xml. When updating the provider's metadata xml, at least 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.
*/
idpMetadataXml?: string | null;
}
/**
* Represents configuration for generating mutual TLS (mTLS) certificates for the identities within this pool.
*/
export interface Schema$InlineCertificateIssuanceConfig {
/**
* Optional. A required mapping of a Google Cloud region to the CA pool resource located in that region. The CA pool is used for certificate issuance, adhering to the following constraints: * Key format: A supported cloud region name equivalent to the location identifier in the corresponding map entry's value. * Value format: A valid CA pool resource path format like: "projects/{project\}/locations/{location\}/caPools/{ca_pool\}" * Region Matching: Workloads are ONLY issued certificates from CA pools within the same region. Also the CA pool region (in value) must match the workload's region (key).
*/
caPools?: {
[key: string]: string;
} | null;
/**
* Optional. Key algorithm to use when generating the key pair. This key pair will be used to create the certificate. If not specified, this will default to ECDSA_P256.
*/
keyAlgorithm?: string | null;
/**
* Optional. Lifetime of the workload certificates issued by the CA pool. Must be between 24 hours and 30 days. If not specified, this will be defaulted to 24 hours.
*/
lifetime?: string | null;
/**
* Optional. Rotation window percentage, the percentage of remaining lifetime after which certificate rotation is initiated. Must be between 50 and 80. If no value is specified, rotation window percentage is defaulted to 50.
*/
rotationWindowPercentage?: number | null;
}
/**
* Defines configuration for extending trust to additional trust domains. By establishing trust with another domain, the current domain will recognize and accept certificates issued by entities within the trusted domains. Note that a trust domain automatically trusts itself, eliminating the need for explicit configuration.
*/
export interface Schema$InlineTrustConfig {
/**
* Optional. Maps specific trust domains (e.g., "example.com") to their corresponding TrustStore, which contain the trusted root certificates for that domain. There can be a maximum of 10 trust domain entries in this map. Note that a trust domain automatically trusts itself and don't need to be specified here. If however, this WorkloadIdentityPool's trust domain contains any trust anchors in the additional_trust_bundles map, those trust anchors will be *appended to* the trust bundle automatically derived from your InlineCertificateIssuanceConfig's ca_pools.
*/
additionalTrustBundles?: {
[key: string]: Schema$TrustStore;
} | null;
}
/**
* Intermediate CA certificates used for building the trust chain to trust anchor
*/
export interface Schema$IntermediateCA {
/**
* PEM certificate of the PKI used for validation. Must only contain one ca certificate.
*/
pemCertificate?: string | null;
}
/**
* Represents a public key data along with its format.
*/
export interface Schema$KeyData {
/**
* Output only. The format of the key.
*/
format?: string | null;
/**
* Output only. The key data. The format of the key is represented by the format field.
*/
key?: string | null;
/**
* Required. The specifications for the key.
*/
keySpec?: string | null;
/**
* Output only. Latest timestamp when this key is valid. Attempts to use this key after this time will fail. Only present if the key data represents a X.509 certificate.
*/
notAfterTime?: string | null;
/**
* Output only. Earliest timestamp when this key is valid. Attempts to use this key before this time will fail. Only present if the key data represents a X.509 certificate.
*/
notBeforeTime?: string | null;
}
/**
* The request to lint an IAM policy object.
*/
export interface Schema$LintPolicyRequest {
/**
* google.iam.v1.Binding.condition object to be linted.
*/
condition?: Schema$Expr;
/**
* The full resource name of the policy this lint request is about. The name follows the Google Cloud format for full resource names. For example, a Google Cloud project with ID `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`. The resource name is not used to read a policy from IAM. Only the data in the request object is linted.
*/
fullResourceName?: string | null;
}
/**
* The response of a lint operation. An empty response indicates the operation was able to fully execute and no lint issue was found.
*/
export interface Schema$LintPolicyResponse {
/**
* List of lint results sorted by `severity` in descending order.
*/
lintResults?: Schema$LintResult[];
}
/**
* Structured response of a single validation unit.
*/
export interface Schema$LintResult {
/**
* Human readable debug message associated with the issue.
*/
debugMessage?: string | null;
/**
* The name of the field for which this lint result is about. For nested messages `field_name` consists of names of the embedded fields separated by period character. The top-level qualifier is the input object to lint in the request. For example, the `field_name` value `condition.expression` identifies a lint result for the `expression` field of the provided condition.
*/
fieldName?: string | null;
/**
* The validation unit level.
*/
level?: string | null;
/**
* 0-based character position of problematic construct within the object identified by `field_name`. Currently, this is populated only for condition expression.
*/
locationOffset?: number | null;
/**
* The validation unit severity.
*/
severity?: string | null;
/**
* The validation unit name, for instance "lintValidationUnits/ConditionComplexityCheck".
*/
validationUnitName?: string | null;
}
/**
* Response message for ListAttestationRules.
*/
export interface Schema$ListAttestationRulesResponse {
/**
* A list of AttestationRules.
*/
attestationRules?: Schema$AttestationRule[];
/**
* Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
}
/**
* Response message for ListOauthClientCredentials.
*/
export interface Schema$ListOauthClientCredentialsResponse {
/**
* A list of OauthClientCredentials.
*/
oauthClientCredentials?: Schema$OauthClientCredential[];
}
/**
* Response message for ListOauthClients.
*/
export interface Schema$ListOauthClientsResponse {
/**
* Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* A list of OauthClients.
*/
oauthClients?: Schema$OauthClient[];
}
/**
* The response containing the roles defined under a resource.
*/
export interface Schema$ListRolesResponse {
/**
* To retrieve the next page of results, set `ListRolesRequest.page_token` to this value.
*/
nextPageToken?: string | null;
/**
* The Roles defined on this resource.
*/
roles?: Schema$Role[];
}
/**
* The service account keys list response.
*/
export interface Schema$ListServiceAccountKeysResponse {
/**
* The public keys for the service account.
*/
keys?: Schema$ServiceAccountKey[];
}
/**
* The service account list response.
*/
export interface Schema$ListServiceAccountsResponse {
/**
* The list of matching service accounts.
*/
accounts?: Schema$ServiceAccount[];
/**
* To retrieve the next page of results, set ListServiceAccountsRequest.page_token to this value.
*/
nextPageToken?: string | null;
}
/**
* Response message for ListWorkforcePoolProviderKeys.
*/
export interface Schema$ListWorkforcePoolProviderKeysResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* A list of WorkforcePoolProviderKeys.
*/
workforcePoolProviderKeys?: Schema$WorkforcePoolProviderKey[];
}
/**
* Gemini Enterprise only. Response message for ListWorkforcePoolProviderScimTenants.
*/
export interface Schema$ListWorkforcePoolProviderScimTenantsResponse {
/**
* Optional. Gemini Enterprise only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* Output only. Gemini Enterprise only. A list of SCIM tenants.
*/
workforcePoolProviderScimTenants?: Schema$WorkforcePoolProviderScimTenant[];
}
/**
* Gemini Enterprise only. Response message for ListWorkforcePoolProviderScimTokens.
*/
export interface Schema$ListWorkforcePoolProviderScimTokensResponse {
/**
* Optional. Gemini Enterprise only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* Output only. Gemini Enterprise only. A list of SCIM tokens.
*/
workforcePoolProviderScimTokens?: Schema$WorkforcePoolProviderScimToken[];
}
/**
* Response message for ListWorkforcePoolProviders.
*/
export interface Schema$ListWorkforcePoolProvidersResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* A list of providers.
*/
workforcePoolProviders?: Schema$WorkforcePoolProvider[];
}
/**
* Response message for ListWorkforcePools.
*/
export interface Schema$ListWorkforcePoolsResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* A list of pools.
*/
workforcePools?: Schema$WorkforcePool[];
}
/**
* Response message for ListWorkloadIdentityPoolManagedIdentities.
*/
export interface Schema$ListWorkloadIdentityPoolManagedIdentitiesResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* A list of managed identities.
*/
workloadIdentityPoolManagedIdentities?: Schema$WorkloadIdentityPoolManagedIdentity[];
}
/**
* Response message for ListWorkloadIdentityPoolNamespaces.
*/
export interface Schema$ListWorkloadIdentityPoolNamespacesResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* A list of namespaces.
*/
workloadIdentityPoolNamespaces?: Schema$WorkloadIdentityPoolNamespace[];
}
/**
* Response message for ListWorkloadIdentityPoolProviderKeys.
*/
export interface Schema$ListWorkloadIdentityPoolProviderKeysResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* A list of WorkloadIdentityPoolProviderKey
*/
workloadIdentityPoolProviderKeys?: Schema$WorkloadIdentityPoolProviderKey[];
}
/**
* Response message for ListWorkloadIdentityPoolProviders.
*/
export interface Schema$ListWorkloadIdentityPoolProvidersResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* A list of providers.
*/
workloadIdentityPoolProviders?: Schema$WorkloadIdentityPoolProvider[];
}
/**
* Response message for ListWorkloadIdentityPools.
*/
export interface Schema$ListWorkloadIdentityPoolsResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* A list of pools.
*/
workloadIdentityPools?: Schema$WorkloadIdentityPool[];
}
/**
* Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.
*/
export interface Schema$OauthClient {
/**
* Required. The list of OAuth grant types is allowed for the OauthClient.
*/
allowedGrantTypes?: string[] | null;
/**
* Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
*/
allowedRedirectUris?: string[] | null;
/**
* Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
*/
allowedScopes?: string[] | null;
/**
* Output only. The system-generated OauthClient id.
*/
clientId?: string | null;
/**
* Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
*/
clientType?: string | null;
/**
* Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
*/
description?: string | null;
/**
* Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
*/
disabled?: boolean | null;
/**
* Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
*/
displayName?: string | null;
/**
* Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
*/
expireTime?: string | null;
/**
* Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project\}/locations/{location\}/oauthClients/{oauth_client\}`.
*/
name?: string | null;
/**
* Output only. The state of the OauthClient.
*/
state?: string | null;
}
/**
* Represents an OauthClientCredential. Used to authenticate an OauthClient while accessing Google Cloud resources on behalf of a user by using OAuth 2.0 Protocol.
*/
export interface Schema$OauthClientCredential {
/**
* Output only. The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see [OAuth client and credential security risks and mitigations](https://cloud.google.com/iam/docs/workforce-oauth-app#security)
*/
clientSecret?: string | null;
/**
* Optional. Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
*/
disabled?: boolean | null;
/**
* Optional. A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
*/
displayName?: string | null;
/**
* Immutable. Identifier. The resource name of the OauthClientCredential. Format: `projects/{project\}/locations/{location\}/oauthClients/{oauth_client\}/credentials/{credential\}`
*/
name?: string | null;
}
/**
* Represents an OpenId Connect 1.0 identity provider.
*/
export interface Schema$Oidc {
/**
* Optional. Acceptable values for the `aud` 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: ``` //iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ ```
*/
allowedAudiences?: string[] | null;
/**
* Required. The OIDC issuer URL. Must be an HTTPS endpoint. Per OpenID Connect Discovery 1.0 spec, the OIDC issuer URL is used to locate the provider's public keys (via `jwks_uri`) for verifying tokens like the OIDC ID token. These public key types must be 'EC' or 'RSA'.
*/
issuerUri?: string | null;
/**
* 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 | null;
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
* If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`.
*/
name?: string | null;
/**
* The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {
[key: string]: any;
} | null;
}
/**
* Represents the metadata of the long-running operation.
*/
export interface Schema$OperationMetadata {
/**
* Output only. API version used to start the operation.
*/
apiVersion?: string | null;
/**
* Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
*/
cancelRequested?: boolean | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* Output only. Human-readable status of the operation, if any.
*/
statusDetail?: string | null;
/**
* Output only. Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Output only. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* The Google Cloud service that owns this namespace.
*/
export interface Schema$OwnerService {
/**
* Required. The service agent principal subject, e.g. "serv