Package iam
Overview ▹
Index ▹
Constants
const ( // AllUsers is a special member that denotes all users, even unauthenticated ones. AllUsers = "allUsers" // AllAuthenticatedUsers is a special member that denotes all authenticated users. AllAuthenticatedUsers = "allAuthenticatedUsers" )
type Handle ¶
A Handle provides IAM operations for a resource.
type Handle struct {
// contains filtered or unexported fields
}
func InternalNewHandle ¶
func InternalNewHandle(conn *grpc.ClientConn, resource string) *Handle
InternalNewHandle is for use by the Google Cloud Libraries only.
InternalNewHandle returns a Handle for resource. The conn parameter refers to a server that must support the IAMPolicy service.
func InternalNewHandleClient ¶
func InternalNewHandleClient(c client, resource string) *Handle
InternalNewHandleClient is for use by the Google Cloud Libraries only.
InternalNewHandleClient returns a Handle for resource using the given client implementation.
func (*Handle) Policy ¶
func (h *Handle) Policy(ctx context.Context) (*Policy, error)
Policy retrieves the IAM policy for the resource.
func (*Handle) SetPolicy ¶
func (h *Handle) SetPolicy(ctx context.Context, policy *Policy) error
SetPolicy replaces the resource's current policy with the supplied Policy.
If policy was created from a prior call to Get, then the modification will only succeed if the policy has not changed since the Get.
func (*Handle) TestPermissions ¶
func (h *Handle) TestPermissions(ctx context.Context, permissions []string) ([]string, error)
TestPermissions returns the subset of permissions that the caller has on the resource.
type Policy ¶
A Policy is a list of Bindings representing roles granted to members.
The zero Policy is a valid policy with no bindings.
type Policy struct { // This field is exported for use by the Google Cloud Libraries only. // It may become unexported in a future release. InternalProto *pb.Policy }
func (*Policy) Add ¶
func (p *Policy) Add(member string, r RoleName)
Add adds member member to role r if it is not already present. A new binding is created if there is no binding for the role.
func (*Policy) HasRole ¶
func (p *Policy) HasRole(member string, r RoleName) bool
HasRole reports whether member has role r.
func (*Policy) Members ¶
func (p *Policy) Members(r RoleName) []string
Members returns the list of members with the supplied role. The return value should not be modified. Use Add and Remove to modify the members of a role.
func (*Policy) Remove ¶
func (p *Policy) Remove(member string, r RoleName)
Remove removes member from role r if it is present.
func (*Policy) Roles ¶
func (p *Policy) Roles() []RoleName
Roles returns the names of all the roles that appear in the Policy.
type RoleName ¶
A RoleName is a name representing a collection of permissions.
type RoleName string
Common role names.
const ( Owner RoleName = "roles/owner" Editor RoleName = "roles/editor" Viewer RoleName = "roles/viewer" )