http4s-grpc-google-iam-v1
1.13.0+0.0.5
API
Generated with
http4s-grpc-google-iam-v1/com.google.iam.v1.iam_policy/IAMPolicy

IAMPolicy

com.google.iam.v1.iam_policy.IAMPolicy
See theIAMPolicy companion object
trait IAMPolicy[F[_]]

API Overview

Manages Identity and Access Management (IAM) policies.

Any implementation of an API that offers access control features implements the google.iam.v1.IAMPolicy interface.

Data model

Access control is applied when a principal (user or service account), takes some action on a resource exposed by a service. Resources, identified by URI-like names, are the unit of access control specification. Service implementations can choose the granularity of access control and the supported permissions for their resources. For example one database service may allow access control to be specified only at the Table level, whereas another might allow access control to also be specified at the Column level.

Policy Structure

See google.iam.v1.Policy

This is intentionally not a CRUD style API because access control policies are created and deleted implicitly with the resources to which they are attached.

Attributes

Companion:
object
Source:
IAMPolicy.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Abstract methods

def getIamPolicy(request: GetIamPolicyRequest, ctx: Headers): F[Policy]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Attributes

Source:
IAMPolicy.scala
def setIamPolicy(request: SetIamPolicyRequest, ctx: Headers): F[Policy]

Sets the access control policy on the specified resource. Replaces any existing policy.

Sets the access control policy on the specified resource. Replaces any existing policy.

Attributes

Source:
IAMPolicy.scala
def testIamPermissions(request: TestIamPermissionsRequest, ctx: Headers): F[TestIamPermissionsResponse]

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Attributes

Source:
IAMPolicy.scala
Generated with