Class: Google::Cloud::PolicyTroubleshooter::Iam::V3::AllowBindingExplanation

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/policytroubleshooter/iam/v3/troubleshooter.rb

Overview

Details about how a role binding in an allow policy affects a principal's ability to use a permission.

Defined Under Namespace

Classes: AnnotatedAllowMembership, MembershipsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#allow_access_state ⇒ ::Google::Cloud::PolicyTroubleshooter::Iam::V3::AllowAccessState

Returns Required. Indicates whether this role binding gives the specified permission to the specified principal on the specified resource.

This field does not indicate whether the principal actually has the permission on the resource. There might be another role binding that overrides this role binding. To determine whether the principal actually has the permission, use the overall_access_state field in the TroubleshootIamPolicyResponse.

Returns:

  • (::Google::Cloud::PolicyTroubleshooter::Iam::V3::AllowAccessState) —

    Required. Indicates whether this role binding gives the specified permission to the specified principal on the specified resource.

    This field does not indicate whether the principal actually has the permission on the resource. There might be another role binding that overrides this role binding. To determine whether the principal actually has the permission, use the overall_access_state field in the TroubleshootIamPolicyResponse.



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'proto_docs/google/cloud/policytroubleshooter/iam/v3/troubleshooter.rb', line 386

class AllowBindingExplanation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about whether the role binding includes the principal.
  # @!attribute [rw] membership
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::MembershipMatchingState]
  #     Indicates whether the role binding includes the principal.
  # @!attribute [rw] relevance
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::HeuristicRelevance]
  #     The relevance of the principal's status to the overall determination for
  #     the role binding.
  class AnnotatedAllowMembership
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::AllowBindingExplanation::AnnotatedAllowMembership]
  class MembershipsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#combined_membership ⇒ ::Google::Cloud::PolicyTroubleshooter::Iam::V3::AllowBindingExplanation::AnnotatedAllowMembership

Returns The combined result of all memberships. Indicates if the principal is included in any role binding, either directly or indirectly.

Returns:



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'proto_docs/google/cloud/policytroubleshooter/iam/v3/troubleshooter.rb', line 386

class AllowBindingExplanation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about whether the role binding includes the principal.
  # @!attribute [rw] membership
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::MembershipMatchingState]
  #     Indicates whether the role binding includes the principal.
  # @!attribute [rw] relevance
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::HeuristicRelevance]
  #     The relevance of the principal's status to the overall determination for
  #     the role binding.
  class AnnotatedAllowMembership
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::AllowBindingExplanation::AnnotatedAllowMembership]
  class MembershipsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#condition ⇒ ::Google::Type::Expr

Returns A condition expression that specifies when the role binding grants access.

To learn about IAM Conditions, see https://cloud.google.com/iam/help/conditions/overview.

Returns:



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'proto_docs/google/cloud/policytroubleshooter/iam/v3/troubleshooter.rb', line 386

class AllowBindingExplanation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about whether the role binding includes the principal.
  # @!attribute [rw] membership
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::MembershipMatchingState]
  #     Indicates whether the role binding includes the principal.
  # @!attribute [rw] relevance
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::HeuristicRelevance]
  #     The relevance of the principal's status to the overall determination for
  #     the role binding.
  class AnnotatedAllowMembership
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::AllowBindingExplanation::AnnotatedAllowMembership]
  class MembershipsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#condition_explanation ⇒ ::Google::Cloud::PolicyTroubleshooter::Iam::V3::ConditionExplanation

Returns Condition evaluation state for this role binding.

Returns:



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'proto_docs/google/cloud/policytroubleshooter/iam/v3/troubleshooter.rb', line 386

class AllowBindingExplanation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about whether the role binding includes the principal.
  # @!attribute [rw] membership
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::MembershipMatchingState]
  #     Indicates whether the role binding includes the principal.
  # @!attribute [rw] relevance
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::HeuristicRelevance]
  #     The relevance of the principal's status to the overall determination for
  #     the role binding.
  class AnnotatedAllowMembership
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::AllowBindingExplanation::AnnotatedAllowMembership]
  class MembershipsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#memberships ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::PolicyTroubleshooter::Iam::V3::AllowBindingExplanation::AnnotatedAllowMembership}

