AuditConfig
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 bothallServices
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.
Fields | |
---|---|
auditLogConfigs[] |
The configuration for logging of each type of permission. |
service |
Specifies a service that will be enabled for audit logging. For example, |
AuditLogConfig
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.Fields | |
---|---|
exemptedMembers[] |
Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. |
logType |
The log type that this config enables. |
Enum type. Can be one of the following: | |
LOG_TYPE_UNSPECIFIED |
Default case. Should never be this. |
ADMIN_READ |
Admin reads. Example: CloudIAM getIamPolicy |
DATA_WRITE |
Data writes. Example: CloudSQL Users create |
DATA_READ |
Data reads. Example: CloudSQL Users list |
Binding
Associatesmembers
, or principals, with a role
.
Fields | |
---|---|
condition |
The condition that is associated with this binding. If the condition evaluates to |
members[] |
Specifies the principals requesting access for a Cloud Platform resource. |
role |
Role that is assigned to the list of |
CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation
Metadata describing a long running folder operationFields | |
---|---|
destinationParent |
The resource name of the folder or organization we are either creating the folder under or moving the folder to. |
displayName |
The display name of the folder. |
operationType |
The type of this operation. |
Enum type. Can be one of the following: | |
OPERATION_TYPE_UNSPECIFIED |
Operation type not specified. |
CREATE |
A create folder operation. |
MOVE |
A move folder operation. |
sourceParent |
The resource name of the folder's parent. Only applicable when the operation_type is MOVE. |
CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation
Metadata describing a long running folder operationFields | |
---|---|
destinationParent |
The resource name of the folder or organization we are either creating the folder under or moving the folder to. |
displayName |
The display name of the folder. |
operationType |
The type of this operation. |
Enum type. Can be one of the following: | |
OPERATION_TYPE_UNSPECIFIED |
Operation type not specified. |
CREATE |
A create folder operation. |
MOVE |
A move folder operation. |
sourceParent |
The resource name of the folder's parent. Only applicable when the operation_type is MOVE. |
CreateFolderMetadata
Metadata pertaining to the Folder creation process.Fields | |
---|---|
displayName |
The display name of the folder. |
parent |
The resource name of the folder or organization we are creating the folder under. |
CreateProjectMetadata
A status object which is used as themetadata
field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed.
Fields | |
---|---|
createTime |
Creation time of the project creation workflow. |
gettable |
True if the project can be retrieved using |
ready |
True if the project creation process is complete. |
Expr
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.Fields | |
---|---|
description |
Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
expression |
Textual representation of an expression in Common Expression Language syntax. |
location |
Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
title |
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. |
Folder
A folder in an organization's resource hierarchy, used to organize that organization's resources.Fields | |
---|---|
createTime |
Output only. Timestamp when the folder was created. |
deleteTime |
Output only. Timestamp when the folder was requested to be deleted. |
displayName |
The folder's display name. A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: |
etag |
Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. |
name |
Output only. The resource name of the folder. Its format is |
parent |
Required. The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder. |
state |
Output only. The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder. |
Enum type. Can be one of the following: | |
STATE_UNSPECIFIED |
Unspecified state. |
ACTIVE |
The normal and active state. |
DELETE_REQUESTED |
The folder has been marked for deletion by the user. |
updateTime |
Output only. Timestamp when the folder was last modified. |
FolderOperation
Metadata describing a long running folder operationFields | |
---|---|
destinationParent |
The resource name of the folder or organization we are either creating the folder under or moving the folder to. |
displayName |
The display name of the folder. |
operationType |
The type of this operation. |
Enum type. Can be one of the following: | |
OPERATION_TYPE_UNSPECIFIED |
Operation type not specified. |
CREATE |
A create folder operation. |
MOVE |
A move folder operation. |
sourceParent |
The resource name of the folder's parent. Only applicable when the operation_type is MOVE. |
FolderOperationError
A classification of the Folder Operation error.Fields | |
---|---|
errorMessageId |
The type of operation error experienced. |
Enum type. Can be one of the following: | |
ERROR_TYPE_UNSPECIFIED |
The error type was unrecognized or unspecified. |
ACTIVE_FOLDER_HEIGHT_VIOLATION |
The attempted action would violate the max folder depth constraint. |
MAX_CHILD_FOLDERS_VIOLATION |
The attempted action would violate the max child folders constraint. |
FOLDER_NAME_UNIQUENESS_VIOLATION |
The attempted action would violate the locally-unique folder display_name constraint. |
RESOURCE_DELETED_VIOLATION |
The resource being moved has been deleted. |
PARENT_DELETED_VIOLATION |
The resource a folder was being added to has been deleted. |
CYCLE_INTRODUCED_VIOLATION |
The attempted action would introduce cycle in resource path. |
FOLDER_BEING_MOVED_VIOLATION |
The attempted action would move a folder that is already being moved. |
FOLDER_TO_DELETE_NON_EMPTY_VIOLATION |
The folder the caller is trying to delete contains active resources. |
DELETED_FOLDER_HEIGHT_VIOLATION |
The attempted action would violate the max deleted folder depth constraint. |
GetIamPolicyRequest
Request message forGetIamPolicy
method.
Fields | |
---|---|
options |
OPTIONAL: A |
GetPolicyOptions
Encapsulates settings provided to GetIamPolicy.Fields | |
---|---|
requestedPolicyVersion |
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. |
Lien
A Lien represents an encumbrance on the actions that can be performed on a resource.Fields | |
---|---|
createTime |
The creation time of this Lien. |
name |
A system-generated unique identifier for this Lien. Example: |
origin |
A stable, user-visible/meaningful string identifying the origin of the Lien, intended to be inspected programmatically. Maximum length of 200 characters. Example: 'compute.googleapis.com' |
parent |
A reference to the resource this Lien is attached to. The server will validate the parent against those for which Liens are supported. Example: |
reason |
Concise user-visible strings indicating why an action cannot be performed on a resource. Maximum length of 200 characters. Example: 'Holds production API key' |
restrictions[] |
The types of operations which should be blocked as a result of this Lien. Each value should correspond to an IAM permission. The server will validate the permissions against those for which Liens are supported. An empty list is meaningless and will be rejected. Example: ['resourcemanager.projects.delete'] |
ListFoldersResponse
The ListFolders response message.Fields | |
---|---|
folders[] |
A possibly paginated list of folders that are direct descendants of the specified parent resource. |
nextPageToken |
A pagination token returned from a previous call to |
ListLiensResponse
The response message for Liens.ListLiens.Fields | |
---|---|
liens[] |
A list of Liens. |
nextPageToken |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListProjectsResponse
A page of the response received from the ListProjects method. A paginated response where more pages are available hasnext_page_token
set. This token can be used in a subsequent request to retrieve the next request page. NOTE: A response may contain fewer elements than the request page_size
and still have a next_page_token
.
Fields | |
---|---|
nextPageToken |
Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the |
projects[] |
The list of Projects under the parent. This list can be paginated. |
ListTagBindingsResponse
The ListTagBindings response.Fields | |
---|---|
nextPageToken |
Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the |
tagBindings[] |
A possibly paginated list of TagBindings for the specified resource. |
ListTagKeysResponse
The ListTagKeys response message.Fields | |
---|---|
nextPageToken |
A pagination token returned from a previous call to |
tagKeys[] |
List of TagKeys that live under the specified parent in the request. |
ListTagValuesResponse
The ListTagValues response.Fields | |
---|---|
nextPageToken |
A pagination token returned from a previous call to |
tagValues[] |
A possibly paginated list of TagValues that are direct descendants of the specified parent TagKey. |
MoveFolderMetadata
Metadata pertaining to the folder move process.Fields | |
---|---|
destinationParent |
The resource name of the folder or organization to move the folder to. |
displayName |
The display name of the folder. |
sourceParent |
The resource name of the folder's parent. |
MoveFolderRequest
The MoveFolder request message.Fields | |
---|---|
destinationParent |
Required. The resource name of the folder or organization which should be the folder's new parent. Must be of the form |
MoveProjectRequest
The request sent to MoveProject method.Fields | |
---|---|
destinationParent |
Required. The new parent to move the Project under. |
Operation
This resource represents a long-running operation that is the result of a network API call.Fields | |
---|---|
done |
If the value is |
error |
The error result of the operation in case of failure or cancellation. |
metadata |
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. |
name |
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the |
response |
The normal response of the operation in case of success. If the original method returns no data on success, such as |
Organization
The root node in the resource hierarchy to which a particular entity's (a company, for example) resources belong.Fields | |
---|---|
createTime |
Output only. Timestamp when the Organization was created. |
deleteTime |
Output only. Timestamp when the Organization was requested for deletion. |
directoryCustomerId |
Immutable. The G Suite / Workspace customer id used in the Directory API. |
displayName |
Output only. A human-readable string that refers to the organization in the Google Cloud Console. This string is set by the server and cannot be changed. The string will be set to the primary domain (for example, "google.com") of the Google Workspace customer that owns the organization. |
etag |
Output only. A checksum computed by the server based on the current value of the Organization resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. |
name |
Output only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234". |
state |
Output only. The organization's current lifecycle state. |
Enum type. Can be one of the following: | |
STATE_UNSPECIFIED |
Unspecified state. This is only useful for distinguishing unset values. |
ACTIVE |
The normal and active state. |
DELETE_REQUESTED |
The organization has been marked for deletion by the user. |
updateTime |
Output only. Timestamp when the Organization was last modified. |
Policy
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. APolicy
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. 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.
Fields | |
---|---|
auditConfigs[] |
Specifies cloud audit logging configuration for this policy. |
bindings[] |
Associates a list of |
etag |
|
version |
Specifies the format of the policy. Valid values are |
Project
A project is a high-level Google Cloud entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.Fields | |
---|---|
createTime |
Output only. Creation time. |
deleteTime |
Output only. The time at which this resource was requested for deletion. |
displayName |
Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: |
etag |
Output only. A checksum computed by the server based on the current value of the Project resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. |
labels |
Optional. The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9][a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9][a-z0-9])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: |
name |
Output only. The unique resource name of the project. It is an int64 generated number prefixed by "projects/". Example: |
parent |
Optional. A reference to a parent Resource. eg., |
projectId |
Immutable. The unique, user-assigned id of the project. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: |
state |
Output only. The project lifecycle state. |
Enum type. Can be one of the following: | |
STATE_UNSPECIFIED |
Unspecified state. This is only used/useful for distinguishing unset values. |
ACTIVE |
The normal and active state. |
DELETE_REQUESTED |
The project has been marked for deletion by the user (by invoking DeleteProject) or by the system (Google Cloud Platform). This can generally be reversed by invoking UndeleteProject. |
updateTime |
Output only. The most recent time this resource was modified. |
ProjectCreationStatus
A status object which is used as themetadata
field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed.
Fields | |
---|---|
createTime |
Creation time of the project creation workflow. |
gettable |
True if the project can be retrieved using GetProject. No other operations on the project are guaranteed to work until the project creation is complete. |
ready |
True if the project creation process is complete. |
SearchFoldersResponse
The response message for searching folders.Fields | |
---|---|
folders[] |
A possibly paginated folder search results. the specified parent resource. |
nextPageToken |
A pagination token returned from a previous call to |
SearchOrganizationsResponse
The response returned from theSearchOrganizations
method.
Fields | |
---|---|
nextPageToken |
A pagination token to be used to retrieve the next page of results. If the result is too large to fit within the page size specified in the request, this field will be set with a token that can be used to fetch the next page of results. If this field is empty, it indicates that this response contains the last page of results. |
organizations[] |
The list of Organizations that matched the search query, possibly paginated. |
SearchProjectsResponse
A page of the response received from the SearchProjects method. A paginated response where more pages are available hasnext_page_token
set. This token can be used in a subsequent request to retrieve the next request page.
Fields | |
---|---|
nextPageToken |
Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the |
projects[] |
The list of Projects that matched the list filter query. This list can be paginated. |
SetIamPolicyRequest
Request message forSetIamPolicy
method.
Fields | |
---|---|
policy |
REQUIRED: The complete policy to be applied to the |
updateMask |
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: |
Status
TheStatus
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by 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.
Fields | |
---|---|
code |
The status code, which should be an enum value of google.rpc.Code. |
details[] |
A list of messages that carry the error details. There is a common set of message types for APIs to use. |
message |
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. |
TagBinding
A TagBinding represents a connection between a TagValue and a cloud resource (currently project, folder, or organization). Once a TagBinding is created, the TagValue is applied to all the descendants of the cloud resource.Fields | |
---|---|
name |
Output only. The name of the TagBinding. This is a String of the form: |
parent |
The full resource name of the resource the TagValue is bound to. E.g. |
tagValue |
The TagValue of the TagBinding. Must be of the form |
TagKey
A TagKey, used to group a set of TagValues.Fields | |
---|---|
createTime |
Output only. Creation time. |
description |
Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write. |
etag |
Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details. |
name |
Immutable. The resource name for a TagKey. Must be in the format |
namespacedName |
Output only. Immutable. Namespaced name of the TagKey. |
parent |
Immutable. The resource name of the new TagKey's parent. Must be of the form |
shortName |
Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. |
updateTime |
Output only. Update time. |
TagValue
A TagValue is a child of a particular TagKey. This is used to group cloud resources for the purpose of controlling them using policies.Fields | |
---|---|
createTime |
Output only. Creation time. |
description |
Optional. User-assigned description of the TagValue. Must not exceed 256 characters. Read-write. |
etag |
Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagValueRequest for details. |
name |
Immutable. Resource name for TagValue in the format |
namespacedName |
Output only. Namespaced name of the TagValue. Must be in the format |
parent |
Immutable. The resource name of the new TagValue's parent TagKey. Must be of the form |
shortName |
Required. Immutable. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey. The short name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. |
updateTime |
Output only. Update time. |
TestIamPermissionsRequest
Request message forTestIamPermissions
method.
Fields | |
---|---|
permissions[] |
The set of permissions to check for the |
TestIamPermissionsResponse
Response message forTestIamPermissions
method.
Fields | |
---|---|
permissions[] |
A subset of |