xref: /aosp_15_r20/external/googleapis/google/iam/v1/options.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2022 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.iam.v1;
18
19option cc_enable_arenas = true;
20option csharp_namespace = "Google.Cloud.Iam.V1";
21option go_package = "cloud.google.com/go/iam/apiv1/iampb;iampb";
22option java_multiple_files = true;
23option java_outer_classname = "OptionsProto";
24option java_package = "com.google.iam.v1";
25option php_namespace = "Google\\Cloud\\Iam\\V1";
26
27// Encapsulates settings provided to GetIamPolicy.
28message GetPolicyOptions {
29  // Optional. The maximum policy version that will be used to format the
30  // policy.
31  //
32  // Valid values are 0, 1, and 3. Requests specifying an invalid value will be
33  // rejected.
34  //
35  // Requests for policies with any conditional role bindings must specify
36  // version 3. Policies with no conditional role bindings may specify any valid
37  // value or leave the field unset.
38  //
39  // The policy in the response might use the policy version that you specified,
40  // or it might use a lower policy version. For example, if you specify version
41  // 3, but the policy has no conditional role bindings, the response uses
42  // version 1.
43  //
44  // To learn which resources support conditions in their IAM policies, see the
45  // [IAM
46  // documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
47  int32 requested_policy_version = 1;
48}
49