Interface IAMEffectivePermissions

All Known Implementing Classes:
IAMEffectivePermissionsImpl

public interface IAMEffectivePermissions
Client interface for resolving IAM effective (computed) permissions.

Resolves the permissions a principal effectively holds within a project for a given service (GET /v1/projects/{projectId}/effectivePermissions, operationId getEffectivePermissions).

  • Method Summary

    Modifier and Type
    Method
    Description
    get(String projectId, String serviceId)
    Resolves the effective permissions for a project and service (operationId getEffectivePermissions).
    get(String projectId, String serviceId, String projectErn)
    Resolves the effective permissions for a project and service, optionally scoped by project ERN (operationId getEffectivePermissions).
  • Method Details

    • get

      EffectivePermissions get(String projectId, String serviceId)
      Resolves the effective permissions for a project and service (operationId getEffectivePermissions).
      Parameters:
      projectId - the IAM project id, project:<id> (for example project:abc-123); a bare Resource Manager UUID is rejected, convert it with ProjectIds.of(String). Project-scoped endpoints need an STS access-policy token (new IAM(BearerTokenProvider))
      serviceId - the service to resolve permissions for
      Returns:
      the resolved effective permissions
    • get

      EffectivePermissions get(String projectId, String serviceId, String projectErn)
      Resolves the effective permissions for a project and service, optionally scoped by project ERN (operationId getEffectivePermissions).
      Parameters:
      projectId - the IAM project id, project:<id> (for example project:abc-123); a bare Resource Manager UUID is rejected, convert it with ProjectIds.of(String). Project-scoped endpoints need an STS access-policy token (new IAM(BearerTokenProvider))
      serviceId - the service to resolve permissions for
      projectErn - the project ERN to scope resolution to, or null
      Returns:
      the resolved effective permissions