{ "name": "iam", "fullyEncodeReservedExpansion": true, "documentationLink": "https://cloud.google.com/iam/", "revision": "20260423", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "batchPath": "batch", "ownerDomain": "google.com", "rootUrl": "https://iam.googleapis.com/", "id": "iam:v3", "mtlsRootUrl": "https://iam.mtls.googleapis.com/", "schemas": { "GoogleLongrunningOperation": { "id": "GoogleLongrunningOperation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "metadata": { "description": "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.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "done": { "description": "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.", "type": "boolean" }, "name": { "type": "string", "description": "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}`." }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" } } }, "GoogleIamV3PrincipalAccessBoundaryPolicyRule": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional. The description of the principal access boundary policy rule. Must be less than or equal to 256 characters." }, "resources": { "type": "array", "description": "Required. A list of Resource Manager resources. If a resource is listed in the rule, then the rule applies for that resource and its descendants. The number of resources in a policy is limited to 500 across all rules in the policy. The following resource types are supported: * Organizations, such as `//cloudresourcemanager.googleapis.com/organizations/123`. * Folders, such as `//cloudresourcemanager.googleapis.com/folders/123`. * Projects, such as `//cloudresourcemanager.googleapis.com/projects/123` or `//cloudresourcemanager.googleapis.com/projects/my-project-id`.", "items": { "type": "string" } }, "effect": { "enumDescriptions": [ "Effect unspecified.", "Allows access to the resources in this rule." ], "type": "string", "description": "Required. The access relationship of principals to the resources in this rule.", "enum": [ "EFFECT_UNSPECIFIED", "ALLOW" ] } }, "id": "GoogleIamV3PrincipalAccessBoundaryPolicyRule", "description": "Principal access boundary policy rule that defines the resource boundary." }, "GoogleIamAdminV1AuditDataPermissionDelta": { "type": "object", "properties": { "addedPermissions": { "items": { "type": "string" }, "description": "Added permissions.", "type": "array" }, "removedPermissions": { "type": "array", "description": "Removed permissions.", "items": { "type": "string" } } }, "id": "GoogleIamAdminV1AuditDataPermissionDelta", "description": "A PermissionDelta message to record the added_permissions and removed_permissions inside a role." }, "GoogleTypeExpr": { "id": "GoogleTypeExpr", "description": "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() \u003c 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.", "type": "object", "properties": { "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "title": { "type": "string", "description": "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." }, "location": { "type": "string", "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file." }, "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" } } }, "GoogleRpcStatus": { "id": "GoogleRpcStatus", "description": "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).", "type": "object", "properties": { "code": { "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32" }, "message": { "description": "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.", "type": "string" }, "details": { "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "type": "array", "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." } } }, "GoogleIamV3ListPolicyBindingsResponse": { "id": "GoogleIamV3ListPolicyBindingsResponse", "description": "Response message for ListPolicyBindings method.", "type": "object", "properties": { "nextPageToken": { "description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "policyBindings": { "items": { "$ref": "GoogleIamV3PolicyBinding" }, "description": "The policy bindings from the specified parent.", "type": "array" } } }, "GoogleIamV3PolicyBindingTarget": { "id": "GoogleIamV3PolicyBindingTarget", "description": "The full resource name of the resource to which the policy will be bound. Immutable once set.", "type": "object", "properties": { "principalSet": { "description": "Immutable. The full resource name that's used for principal access boundary policy bindings. The principal set must be directly parented by the policy binding's parent or same as the parent if the target is a project, folder, or organization. Examples: * For bindings parented by an organization: * Organization: `//cloudresourcemanager.googleapis.com/organizations/ORGANIZATION_ID` * Workforce Identity: `//iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID` * Workspace Identity: `//iam.googleapis.com/locations/global/workspace/WORKSPACE_ID` * For bindings parented by a folder: * Folder: `//cloudresourcemanager.googleapis.com/folders/FOLDER_ID` * For bindings parented by a project: * Project: * `//cloudresourcemanager.googleapis.com/projects/PROJECT_NUMBER` * `//cloudresourcemanager.googleapis.com/projects/PROJECT_ID` * Workload Identity Pool: `//iam.googleapis.com/projects/PROJECT_NUMBER/locations/LOCATION/workloadIdentityPools/WORKLOAD_POOL_ID`", "type": "string" } } }, "GoogleIamV3PolicyBinding": { "id": "GoogleIamV3PolicyBinding", "description": "IAM policy binding resource.", "type": "object", "properties": { "displayName": { "type": "string", "description": "Optional. The description of the policy binding. Must be less than or equal to 63 characters." }, "condition": { "description": "Optional. The condition to apply to the policy binding. When set, the `expression` field in the `Expr` must include from 1 to 10 subexpressions, joined by the \"||\"(Logical OR), \"&&\"(Logical AND) or \"!\"(Logical NOT) operators and cannot contain more than 250 characters. The condition is currently only supported when bound to policies of kind principal access boundary. When the bound policy is a principal access boundary policy, the only supported attributes in any subexpression are `principal.type` and `principal.subject`. An example expression is: \"principal.type == 'iam.googleapis.com/ServiceAccount'\" or \"principal.subject == 'bob@example.com'\". Allowed operations for `principal.subject`: - `principal.subject == ` - `principal.subject != ` - `principal.subject in []` - `principal.subject.startsWith()` - `principal.subject.endsWith()` Allowed operations for `principal.type`: - `principal.type == ` - `principal.type != ` - `principal.type in []` Supported principal types are workspace, workforce pool, workload pool, service account, and Agent Identity. Allowed string must be one of: - `iam.googleapis.com/WorkspaceIdentity` - `iam.googleapis.com/WorkforcePoolIdentity` - `iam.googleapis.com/WorkloadPoolIdentity` - `iam.googleapis.com/ServiceAccount` - `iam.googleapis.com/AgentPoolIdentity` (available in Preview)", "$ref": "GoogleTypeExpr" }, "etag": { "description": "Optional. The etag for the policy binding. If this is provided on update, it must match the server's etag.", "type": "string" }, "policyUid": { "readOnly": true, "description": "Output only. The globally unique ID of the policy to be bound.", "type": "string" }, "annotations": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. User-defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations" }, "name": { "description": "Identifier. The name of the policy binding, in the format `{binding_parent/locations/{location}/policyBindings/{policy_binding_id}`. The binding parent is the closest Resource Manager resource (project, folder, or organization) to the binding target. Format: * `projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}` * `projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}` * `folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}` * `organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}`", "type": "string" }, "target": { "description": "Required. Immutable. The full resource name of the resource to which the policy will be bound. Immutable once set.", "$ref": "GoogleIamV3PolicyBindingTarget" }, "policyKind": { "type": "string", "description": "Immutable. The kind of the policy to attach in this binding. This field must be one of the following: - Left empty (will be automatically set to the policy kind) - The input policy kind", "enum": [ "POLICY_KIND_UNSPECIFIED", "PRINCIPAL_ACCESS_BOUNDARY" ], "enumDescriptions": [ "Unspecified policy kind; Not a valid state", "Principal access boundary policy kind" ] }, "updateTime": { "type": "string", "description": "Output only. The time when the policy binding was most recently updated.", "format": "google-datetime", "readOnly": true }, "policy": { "description": "Required. Immutable. The resource name of the policy to be bound. The binding parent and policy must belong to the same organization.", "type": "string" }, "uid": { "description": "Output only. The globally unique ID of the policy binding. Assigned when the policy binding is created.", "type": "string", "readOnly": true }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. The time when the policy binding was created.", "format": "google-datetime" } } }, "GoogleIamV3SearchTargetPolicyBindingsResponse": { "type": "object", "properties": { "policyBindings": { "items": { "$ref": "GoogleIamV3PolicyBinding" }, "type": "array", "description": "The policy bindings bound to the specified target." }, "nextPageToken": { "description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleIamV3SearchTargetPolicyBindingsResponse", "description": "Response message for SearchTargetPolicyBindings method." }, "GoogleIamV3PrincipalAccessBoundaryPolicyDetails": { "id": "GoogleIamV3PrincipalAccessBoundaryPolicyDetails", "description": "Principal access boundary policy details", "type": "object", "properties": { "rules": { "items": { "$ref": "GoogleIamV3PrincipalAccessBoundaryPolicyRule" }, "type": "array", "description": "Required. A list of principal access boundary policy rules. The number of rules in a policy is limited to 500." }, "enforcementVersion": { "description": "Optional. The version number (for example, `1` or `latest`) that indicates which permissions are able to be blocked by the policy. If empty, the PAB policy version will be set to the most recent version number at the time of the policy's creation.", "type": "string" } } }, "GoogleIamV3PrincipalAccessBoundaryPolicy": { "type": "object", "properties": { "uid": { "description": "Output only. The globally unique ID of the principal access boundary policy.", "type": "string", "readOnly": true }, "annotations": { "description": "Optional. User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations", "type": "object", "additionalProperties": { "type": "string" } }, "createTime": { "description": "Output only. The time when the principal access boundary policy was created.", "format": "google-datetime", "type": "string", "readOnly": true }, "details": { "description": "Optional. The details for the principal access boundary policy.", "$ref": "GoogleIamV3PrincipalAccessBoundaryPolicyDetails" }, "updateTime": { "readOnly": true, "type": "string", "description": "Output only. The time when the principal access boundary policy was most recently updated.", "format": "google-datetime" }, "name": { "description": "Identifier. The resource name of the principal access boundary policy. The following format is supported: `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}`", "type": "string" }, "etag": { "description": "Optional. The etag for the principal access boundary. If this is provided on update, it must match the server's etag.", "type": "string" }, "displayName": { "description": "Optional. The description of the principal access boundary policy. Must be less than or equal to 63 characters.", "type": "string" } }, "id": "GoogleIamV3PrincipalAccessBoundaryPolicy", "description": "An IAM principal access boundary policy resource." }, "GoogleIamV3ListPrincipalAccessBoundaryPoliciesResponse": { "id": "GoogleIamV3ListPrincipalAccessBoundaryPoliciesResponse", "description": "Response message for ListPrincipalAccessBoundaryPolicies method.", "type": "object", "properties": { "principalAccessBoundaryPolicies": { "type": "array", "description": "The principal access boundary policies from the specified parent.", "items": { "$ref": "GoogleIamV3PrincipalAccessBoundaryPolicy" } }, "nextPageToken": { "type": "string", "description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } } }, "GoogleIamV3SearchPrincipalAccessBoundaryPolicyBindingsResponse": { "type": "object", "properties": { "policyBindings": { "items": { "$ref": "GoogleIamV3PolicyBinding" }, "type": "array", "description": "The policy bindings that reference the specified policy." }, "nextPageToken": { "type": "string", "description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } }, "id": "GoogleIamV3SearchPrincipalAccessBoundaryPolicyBindingsResponse", "description": "Response message for SearchPrincipalAccessBoundaryPolicyBindings rpc." }, "GoogleIamAdminV1AuditData": { "id": "GoogleIamAdminV1AuditData", "description": "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.", "type": "object", "properties": { "permissionDelta": { "description": "The permission_delta when when creating or updating a Role.", "$ref": "GoogleIamAdminV1AuditDataPermissionDelta" } } }, "GoogleIamV3OperationMetadata": { "type": "object", "properties": { "target": { "readOnly": true, "description": "Output only. Server-defined resource path for the target of the", "type": "string" }, "statusMessage": { "readOnly": true, "description": "Output only. Human-readable status of the operation, if any.", "type": "string" }, "requestedCancellation": { "readOnly": true, "type": "boolean", "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`." }, "endTime": { "description": "Output only. The time the operation finished running.", "format": "google-datetime", "type": "string", "readOnly": true }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "type": "string", "readOnly": true }, "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", "type": "string", "readOnly": true }, "apiVersion": { "description": "Output only. API version used to start the operation.", "type": "string", "readOnly": true } }, "id": "GoogleIamV3OperationMetadata", "description": "Represents the metadata of the long-running operation." } }, "protocol": "rest", "parameters": { "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "quotaUser": { "location": "query", "description": "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.", "type": "string" }, "$.xgafv": { "location": "query", "description": "V1 error format.", "enum": [ "1", "2" ], "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "callback": { "location": "query", "type": "string", "description": "JSONP" }, "key": { "location": "query", "type": "string", "description": "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." }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "location": "query", "default": "true", "description": "Returns response with indentations and line breaks.", "type": "boolean" }, "alt": { "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "default": "json", "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "type": "string", "location": "query" } }, "basePath": "", "discoveryVersion": "v1", "ownerName": "Google", "baseUrl": "https://iam.googleapis.com/", "resources": { "folders": { "resources": { "locations": { "resources": { "operations": { "methods": { "get": { "parameters": { "name": { "required": true, "description": "The name of the operation resource.", "type": "string", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "httpMethod": "GET", "id": "iam.folders.locations.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v3/{+name}", "flatPath": "v3/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}" } } }, "policyBindings": { "methods": { "list": { "parameters": { "pageSize": { "description": "Optional. The maximum number of policy bindings to return. The service may return fewer than this value. The default value is 50. The maximum value is 1000.", "format": "int32", "type": "integer", "location": "query" }, "filter": { "type": "string", "description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. Some eligible fields for filtering are the following: + `target` + `policy` Some examples of filter queries: * `target:ex*`: The binding target's name starts with \"ex\". * `target:example`: The binding target's name is `example`. * `policy:example`: The binding policy's name is `example`.", "location": "query" }, "parent": { "required": true, "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Required. The parent resource, which owns the collection of policy bindings. Format: * `projects/{project_id}/locations/{location}` * `projects/{project_number}/locations/{location}` * `folders/{folder_id}/locations/{location}` * `organizations/{organization_id}/locations/{location}`" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListPolicyBindings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPolicyBindings` must match the call that provided the page token.", "type": "string", "location": "query" } }, "id": "iam.folders.locations.policyBindings.list", "description": "Lists policy bindings.", "httpMethod": "GET", "path": "v3/{+parent}/policyBindings", "flatPath": "v3/folders/{foldersId}/locations/{locationsId}/policyBindings", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleIamV3ListPolicyBindingsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "searchTargetPolicyBindings": { "path": "v3/{+parent}/policyBindings:searchTargetPolicyBindings", "flatPath": "v3/folders/{foldersId}/locations/{locationsId}/policyBindings:searchTargetPolicyBindings", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleIamV3SearchTargetPolicyBindingsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "iam.folders.locations.policyBindings.searchTargetPolicyBindings", "description": "Search policy bindings by target. Returns all policy binding objects bound directly to target.", "httpMethod": "GET", "parameters": { "pageSize": { "description": "Optional. The maximum number of policy bindings to return. The service may return fewer than this value. The default value is 50. The maximum value is 1000.", "format": "int32", "type": "integer", "location": "query" }, "target": { "description": "Required. The target resource, which is bound to the policy in the binding. Format: * `//iam.googleapis.com/locations/global/workforcePools/POOL_ID` * `//iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID` * `//iam.googleapis.com/locations/global/workspace/WORKSPACE_ID` * `//cloudresourcemanager.googleapis.com/projects/{project_number}` * `//cloudresourcemanager.googleapis.com/folders/{folder_id}` * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}`", "type": "string", "location": "query" }, "pageToken": { "description": "Optional. A page token, received from a previous `SearchTargetPolicyBindingsRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchTargetPolicyBindingsRequest` must match the call that provided the page token.", "type": "string", "location": "query" }, "parent": { "type": "string", "description": "Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target. Format: * `projects/{project_id}/locations/{location}` * `projects/{project_number}/locations/{location}` * `folders/{folder_id}/locations/{location}` * `organizations/{organization_id}/locations/{location}`", "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "required": true } } }, "create": { "parameters": { "validateOnly": { "description": "Optional. If set, validate the request and preview the creation, but do not actually post it.", "type": "boolean", "location": "query" }, "parent": { "required": true, "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Required. The parent resource where this policy binding will be created. The binding parent is the closest Resource Manager resource (project, folder or organization) to the binding target. Format: * `projects/{project_id}/locations/{location}` * `projects/{project_number}/locations/{location}` * `folders/{folder_id}/locations/{location}` * `organizations/{organization_id}/locations/{location}`" }, "policyBindingId": { "location": "query", "type": "string", "description": "Required. The ID to use for the policy binding, which will become the final component of the policy binding's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/." } }, "id": "iam.folders.locations.policyBindings.create", "description": "Creates a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. After the binding is created, the policy is applied to the target.", "httpMethod": "POST", "request": { "$ref": "GoogleIamV3PolicyBinding" }, "path": "v3/{+parent}/policyBindings", "flatPath": "v3/folders/{foldersId}/locations/{locationsId}/policyBindings", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "parameters": { "etag": { "type": "string", "description": "Optional. The etag of the policy binding. If this is provided, it must match the server's etag.", "location": "query" }, "name": { "required": true, "type": "string", "description": "Required. The name of the policy binding to delete. Format: * `projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}` * `projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}` * `folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}` * `organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}`", "pattern": "^folders/[^/]+/locations/[^/]+/policyBindings/[^/]+$", "location": "path" }, "validateOnly": { "location": "query", "type": "boolean", "description": "Optional. If set, validate the request and preview the deletion, but do not actually post it." } }, "id": "iam.folders.locations.policyBindings.delete", "description": "Deletes a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. After the binding is deleted, the policy no longer applies to the target.", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v3/{+name}", "flatPath": "v3/folders/{foldersId}/locations/{locationsId}/policyBindings/{policyBindingsId}" }, "patch": { "path": "v3/{+name}", "flatPath": "v3/folders/{foldersId}/locations/{locationsId}/policyBindings/{policyBindingsId}", "request": { "$ref": "GoogleIamV3PolicyBinding" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/policyBindings/[^/]+$", "description": "Identifier. The name of the policy binding, in the format `{binding_parent/locations/{location}/policyBindings/{policy_binding_id}`. The binding parent is the closest Resource Manager resource (project, folder, or organization) to the binding target. Format: * `projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}` * `projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}` * `folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}` * `organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}`", "type": "string", "required": true }, "validateOnly": { "location": "query", "description": "Optional. If set, validate the request and preview the update, but do not actually post it.", "type": "boolean" }, "updateMask": { "type": "string", "description": "Optional. The list of fields to update", "format": "google-fieldmask", "location": "query" } }, "httpMethod": "PATCH", "id": "iam.folders.locations.policyBindings.patch", "description": "Updates a policy binding and returns a long-running operation. Callers will need the IAM permissions on the policy and target in the binding to update. Target and policy are immutable and cannot be updated." }, "get": { "path": "v3/{+name}", "flatPath": "v3/folders/{foldersId}/locations/{locationsId}/policyBindings/{policyBindingsId}", "response": { "$ref": "GoogleIamV3PolicyBinding" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "GET", "id": "iam.folders.locations.policyBindings.get", "description": "Gets a policy binding.", "parameters": { "name": { "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/policyBindings/[^/]+$", "description": "Required. The name of the policy binding to retrieve. Format: * `projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}` * `projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}` * `folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}` * `organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}`", "type": "string", "required": true } } } } } } } } }, "organizations": { "resources": { "locations": { "resources": { "operations": { "methods": { "get": { "path": "v3/{+name}", "flatPath": "v3/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource." } }, "id": "iam.organizations.locations.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "httpMethod": "GET" } } }, "policyBindings": { "methods": { "list": { "parameters": { "pageSize": { "type": "integer", "description": "Optional. The maximum number of policy bindings to return. The service may return fewer than this value. The default value is 50. The maximum value is 1000.", "format": "int32", "location": "query" }, "filter": { "type": "string", "description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. Some eligible fields for filtering are the following: + `target` + `policy` Some examples of filter queries: * `target:ex*`: The binding target's name starts with \"ex\". * `target:example`: The binding target's name is `example`. * `policy:example`: The binding policy's name is `example`.", "location": "query" }, "parent": { "description": "Required. The parent resource, which owns the collection of policy bindings. Format: * `projects/{project_id}/locations/{location}` * `projects/{project_number}/locations/{location}` * `folders/{folder_id}/locations/{location}` * `organizations/{organization_id}/locations/{location}`", "type": "string", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true }, "pageToken": { "location": "query", "description": "Optional. A page token, received from a previous `ListPolicyBindings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPolicyBindings` must match the call that provided the page token.", "type": "string" } }, "httpMethod": "GET", "id": "iam.organizations.locations.policyBindings.list", "description": "Lists policy bindings.", "path": "v3/{+parent}/policyBindings", "flatPath": "v3/organizations/{organizationsId}/locations/{locationsId}/policyBindings", "response": { "$ref": "GoogleIamV3ListPolicyBindingsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] }, "searchTargetPolicyBindings": { "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleIamV3SearchTargetPolicyBindingsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v3/{+parent}/policyBindings:searchTargetPolicyBindings", "flatPath": "v3/organizations/{organizationsId}/locations/{locationsId}/policyBindings:searchTargetPolicyBindings", "parameters": { "parent": { "required": true, "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "description": "Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target. Format: * `projects/{project_id}/locations/{location}` * `projects/{project_number}/locations/{location}` * `folders/{folder_id}/locations/{location}` * `organizations/{organization_id}/locations/{location}`", "type": "string" }, "target": { "description": "Required. The target resource, which is bound to the policy in the binding. Format: * `//iam.googleapis.com/locations/global/workforcePools/POOL_ID` * `//iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID` * `//iam.googleapis.com/locations/global/workspace/WORKSPACE_ID` * `//cloudresourcemanager.googleapis.com/projects/{project_number}` * `//cloudresourcemanager.googleapis.com/folders/{folder_id}` * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}`", "type": "string", "location": "query" }, "pageToken": { "location": "query", "description": "Optional. A page token, received from a previous `SearchTargetPolicyBindingsRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchTargetPolicyBindingsRequest` must match the call that provided the page token.", "type": "string" }, "pageSize": { "type": "integer", "description": "Optional. The maximum number of policy bindings to return. The service may return fewer than this value. The default value is 50. The maximum value is 1000.", "format": "int32", "location": "query" } }, "id": "iam.organizations.locations.policyBindings.searchTargetPolicyBindings", "description": "Search policy bindings by target. Returns all policy binding objects bound directly to target.", "httpMethod": "GET" }, "create": { "httpMethod": "POST", "id": "iam.organizations.locations.policyBindings.create", "description": "Creates a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. After the binding is created, the policy is applied to the target.", "parameters": { "parent": { "type": "string", "description": "Required. The parent resource where this policy binding will be created. The binding parent is the closest Resource Manager resource (project, folder or organization) to the binding target. Format: * `projects/{project_id}/locations/{location}` * `projects/{project_number}/locations/{location}` * `folders/{folder_id}/locations/{location}` * `organizations/{organization_id}/locations/{location}`", "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "required": true }, "policyBindingId": { "type": "string", "description": "Required. The ID to use for the policy binding, which will become the final component of the policy binding's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.", "location": "query" }, "validateOnly": { "type": "boolean", "description": "Optional. If set, validate the request and preview the creation, but do not actually post it.", "location": "query" } }, "path": "v3/{+parent}/policyBindings", "flatPath": "v3/organizations/{organizationsId}/locations/{locationsId}/policyBindings", "request": { "$ref": "GoogleIamV3PolicyBinding" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] }, "delete": { "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v3/{+name}", "flatPath": "v3/organizations/{organizationsId}/locations/{locationsId}/policyBindings/{policyBindingsId}", "httpMethod": "DELETE", "id": "iam.organizations.locations.policyBindings.delete", "description": "Deletes a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. After the binding is deleted, the policy no longer applies to the target.", "parameters": { "etag": { "location": "query", "type": "string", "description": "Optional. The etag of the policy binding. If this is provided, it must match the server's etag." }, "name": { "required": true, "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/policyBindings/[^/]+$", "description": "Required. The name of the policy binding to delete. Format: * `projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}` * `projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}` * `folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}` * `organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}`", "type": "string" }, "validateOnly": { "location": "query", "description": "Optional. If set, validate the request and preview the deletion, but do not actually post it.", "type": "boolean" } } }, "patch": { "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v3/{+name}", "flatPath": "v3/organizations/{organizationsId}/locations/{locationsId}/policyBindings/{policyBindingsId}", "request": { "$ref": "GoogleIamV3PolicyBinding" }, "httpMethod": "PATCH", "id": "iam.organizations.locations.policyBindings.patch", "description": "Updates a policy binding and returns a long-running operation. Callers will need the IAM permissions on the policy and target in the binding to update. Target and policy are immutable and cannot be updated.", "parameters": { "updateMask": { "description": "Optional. The list of fields to update", "format": "google-fieldmask", "type": "string", "location": "query" }, "name": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/policyBindings/[^/]+$", "location": "path", "type": "string", "description": "Identifier. The name of the policy binding, in the format `{binding_parent/locations/{location}/policyBindings/{policy_binding_id}`. The binding parent is the closest Resource Manager resource (project, folder, or organization) to the binding target. Format: * `projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}` * `projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}` * `folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}` * `organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}`" }, "validateOnly": { "type": "boolean", "description": "Optional. If set, validate the request and preview the update, but do not actually post it.", "location": "query" } } }, "get": { "response": { "$ref": "GoogleIamV3PolicyBinding" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v3/{+name}", "flatPath": "v3/organizations/{organizationsId}/locations/{locationsId}/policyBindings/{policyBindingsId}", "parameters": { "name": { "required": true, "description": "Required. The name of the policy binding to retrieve. Format: * `projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}` * `projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}` * `folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}` * `organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}`", "type": "string", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/policyBindings/[^/]+$" } }, "httpMethod": "GET", "id": "iam.organizations.locations.policyBindings.get", "description": "Gets a policy binding." } } }, "principalAccessBoundaryPolicies": { "methods": { "delete": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v3/{+name}", "flatPath": "v3/organizations/{organizationsId}/locations/{locationsId}/principalAccessBoundaryPolicies/{principalAccessBoundaryPoliciesId}", "parameters": { "etag": { "type": "string", "description": "Optional. The etag of the principal access boundary policy. If this is provided, it must match the server's etag.", "location": "query" }, "force": { "description": "Optional. If set to true, the request will force the deletion of the policy even if the policy is referenced in policy bindings.", "type": "boolean", "location": "query" }, "name": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/principalAccessBoundaryPolicies/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the principal access boundary policy to delete. Format: `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}`" }, "validateOnly": { "type": "boolean", "description": "Optional. If set, validate the request and preview the deletion, but do not actually post it.", "location": "query" } }, "id": "iam.organizations.locations.principalAccessBoundaryPolicies.delete", "description": "Deletes a principal access boundary policy.", "httpMethod": "DELETE" }, "patch": { "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v3/{+name}", "flatPath": "v3/organizations/{organizationsId}/locations/{locationsId}/principalAccessBoundaryPolicies/{principalAccessBoundaryPoliciesId}", "request": { "$ref": "GoogleIamV3PrincipalAccessBoundaryPolicy" }, "parameters": { "updateMask": { "type": "string", "description": "Optional. The list of fields to update", "format": "google-fieldmask", "location": "query" }, "name": { "type": "string", "description": "Identifier. The resource name of the principal access boundary policy. The following format is supported: `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}`", "pattern": "^organizations/[^/]+/locations/[^/]+/principalAccessBoundaryPolicies/[^/]+$", "location": "path", "required": true }, "validateOnly": { "location": "query", "type": "boolean", "description": "Optional. If set, validate the request and preview the update, but do not actually post it." } }, "httpMethod": "PATCH", "id": "iam.organizations.locations.principalAccessBoundaryPolicies.patch", "description": "Updates a principal access boundary policy." }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleIamV3PrincipalAccessBoundaryPolicy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v3/{+name}", "flatPath": "v3/organizations/{organizationsId}/locations/{locationsId}/principalAccessBoundaryPolicies/{principalAccessBoundaryPoliciesId}", "parameters": { "name": { "required": true, "description": "Required. The name of the principal access boundary policy to retrieve. Format: `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}`", "type": "string", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/principalAccessBoundaryPolicies/[^/]+$" } }, "id": "iam.organizations.locations.principalAccessBoundaryPolicies.get", "description": "Gets a principal access boundary policy.", "httpMethod": "GET" }, "searchPolicyBindings": { "response": { "$ref": "GoogleIamV3SearchPrincipalAccessBoundaryPolicyBindingsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v3/{+name}:searchPolicyBindings", "flatPath": "v3/organizations/{organizationsId}/locations/{locationsId}/principalAccessBoundaryPolicies/{principalAccessBoundaryPoliciesId}:searchPolicyBindings", "httpMethod": "GET", "id": "iam.organizations.locations.principalAccessBoundaryPolicies.searchPolicyBindings", "description": "Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that policy.", "parameters": { "pageSize": { "location": "query", "description": "Optional. The maximum number of policy bindings to return. The service may return fewer than this value. If unspecified, at most 50 policy bindings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "type": "integer" }, "name": { "required": true, "type": "string", "description": "Required. The name of the principal access boundary policy. Format: `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}`", "pattern": "^organizations/[^/]+/locations/[^/]+/principalAccessBoundaryPolicies/[^/]+$", "location": "path" }, "pageToken": { "type": "string", "description": "Optional. A page token, received from a previous `SearchPrincipalAccessBoundaryPolicyBindingsRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchPrincipalAccessBoundaryPolicyBindingsRequest` must match the call that provided the page token.", "location": "query" } } }, "list": { "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleIamV3ListPrincipalAccessBoundaryPoliciesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v3/{+parent}/principalAccessBoundaryPolicies", "flatPath": "v3/organizations/{organizationsId}/locations/{locationsId}/principalAccessBoundaryPolicies", "id": "iam.organizations.locations.principalAccessBoundaryPolicies.list", "description": "Lists principal access boundary policies.", "httpMethod": "GET", "parameters": { "pageSize": { "type": "integer", "description": "Optional. The maximum number of principal access boundary policies to return. The service may return fewer than this value. If unspecified, at most 50 principal access boundary policies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query" }, "parent": { "description": "Required. The parent resource, which owns the collection of principal access boundary policies. Format: `organizations/{organization_id}/locations/{location}`", "type": "string", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A page token, received from a previous `ListPrincipalAccessBoundaryPolicies` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPrincipalAccessBoundaryPolicies` must match the call that provided the page token." } } }, "create": { "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "path": "v3/{+parent}/principalAccessBoundaryPolicies", "flatPath": "v3/organizations/{organizationsId}/locations/{locationsId}/principalAccessBoundaryPolicies", "request": { "$ref": "GoogleIamV3PrincipalAccessBoundaryPolicy" }, "httpMethod": "POST", "id": "iam.organizations.locations.principalAccessBoundaryPolicies.create", "description": "Creates a principal access boundary policy, and returns a long running operation.", "parameters": { "validateOnly": { "location": "query", "type": "boolean", "description": "Optional. If set, validate the request and preview the creation, but do not actually post it." }, "parent": { "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Required. The parent resource where this principal access boundary policy will be created. Only organizations are supported. Format: `organizations/{organization_id}/locations/{location}`", "required": true }, "principalAccessBoundaryPolicyId": { "type": "string", "description": "Required. The ID to use for the principal access boundary policy, which will become the final component of the principal access boundary policy's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.", "location": "query" } } } } } } } } }, "projects": { "resources": { "locations": { "resources": { "operations": { "methods": { "get": { "path": "v3/{+name}", "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "iam.projects.locations.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "httpMethod": "GET", "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path" } } } } }, "policyBindings": { "methods": { "patch": { "id": "iam.projects.locations.policyBindings.patch", "description": "Updates a policy binding and returns a long-running operation. Callers will need the IAM permissions on the policy and target in the binding to update. Target and policy are immutable and cannot be updated.", "httpMethod": "PATCH", "parameters": { "updateMask": { "description": "Optional. The list of fields to update", "format": "google-fieldmask", "type": "string", "location": "query" }, "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/policyBindings/[^/]+$", "location": "path", "type": "string", "description": "Identifier. The name of the policy binding, in the format `{binding_parent/locations/{location}/policyBindings/{policy_binding_id}`. The binding parent is the closest Resource Manager resource (project, folder, or organization) to the binding target. Format: * `projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}` * `projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}` * `folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}` * `organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}`" }, "validateOnly": { "location": "query", "type": "boolean", "description": "Optional. If set, validate the request and preview the update, but do not actually post it." } }, "request": { "$ref": "GoogleIamV3PolicyBinding" }, "path": "v3/{+name}", "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/policyBindings/{policyBindingsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v3/{+name}", "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/policyBindings/{policyBindingsId}", "parameters": { "etag": { "type": "string", "description": "Optional. The etag of the policy binding. If this is provided, it must match the server's etag.", "location": "query" }, "name": { "required": true, "type": "string", "description": "Required. The name of the policy binding to delete. Format: * `projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}` * `projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}` * `folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}` * `organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/policyBindings/[^/]+$", "location": "path" }, "validateOnly": { "location": "query", "type": "boolean", "description": "Optional. If set, validate the request and preview the deletion, but do not actually post it." } }, "httpMethod": "DELETE", "id": "iam.projects.locations.policyBindings.delete", "description": "Deletes a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. After the binding is deleted, the policy no longer applies to the target." }, "get": { "path": "v3/{+name}", "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/policyBindings/{policyBindingsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleIamV3PolicyBinding" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the policy binding to retrieve. Format: * `projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}` * `projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}` * `folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}` * `organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/policyBindings/[^/]+$", "location": "path" } }, "id": "iam.projects.locations.policyBindings.get", "description": "Gets a policy binding.", "httpMethod": "GET" }, "list": { "id": "iam.projects.locations.policyBindings.list", "description": "Lists policy bindings.", "httpMethod": "GET", "parameters": { "filter": { "location": "query", "type": "string", "description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. Some eligible fields for filtering are the following: + `target` + `policy` Some examples of filter queries: * `target:ex*`: The binding target's name starts with \"ex\". * `target:example`: The binding target's name is `example`. * `policy:example`: The binding policy's name is `example`." }, "pageSize": { "location": "query", "type": "integer", "description": "Optional. The maximum number of policy bindings to return. The service may return fewer than this value. The default value is 50. The maximum value is 1000.", "format": "int32" }, "pageToken": { "location": "query", "description": "Optional. A page token, received from a previous `ListPolicyBindings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPolicyBindings` must match the call that provided the page token.", "type": "string" }, "parent": { "required": true, "type": "string", "description": "Required. The parent resource, which owns the collection of policy bindings. Format: * `projects/{project_id}/locations/{location}` * `projects/{project_number}/locations/{location}` * `folders/{folder_id}/locations/{location}` * `organizations/{organization_id}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } }, "path": "v3/{+parent}/policyBindings", "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/policyBindings", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleIamV3ListPolicyBindingsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "searchTargetPolicyBindings": { "id": "iam.projects.locations.policyBindings.searchTargetPolicyBindings", "description": "Search policy bindings by target. Returns all policy binding objects bound directly to target.", "httpMethod": "GET", "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target. Format: * `projects/{project_id}/locations/{location}` * `projects/{project_number}/locations/{location}` * `folders/{folder_id}/locations/{location}` * `organizations/{organization_id}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "target": { "location": "query", "description": "Required. The target resource, which is bound to the policy in the binding. Format: * `//iam.googleapis.com/locations/global/workforcePools/POOL_ID` * `//iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID` * `//iam.googleapis.com/locations/global/workspace/WORKSPACE_ID` * `//cloudresourcemanager.googleapis.com/projects/{project_number}` * `//cloudresourcemanager.googleapis.com/folders/{folder_id}` * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}`", "type": "string" }, "pageToken": { "type": "string", "description": "Optional. A page token, received from a previous `SearchTargetPolicyBindingsRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchTargetPolicyBindingsRequest` must match the call that provided the page token.", "location": "query" }, "pageSize": { "location": "query", "description": "Optional. The maximum number of policy bindings to return. The service may return fewer than this value. The default value is 50. The maximum value is 1000.", "format": "int32", "type": "integer" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleIamV3SearchTargetPolicyBindingsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v3/{+parent}/policyBindings:searchTargetPolicyBindings", "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/policyBindings:searchTargetPolicyBindings" }, "create": { "id": "iam.projects.locations.policyBindings.create", "description": "Creates a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. After the binding is created, the policy is applied to the target.", "httpMethod": "POST", "parameters": { "validateOnly": { "type": "boolean", "description": "Optional. If set, validate the request and preview the creation, but do not actually post it.", "location": "query" }, "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource where this policy binding will be created. The binding parent is the closest Resource Manager resource (project, folder or organization) to the binding target. Format: * `projects/{project_id}/locations/{location}` * `projects/{project_number}/locations/{location}` * `folders/{folder_id}/locations/{location}` * `organizations/{organization_id}/locations/{location}`", "type": "string" }, "policyBindingId": { "location": "query", "description": "Required. The ID to use for the policy binding, which will become the final component of the policy binding's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.", "type": "string" } }, "request": { "$ref": "GoogleIamV3PolicyBinding" }, "path": "v3/{+parent}/policyBindings", "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/policyBindings", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } } } }, "version_module": true, "kind": "discovery#restDescription", "description": "Manages identity and access control for Google Cloud resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. Enabling this API also enables the IAM Service Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API. ", "canonicalName": "Iam", "title": "Identity and Access Management (IAM) API", "version": "v3", "servicePath": "", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" } }