Interface AccessContextManagerGrpc.AsyncService (1.50.0)

public static interface AccessContextManagerGrpc.AsyncService

API for setting [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] and [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] for Google Cloud projects. Each organization has one [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] that contains the [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] and [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter]. This [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] is applicable to all resources in the organization. AccessPolicies

Methods

commitServicePerimeters(CommitServicePerimetersRequest request, StreamObserver<Operation> responseObserver)

public default void commitServicePerimeters(CommitServicePerimetersRequest request, StreamObserver<Operation> responseObserver)

Commits the dry-run specification for all the [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] in an access policy. A commit operation on a service perimeter involves copying its spec field to the status field of the service perimeter. Only [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] with use_explicit_dry_run_spec field set to true are affected by a commit operation. The long-running operation from this RPC has a successful status after the dry-run specifications for all the [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] have been committed. If a commit fails, it causes the long-running operation to return an error response and the entire commit operation is cancelled. When successful, the Operation.response field contains CommitServicePerimetersResponse. The dry_run and the spec fields are cleared after a successful commit operation.

Parameters
Name Description
request CommitServicePerimetersRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createAccessLevel(CreateAccessLevelRequest request, StreamObserver<Operation> responseObserver)

public default void createAccessLevel(CreateAccessLevelRequest request, StreamObserver<Operation> responseObserver)

Creates an [access level] [google.identity.accesscontextmanager.v1.AccessLevel]. The long-running operation from this RPC has a successful status after the [access level] [google.identity.accesscontextmanager.v1.AccessLevel] propagates to long-lasting storage. If [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] contain errors, an error response is returned for the first error encountered.

Parameters
Name Description
request CreateAccessLevelRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createAccessPolicy(AccessPolicy request, StreamObserver<Operation> responseObserver)

public default void createAccessPolicy(AccessPolicy request, StreamObserver<Operation> responseObserver)

Creates an access policy. This method fails if the organization already has an access policy. The long-running operation has a successful status after the access policy propagates to long-lasting storage. Syntactic and basic semantic errors are returned in metadata as a BadRequest proto.

Parameters
Name Description
request AccessPolicy
responseObserver io.grpc.stub.StreamObserver<Operation>

createGcpUserAccessBinding(CreateGcpUserAccessBindingRequest request, StreamObserver<Operation> responseObserver)

public default void createGcpUserAccessBinding(CreateGcpUserAccessBindingRequest request, StreamObserver<Operation> responseObserver)

Creates a [GcpUserAccessBinding] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding]. If the client specifies a [name] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding.name], the server ignores it. Fails if a resource already exists with the same [group_key] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding.group_key]. Completion of this long-running operation does not necessarily signify that the new binding is deployed onto all affected users, which may take more time.

Parameters
Name Description
request CreateGcpUserAccessBindingRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createServicePerimeter(CreateServicePerimeterRequest request, StreamObserver<Operation> responseObserver)

public default void createServicePerimeter(CreateServicePerimeterRequest request, StreamObserver<Operation> responseObserver)

Creates a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter]. The long-running operation from this RPC has a successful status after the [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] propagates to long-lasting storage. If a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] contains errors, an error response is returned for the first error encountered.

Parameters
Name Description
request CreateServicePerimeterRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteAccessLevel(DeleteAccessLevelRequest request, StreamObserver<Operation> responseObserver)

public default void deleteAccessLevel(DeleteAccessLevelRequest request, StreamObserver<Operation> responseObserver)

Deletes an [access level] [google.identity.accesscontextmanager.v1.AccessLevel] based on the resource name. The long-running operation from this RPC has a successful status after the [access level] [google.identity.accesscontextmanager.v1.AccessLevel] has been removed from long-lasting storage.

Parameters
Name Description
request DeleteAccessLevelRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteAccessPolicy(DeleteAccessPolicyRequest request, StreamObserver<Operation> responseObserver)

public default void deleteAccessPolicy(DeleteAccessPolicyRequest request, StreamObserver<Operation> responseObserver)

Deletes an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] based on the resource name. The long-running operation has a successful status after the [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] is removed from long-lasting storage.

Parameters
Name Description
request DeleteAccessPolicyRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteGcpUserAccessBinding(DeleteGcpUserAccessBindingRequest request, StreamObserver<Operation> responseObserver)

