googleapis
Version:
Google APIs Client Library for Node.js
862 lines • 290 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, 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 Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls.
*
* @example
* ```js
* const {google} = require('googleapis');
* const iam = google.iam('v1');
* ```
*/
export class Iam {
context: APIRequestContext;
iamPolicies: Resource$Iampolicies;
organizations: Resource$Organizations;
permissions: Resource$Permissions;
projects: Resource$Projects;
roles: Resource$Roles;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* 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;
}
/**
* Contains information about an auditable service.
*/
export interface Schema$AuditableService {
/**
* Public name of the service. For example, the service name for Cloud 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` 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 members 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 identities requesting access for a Cloud Platform 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. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
*/
members?: string[] | null;
/**
* Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
*/
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 Cloud Platform 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 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); \} The JSON representation for `Empty` is empty JSON object `{\}`.
*/
export interface Schema$Empty {
}
/**
* 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;
}
/**
* The request to lint a Cloud 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 Platform (GCP) resource format. For example, a GCP project with ID `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`. The resource name is not used to read the policy instance from the Cloud IAM database. The candidate policy for lint has to be provided in the same request object.
*/
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;
}
/**
* 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 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 OpenId Connect 1.0 identity provider.
*/
export interface Schema$Oidc {
/**
* 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.
*/
issuerUri?: 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 response of the operation in case of success. 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;
}
/**
* The request for PatchServiceAccount. You can patch only the `display_name` and `description` fields. You must use the `update_mask` field to specify which of these fields you want to patch. Only the fields specified in the request are guaranteed to be returned in the response. Other fields may be empty in the response.
*/
export interface Schema$PatchServiceAccountRequest {
serviceAccount?: Schema$ServiceAccount;
updateMask?: string | null;
}
/**
* A permission which can be included by a role.
*/
export interface Schema$Permission {
/**
* The service API associated with the permission is not enabled.
*/
apiDisabled?: boolean | null;
/**
* The current custom role support level.
*/
customRolesSupportLevel?: string | null;
/**
* A brief description of what this Permission is used for. This permission can ONLY be used in predefined roles.
*/
description?: string | null;
/**
* The name of this Permission.
*/
name?: string | null;
onlyInPredefinedRoles?: boolean | null;
/**
* The preferred name for this permission. If present, then this permission is an alias of, and equivalent to, the listed primary_permission.
*/
primaryPermission?: string | null;
/**
* The current launch stage of the permission.
*/
stage?: string | null;
/**
* The title of this Permission.
*/
title?: string | null;
}
/**
* A PermissionDelta message to record the added_permissions and removed_permissions inside a role.
*/
export interface Schema$PermissionDelta {
/**
* Added permissions.
*/
addedPermissions?: string[] | null;
/**
* Removed permissions.
*/
removedPermissions?: string[] | null;
}
/**
* An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. 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 [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "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 \} **YAML example:** 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 [IAM documentation](https://cloud.google.com/iam/docs/).
*/
export interface Schema$Policy {
/**
* Specifies cloud audit logging configuration for this policy.
*/
auditConfigs?: Schema$AuditConfig[];
/**
* Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
*/
bindings?: Schema$Binding[];
/**
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
*/
etag?: string | null;
/**
* Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
version?: number | null;
}
/**
* The difference delta between two policies.
*/
export interface Schema$PolicyDelta {
/**
* The delta for Bindings between two policies.
*/
bindingDeltas?: Schema$BindingDelta[];
}
/**
* A request to get the list of auditable services for a resource.
*/
export interface Schema$QueryAuditableServicesRequest {
/**
* Required. The full resource name to query from the list of auditable services. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`.
*/
fullResourceName?: string | null;
}
/**
* A response containing a list of auditable services for a resource.
*/
export interface Schema$QueryAuditableServicesResponse {
/**
* The auditable services for a resource.
*/
services?: Schema$AuditableService[];
}
/**
* The grantable role query request.
*/
export interface Schema$QueryGrantableRolesRequest {
/**
* Required. The full resource name to query from the list of grantable roles. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`.
*/
fullResourceName?: string | null;
/**
* Optional limit on the number of roles to include in the response. The default is 300, and the maximum is 1,000.
*/
pageSize?: number | null;
/**
* Optional pagination token returned in an earlier QueryGrantableRolesResponse.
*/
pageToken?: string | null;
view?: string | null;
}
/**
* The grantable role query response.
*/
export interface Schema$QueryGrantableRolesResponse {
/**
* To retrieve the next page of results, set `QueryGrantableRolesRequest.page_token` to this value.
*/
nextPageToken?: string | null;
/**
* The list of matching roles.
*/
roles?: Schema$Role[];
}
/**
* A request to get permissions which can be tested on a resource.
*/
export interface Schema$QueryTestablePermissionsRequest {
/**
* Required. The full resource name to query from the list of testable permissions. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`.
*/
fullResourceName?: string | null;
/**
* Optional limit on the number of permissions to include in the response. The default is 100, and the maximum is 1,000.
*/
pageSize?: number | null;
/**
* Optional pagination token returned in an earlier QueryTestablePermissionsRequest.
*/
pageToken?: string | null;
}
/**
* The response containing permissions which can be tested on a resource.
*/
export interface Schema$QueryTestablePermissionsResponse {
/**
* To retrieve the next page of results, set `QueryTestableRolesRequest.page_token` to this value.
*/
nextPageToken?: string | null;
/**
* The Permissions testable on the requested resource.
*/
permissions?: Schema$Permission[];
}
/**
* A role in the Identity and Access Management API.
*/
export interface Schema$Role {
/**
* The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.
*/
deleted?: boolean | null;
/**
* Optional. A human-readable description for the role.
*/
description?: string | null;
/**
* Used to perform a consistent read-modify-write.
*/
etag?: string | null;
/**
* The names of the permissions this role grants when bound in an IAM policy.
*/
includedPermissions?: string[] | null;
/**
* The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID\}/roles/logging.viewer for custom roles.
*/
name?: string | null;
/**
* The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
*/
stage?: string | null;
/**
* Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
*/
title?: string | null;
}
/**
* An IAM service account. A service account is an account for an application or a virtual machine (VM) instance, not a person. You can use a service account to call Google APIs. To learn more, read the [overview of service accounts](https://cloud.google.com/iam/help/service-accounts/overview). When you create a service account, you specify the project ID that owns the service account, as well as a name that must be unique within the project. IAM uses these values to create an email address that identifies the service account.
*/
export interface Schema$ServiceAccount {
/**
* Optional. A user-specified, human-readable description of the service account. The maximum length is 256 UTF-8 bytes.
*/
description?: string | null;
/**
* Output only. Whether the service account is disabled.
*/
disabled?: boolean | null;
/**
* Optional. A user-specified, human-readable name for the service account. The maximum length is 100 UTF-8 bytes.
*/
displayName?: string | null;
/**
* Output only. The email address of the service account.
*/
email?: string | null;
/**
* Deprecated. Do not use.
*/
etag?: string | null;
/**
* The resource name of the service account. Use one of the following formats: * `projects/{PROJECT_ID\}/serviceAccounts/{EMAIL_ADDRESS\}` * `projects/{PROJECT_ID\}/serviceAccounts/{UNIQUE_ID\}` As an alternative, you can use the `-` wildcard character instead of the project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS\}` * `projects/-/serviceAccounts/{UNIQUE_ID\}` When possible, avoid using the `-` wildcard character, because it can cause response messages to contain misleading error codes. For example, if you try to get the service account `projects/-/serviceAccounts/fake@example.com`, which does not exist, the response contains an HTTP `403 Forbidden` error instead of a `404 Not Found` error.
*/
name?: string | null;
/**
* Output only. The OAuth 2.0 client ID for the service account.
*/
oauth2ClientId?: string | null;
/**
* Output only. The ID of the project that owns the service account.
*/
projectId?: string | null;
/**
* Output only. The unique, stable numeric ID for the service account. Each service account retains its unique ID even if you delete the service account. For example, if you delete a service account, then create a new service account with the same name, the new service account has a different unique ID than the deleted service account.
*/
uniqueId?: string | null;
}
/**
* Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API.
*/
export interface Schema$ServiceAccountKey {
/**
* Specifies the algorithm (and possibly key size) for the key.
*/
keyAlgorithm?: string | null;
/**
* The key origin.
*/
keyOrigin?: string | null;
/**
* The key type.
*/
keyType?: string | null;
/**
* The resource name of the service account key in the following format `projects/{PROJECT_ID\}/serviceAccounts/{ACCOUNT\}/keys/{key\}`.
*/
name?: string | null;
/**
* The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account.
*/
privateKeyData?: string | null;
/**
* The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
*/
privateKeyType?: string | null;
/**
* The public key data. Only provided in `GetServiceAccountKey` responses.
*/
publicKeyData?: string | null;
/**
* The key can be used after this timestamp.
*/
validAfterTime?: string | null;
/**
* The key can be used before this timestamp. For system-managed key pairs, this timestamp is the end time for the private key signing operation. The public key could still be used for verification for a few hours after this time.
*/
validBeforeTime?: string | null;
}
/**
* Request message for `SetIamPolicy` method.
*/
export interface Schema$SetIamPolicyRequest {
/**
* REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
*/
policy?: Schema$Policy;
/**
* OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
*/
updateMask?: string | null;
}
/**
* Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The service account sign blob request.
*/
export interface Schema$SignBlobRequest {
/**
* Required. Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The bytes to sign.
*/
bytesToSign?: string | null;
}
/**
* Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The service account sign blob response.
*/
export interface Schema$SignBlobResponse {
/**
* Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The id of the key used to sign the blob.
*/
keyId?: string | null;
/**
* Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The signed blob.
*/
signature?: string | null;
}
/**
* Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The service account sign JWT request.
*/
export interface Schema$SignJwtRequest {
/**
* Required. Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The JWT payload to sign. Must be a serialized JSON object that contains a JWT Claims Set. For example: `{"sub": "user@example.com", "iat": 313435\}` If the JWT Claims Set contains an expiration time (`exp`) claim, it must be an integer timestamp that is not in the past and no more than 1 hour in the future. If the JWT Claims Set does not contain an expiration time (`exp`) claim, this claim is added automatically, with a timestamp that is 1 hour in the future.
*/
payload?: string | null;
}
/**
* Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The service account sign JWT response.
*/
export interface Schema$SignJwtResponse {
/**
* Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The id of the key used to sign the JWT.
*/
keyId?: string | null;
/**
* Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The signed JWT.
*/
signedJwt?: string | null;
}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string | null;
}
/**
* Request message for `TestIamPermissions` method.
*/
export interface Schema$TestIamPermissionsRequest {
/**
* The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
permissions?: string[] | null;
}
/**
* Response message for `TestIamPermissions` method.
*/
export interface Schema$TestIamPermissionsResponse {
/**
* A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
*/
permissions?: string[] | null;
}
/**
* The request to undelete an existing role.
*/
export interface Schema$UndeleteRoleRequest {
/**
* Used to perform a consistent read-modify-write.
*/
etag?: string | null;
}
/**
* The service account undelete request.
*/
export interface Schema$UndeleteServiceAccountRequest {
}
export interface Schema$UndeleteServiceAccountResponse {
/**
* Metadata for the restored service account.
*/
restoredAccount?: Schema$ServiceAccount;
}
/**
* Request message for UndeleteWorkloadIdentityPoolProvider.
*/
export interface Schema$UndeleteWorkloadIdentityPoolProviderRequest {
}
/**
* Request message for UndeleteWorkloadIdentityPool.
*/
export interface Schema$UndeleteWorkloadIdentityPoolRequest {
}
/**
* The service account key upload request.
*/
export interface Schema$UploadServiceAccountKeyRequest {
/**
* A field that allows clients to upload their own public key. If set, use this public key data to create a service account key for given service account. Please note, the expected format for this field is X509_PEM.
*/
publicKeyData?: string | null;
}
/**
* Represents a collection of external workload identities. You can define IAM policies to grant these identities access to Google Cloud resources.
*/
export interface Schema$WorkloadIdentityPool {
/**
* A description of the pool. Cannot exceed 256 characters.
*/
description?: string | null;
/**
* Whether the pool is disabled. 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 | null;
/**
* A display name for the pool. Cannot exceed 32 characters.
*/
displayName?: string | null;
/**
* Output only. The resource name of the pool.
*/
name?: string | null;
/**
* Output only. The state of the pool.
*/
state?: string | null;
}
/**
* A configuration for an external identity provider.
*/
export interface Schema$WorkloadIdentityPoolProvider {
/**
* [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`. * `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 credential are accepted. The following example shows how to only allow credentials with a mapped `google.groups` value of `admins`: ``` "'admins' in google.groups" ```
*/
attributeCondition?: string | null;
/**
* Maps attributes from 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. Cannot exceed 127 characters. * `google.groups`: Groups the external identity belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. 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 workload to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/projects/{project\}/locations/{location\}/workloadIdentityPools/{pool\}/subject/{value\}` * `google.groups`: `principalSet://iam.googleapis.com/projects/{project\}/locations/{location\}/workloadIdentityPools/{pool\}/group/{value\}` * `attribute.{custom_attribute\}`: `principalSet://iam.googleapis.com/projects/{project\}/locations/{location\}/workloadIdentityPools/{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 8KB. For AWS providers, if no attribute mapping is defined, the following default mapping applies: ``` { "google.subject":"assertion.arn", "attribute.aws_role": "assertion.arn.contains('assumed-role')" " ? assertion.arn.extract('{account_arn\}assumed-role/')" " + 'assumed-role/'" " + assertion.arn.extract('assumed-role/{role_name\}/')" " : assertion.arn", \} ``` If any custom attribute mappings are defined, they must include a mapping to the `google.subject` attribute. For OIDC providers, you must supply a custom mapping, which must include 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?: {
[key: string]: string;
} | null;
/**
* An Amazon Web Services identity provider.
*/
aws?: Schema$Aws;
/**
* A description for the provider. Cannot exceed 256 charact