googleapis
Version:
Google APIs Client Library for Node.js
888 lines • 274 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;
locations: Resource$Locations;
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`, 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`. * `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.
*/
members?: string[] | null;
/**
* Role that is assigned to the list of `members`, or principals. 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 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 {
}
/**
* 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;
}
/**
* 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 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;
/**
* 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;
/**
* 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 {
/**
* 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 {
/**
* 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 14 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 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 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 format for full resource names. For example, a 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;
}
/**
* 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[];
}
/**
* 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 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 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. Must be an HTTPS endpoint.
*/
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 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 service account patch request. 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`, or principals, to a single `role`. Principals 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`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
*/
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. For example, `roles/logging.viewer` for predefined roles, `organizations/{ORGANIZATION_ID\}/roles/my-role` for organization-level custom roles, and `projects/{PROJECT_ID\}/roles/my-role` for project-level 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;
}
/**
* Represents an SAML 2.0 identity provider.
*/
export interface Schema$Saml {
/**
* Required. SAML Identity provider configuration metadata xml doc. The xml document should comply with [SAML 2.0 specification](https://www.oasis-open.org/committees/download.php/56785/sstc-saml-metadata-errata-2.0-wd-05.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 14 years in the future. 4) Upto 3 IdP signing keys are allowed in the metadata xml. When updating the provider's metadata xml, at lease one non-expired signing key must overlap with the existing metadata. This requirement is skipped if there are no non-expired signing keys present in the existing metadata
*/
idpMetadataXml?: 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 access 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 {
/**
* The key status.
*/
disabled?: boolean | null;
/**
* 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 Google Cloud 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"`
*/
u