public default void deleteGcpUserAccessBinding(DeleteGcpUserAccessBindingRequest request, StreamObserver<Operation> responseObserver)

Deletes a [GcpUserAccessBinding] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding]. Completion of this long-running operation does not necessarily signify that the binding deletion is deployed onto all affected users, which may take more time.

Parameters
Name Description
request DeleteGcpUserAccessBindingRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteServicePerimeter(DeleteServicePerimeterRequest request, StreamObserver<Operation> responseObserver)

public default void deleteServicePerimeter(DeleteServicePerimeterRequest request, StreamObserver<Operation> responseObserver)

Deletes a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] based on the resource name. The long-running operation from this RPC has a successful status after the [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] is removed from long-lasting storage.

Parameters
Name Description
request DeleteServicePerimeterRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

getAccessLevel(GetAccessLevelRequest request, StreamObserver<AccessLevel> responseObserver)

public default void getAccessLevel(GetAccessLevelRequest request, StreamObserver<AccessLevel> responseObserver)

Gets an [access level] [google.identity.accesscontextmanager.v1.AccessLevel] based on the resource name.

Parameters
Name Description
request GetAccessLevelRequest
responseObserver io.grpc.stub.StreamObserver<AccessLevel>

getAccessPolicy(GetAccessPolicyRequest request, StreamObserver<AccessPolicy> responseObserver)

public default void getAccessPolicy(GetAccessPolicyRequest request, StreamObserver<AccessPolicy> responseObserver)

Returns an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] based on the name.

Parameters
Name Description
request GetAccessPolicyRequest
responseObserver io.grpc.stub.StreamObserver<AccessPolicy>

getGcpUserAccessBinding(GetGcpUserAccessBindingRequest request, StreamObserver<GcpUserAccessBinding> responseObserver)

public default void getGcpUserAccessBinding(GetGcpUserAccessBindingRequest request, StreamObserver<GcpUserAccessBinding> responseObserver)

Gets the [GcpUserAccessBinding] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding] with the given name.

Parameters
Name Description
request GetGcpUserAccessBindingRequest
responseObserver io.grpc.stub.StreamObserver<GcpUserAccessBinding>

getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public default void getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

Gets the IAM policy for the specified Access Context Manager access policy.

Parameters
Name Description
request com.google.iam.v1.GetIamPolicyRequest
responseObserver io.grpc.stub.StreamObserver<com.google.iam.v1.Policy>

getServicePerimeter(GetServicePerimeterRequest request, StreamObserver<ServicePerimeter> responseObserver)

public default void getServicePerimeter(GetServicePerimeterRequest request, StreamObserver<ServicePerimeter> responseObserver)

Gets a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] based on the resource name.

Parameters
Name Description
request GetServicePerimeterRequest
responseObserver io.grpc.stub.StreamObserver<ServicePerimeter>

listAccessLevels(ListAccessLevelsRequest request, StreamObserver<ListAccessLevelsResponse> responseObserver)

public default void listAccessLevels(ListAccessLevelsRequest request, StreamObserver<ListAccessLevelsResponse> responseObserver)

Lists all [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] for an access policy.

Parameters
Name Description
request ListAccessLevelsRequest
responseObserver io.grpc.stub.StreamObserver<ListAccessLevelsResponse>

listAccessPolicies(ListAccessPoliciesRequest request, StreamObserver<ListAccessPoliciesResponse> responseObserver)

public default void listAccessPolicies(ListAccessPoliciesRequest request, StreamObserver<ListAccessPoliciesResponse> responseObserver)

Lists all [access policies] [google.identity.accesscontextmanager.v1.AccessPolicy] in an organization.

Parameters
Name Description
request ListAccessPoliciesRequest
responseObserver io.grpc.stub.StreamObserver<ListAccessPoliciesResponse>

listGcpUserAccessBindings(ListGcpUserAccessBindingsRequest request, StreamObserver<ListGcpUserAccessBindingsResponse> responseObserver)

public default void listGcpUserAccessBindings(ListGcpUserAccessBindingsRequest request, StreamObserver<ListGcpUserAccessBindingsResponse> responseObserver)

Lists all [GcpUserAccessBindings] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding] for a Google Cloud organization.