Returns Indicates whether each role binding includes the principal specified in the request, either directly or indirectly. Each key identifies a principal in the role binding, and each value indicates whether the principal in the role binding includes the principal in the request.

For example, suppose that a role binding includes the following principals:

You want to troubleshoot access for user:[email protected]. This user is a member of the group group:[email protected].

For the first principal in the role binding, the key is user:[email protected], and the membership field in the value is set to NOT_INCLUDED.

For the second principal in the role binding, the key is group:[email protected], and the membership field in the value is set to INCLUDED.

Returns:



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'proto_docs/google/cloud/policytroubleshooter/iam/v3/troubleshooter.rb', line 386

class AllowBindingExplanation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about whether the role binding includes the principal.
  # @!attribute [rw] membership
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::MembershipMatchingState]
  #     Indicates whether the role binding includes the principal.
  # @!attribute [rw] relevance
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::HeuristicRelevance]
  #     The relevance of the principal's status to the overall determination for
  #     the role binding.
  class AnnotatedAllowMembership
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::AllowBindingExplanation::AnnotatedAllowMembership]
  class MembershipsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#relevance ⇒ ::Google::Cloud::PolicyTroubleshooter::Iam::V3::HeuristicRelevance

Returns The relevance of this role binding to the overall determination for the entire policy.

Returns:



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'proto_docs/google/cloud/policytroubleshooter/iam/v3/troubleshooter.rb', line 386

class AllowBindingExplanation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about whether the role binding includes the principal.
  # @!attribute [rw] membership
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::MembershipMatchingState]
  #     Indicates whether the role binding includes the principal.
  # @!attribute [rw] relevance
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::HeuristicRelevance]
  #     The relevance of the principal's status to the overall determination for
  #     the role binding.
  class AnnotatedAllowMembership
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::AllowBindingExplanation::AnnotatedAllowMembership]
  class MembershipsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#role ⇒ ::String

Returns The role that this role binding grants. For example, roles/compute.admin.

For a complete list of predefined IAM roles, as well as the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.

Returns:



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'proto_docs/google/cloud/policytroubleshooter/iam/v3/troubleshooter.rb', line 386

class AllowBindingExplanation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about whether the role binding includes the principal.
  # @!attribute [rw] membership
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::MembershipMatchingState]
  #     Indicates whether the role binding includes the principal.
  # @!attribute [rw] relevance
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::HeuristicRelevance]
  #     The relevance of the principal's status to the overall determination for
  #     the role binding.
  class AnnotatedAllowMembership
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::AllowBindingExplanation::AnnotatedAllowMembership]
  class MembershipsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#role_permission ⇒ ::Google::Cloud::PolicyTroubleshooter::Iam::V3::RolePermissionInclusionState

Returns Indicates whether the role granted by this role binding contains the specified permission.

Returns:



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'proto_docs/google/cloud/policytroubleshooter/iam/v3/troubleshooter.rb', line 386

class AllowBindingExplanation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about whether the role binding includes the principal.
  # @!attribute [rw] membership
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::MembershipMatchingState]
  #     Indicates whether the role binding includes the principal.
  # @!attribute [rw] relevance
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::HeuristicRelevance]
  #     The relevance of the principal's status to the overall determination for
  #     the role binding.
  class AnnotatedAllowMembership
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::AllowBindingExplanation::AnnotatedAllowMembership]
  class MembershipsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#role_permission_relevance ⇒ ::Google::Cloud::PolicyTroubleshooter::Iam::V3::HeuristicRelevance

Returns The relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy.

Returns:



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'proto_docs/google/cloud/policytroubleshooter/iam/v3/troubleshooter.rb', line 386

class AllowBindingExplanation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about whether the role binding includes the principal.
  # @!attribute [rw] membership
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::MembershipMatchingState]
  #     Indicates whether the role binding includes the principal.
  # @!attribute [rw] relevance
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::HeuristicRelevance]
  #     The relevance of the principal's status to the overall determination for
  #     the role binding.
  class AnnotatedAllowMembership
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::PolicyTroubleshooter::Iam::V3::AllowBindingExplanation::AnnotatedAllowMembership]
  class MembershipsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end