Parameters
Name Description
request ListGcpUserAccessBindingsRequest
responseObserver io.grpc.stub.StreamObserver<ListGcpUserAccessBindingsResponse>

listServicePerimeters(ListServicePerimetersRequest request, StreamObserver<ListServicePerimetersResponse> responseObserver)

public default void listServicePerimeters(ListServicePerimetersRequest request, StreamObserver<ListServicePerimetersResponse> responseObserver)

Lists all [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] for an access policy.

Parameters
Name Description
request ListServicePerimetersRequest
responseObserver io.grpc.stub.StreamObserver<ListServicePerimetersResponse>

replaceAccessLevels(ReplaceAccessLevelsRequest request, StreamObserver<Operation> responseObserver)

public default void replaceAccessLevels(ReplaceAccessLevelsRequest request, StreamObserver<Operation> responseObserver)

Replaces all existing [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] in an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] with the [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. If the replacement contains errors, an error response is returned for the first error encountered. Upon error, the replacement is cancelled, and existing [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] are not affected. The Operation.response field contains ReplaceAccessLevelsResponse. Removing [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] contained in existing [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] result in an error.

Parameters
Name Description
request ReplaceAccessLevelsRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

replaceServicePerimeters(ReplaceServicePerimetersRequest request, StreamObserver<Operation> responseObserver)

public default void replaceServicePerimeters(ReplaceServicePerimetersRequest request, StreamObserver<Operation> responseObserver)

Replace all existing [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] in an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] with the [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. Replacements containing errors result in an error response for the first error encountered. Upon an error, replacement are cancelled and existing [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] are not affected. The Operation.response field contains ReplaceServicePerimetersResponse.

Parameters
Name Description
request ReplaceServicePerimetersRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public default void setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

Sets the IAM policy for the specified Access Context Manager access policy. This method replaces the existing IAM policy on the access policy. The IAM policy controls the set of users who can perform specific operations on the Access Context Manager access policy.

Parameters
Name Description
request com.google.iam.v1.SetIamPolicyRequest
responseObserver io.grpc.stub.StreamObserver<com.google.iam.v1.Policy>

testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

public default void testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.

Parameters
Name Description
request com.google.iam.v1.TestIamPermissionsRequest
responseObserver io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse>

updateAccessLevel(UpdateAccessLevelRequest request, StreamObserver<Operation> responseObserver)

public default void updateAccessLevel(UpdateAccessLevelRequest request, StreamObserver<Operation> responseObserver)

Updates an [access level] [google.identity.accesscontextmanager.v1.AccessLevel]. The long-running operation from this RPC has a successful status after the changes to the [access level] [google.identity.accesscontextmanager.v1.AccessLevel] propagate to long-lasting storage. If [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] contain errors, an error response is returned for the first error encountered.

Parameters
Name Description
request UpdateAccessLevelRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateAccessPolicy(UpdateAccessPolicyRequest request, StreamObserver<Operation> responseObserver)

public default void updateAccessPolicy(UpdateAccessPolicyRequest request, StreamObserver<Operation> responseObserver)

Updates an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy]. The long-running operation from this RPC has a successful status after the changes to the [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] propagate to long-lasting storage.

Parameters
Name Description
request UpdateAccessPolicyRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateGcpUserAccessBinding(UpdateGcpUserAccessBindingRequest request, StreamObserver<Operation> responseObserver)

public default void updateGcpUserAccessBinding(UpdateGcpUserAccessBindingRequest request, StreamObserver<Operation> responseObserver)

Updates a [GcpUserAccessBinding] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding]. Completion of this long-running operation does not necessarily signify that the changed binding is deployed onto all affected users, which may take more time.

Parameters
Name Description
request UpdateGcpUserAccessBindingRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateServicePerimeter(UpdateServicePerimeterRequest request, StreamObserver<Operation> responseObserver)

public default void updateServicePerimeter(UpdateServicePerimeterRequest request, StreamObserver<Operation> responseObserver)

Updates a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter]. The long-running operation from this RPC has a successful status after the [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] propagates to long-lasting storage. If a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] contains errors, an error response is returned for the first error encountered.

Parameters
Name Description
request UpdateServicePerimeterRequest
responseObserver io.grpc.stub.StreamObserver<Operation>