Package com.yahoo.vespa.athenz.client.zms

Interface ZmsClient

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

DefaultZmsClient

public interface ZmsClient
extends Closeable

Author:

bjorncs

Method Summary

Modifier and Type	Method	Description
void	addPolicyRule(AthenzDomain athenzDomain, String athenzPolicy, String action, AthenzResourceName resourceName, AthenzRole athenzRole)
void	addRoleMember(AthenzRole role, AthenzIdentity member, Optional<String> reason)
void	close()
void	createOrUpdateService(AthenzService athenzService)
void	createPolicy(AthenzDomain athenzDomain, String athenzPolicy)
void	createProviderResourceGroup(AthenzDomain tenantDomain, AthenzIdentity providerService, String resourceGroup, Set<RoleAction> roleActions, OAuthCredentials oAuthCredentials)
void	createRole(AthenzRole role, Map<String,Object> properties)
default void	createSubdomain(AthenzDomain parent, String name)
void	createSubdomain(AthenzDomain parent, String name, Map<String,Object> attributes)
void	createTenancy(AthenzDomain tenantDomain, AthenzIdentity providerService, OAuthCredentials oAuthCredentials)
void	createTenantResourceGroup(AthenzDomain tenantDomain, AthenzIdentity provider, String resourceGroup, Set<RoleAction> roleActions)	For manual tenancy provisioning - only creates roles/policies on provider domain
void	decidePendingRoleMembership(AthenzRole athenzRole, AthenzIdentity athenzIdentity, Instant expiry, Optional<String> reason, Optional<OAuthCredentials> oAuthCredentials, boolean approve)
void	deletePolicy(AthenzDomain domain, String athenzPolicy)
boolean	deletePolicyRule(AthenzDomain athenzDomain, String athenzPolicy, String action, AthenzResourceName resourceName, AthenzRole athenzRole)
void	deleteProviderResourceGroup(AthenzDomain tenantDomain, AthenzIdentity providerService, String resourceGroup, OAuthCredentials oAuthCredentials)
void	deleteRole(AthenzRole athenzRole)
void	deleteRoleMember(AthenzRole role, AthenzIdentity member)
void	deleteService(AthenzService athenzService)
void	deleteSubdomain(AthenzDomain parent, String name)
void	deleteTenancy(AthenzDomain tenantDomain, AthenzIdentity providerService, OAuthCredentials oAuthCredentials)
List<AthenzDomain>	getDomainList(String prefix)
List<AthenzDomain>	getDomainListByAccount(String id)
AthenzDomainMeta	getDomainMeta(AthenzDomain domain)
AthenzRoleInformation	getFullRoleInformation(AthenzRole role)
boolean	getGroupMembership(AthenzGroup group, AthenzIdentity identity)
boolean	getMembership(AthenzRole role, AthenzIdentity identity)
Optional<AthenzPolicy>	getPolicy(AthenzDomain domain, String name)
QuotaUsage	getQuotaUsage()
Set<RoleAction>	getTenantResourceGroups(AthenzDomain tenantDomain, AthenzIdentity provider, String resourceGroup)
boolean	hasAccess(AthenzResourceName resource, String action, AthenzIdentity identity)
List<AthenzIdentity>	listMembers(AthenzRole athenzRole)
Map<AthenzIdentity,String>	listPendingRoleApprovals(AthenzRole athenzRole)
Set<String>	listPolicies(AthenzDomain domain)
Set<AthenzRole>	listRoles(AthenzDomain domain)
List<AthenzService>	listServices(AthenzDomain athenzDomain)
void	updateDomain(AthenzDomain domain, Map<String,Object> attributes)
void	updateServicePublicKey(AthenzService athenzService, String publicKeyId, PublicKey publicKey)

Method Details

createTenancy

void createTenancy(AthenzDomain tenantDomain,
 AthenzIdentity providerService,
 OAuthCredentials oAuthCredentials)

deleteTenancy

void deleteTenancy(AthenzDomain tenantDomain,
 AthenzIdentity providerService,
 OAuthCredentials oAuthCredentials)

createProviderResourceGroup

void createProviderResourceGroup(AthenzDomain tenantDomain,
 AthenzIdentity providerService,
 String resourceGroup,
 Set<RoleAction> roleActions,
 OAuthCredentials oAuthCredentials)

deleteProviderResourceGroup

void deleteProviderResourceGroup(AthenzDomain tenantDomain,
 AthenzIdentity providerService,
 String resourceGroup,
 OAuthCredentials oAuthCredentials)

createTenantResourceGroup

void createTenantResourceGroup(AthenzDomain tenantDomain,
 AthenzIdentity provider,
 String resourceGroup,
 Set<RoleAction> roleActions)

For manual tenancy provisioning - only creates roles/policies on provider domain

getTenantResourceGroups

Set<RoleAction> getTenantResourceGroups(AthenzDomain tenantDomain,
 AthenzIdentity provider,
 String resourceGroup)

addRoleMember

void addRoleMember(AthenzRole role,
 AthenzIdentity member,
 Optional<String> reason)

deleteRoleMember

void deleteRoleMember(AthenzRole role,
 AthenzIdentity member)

getMembership

boolean getMembership(AthenzRole role,
 AthenzIdentity identity)

getGroupMembership

boolean getGroupMembership(AthenzGroup group,
 AthenzIdentity identity)

getDomainList

List<AthenzDomain> getDomainList(String prefix)

getDomainListByAccount

List<AthenzDomain> getDomainListByAccount(String id)

getDomainMeta

AthenzDomainMeta getDomainMeta(AthenzDomain domain)

updateDomain

void updateDomain(AthenzDomain domain,
 Map<String,Object> attributes)

hasAccess

boolean hasAccess(AthenzResourceName resource,
 String action,
 AthenzIdentity identity)

createPolicy

void createPolicy(AthenzDomain athenzDomain,
 String athenzPolicy)

addPolicyRule

void addPolicyRule(AthenzDomain athenzDomain,
 String athenzPolicy,
 String action,
 AthenzResourceName resourceName,
 AthenzRole athenzRole)

deletePolicyRule

boolean deletePolicyRule(AthenzDomain athenzDomain,
 String athenzPolicy,
 String action,
 AthenzResourceName resourceName,
 AthenzRole athenzRole)

getPolicy

Optional<AthenzPolicy> getPolicy(AthenzDomain domain,
 String name)

listPendingRoleApprovals

Map<AthenzIdentity,String> listPendingRoleApprovals(AthenzRole athenzRole)

decidePendingRoleMembership

void decidePendingRoleMembership(AthenzRole athenzRole,
 AthenzIdentity athenzIdentity,
 Instant expiry,
 Optional<String> reason,
 Optional<OAuthCredentials> oAuthCredentials,
 boolean approve)

listMembers

List<AthenzIdentity> listMembers(AthenzRole athenzRole)

listServices

List<AthenzService> listServices(AthenzDomain athenzDomain)

createOrUpdateService

void createOrUpdateService(AthenzService athenzService)

updateServicePublicKey

void updateServicePublicKey(AthenzService athenzService,
 String publicKeyId,
 PublicKey publicKey)

deleteService

void deleteService(AthenzService athenzService)

createRole

void createRole(AthenzRole role,
 Map<String,Object> properties)

listRoles

Set<AthenzRole> listRoles(AthenzDomain domain)

listPolicies

Set<String> listPolicies(AthenzDomain domain)

deleteRole

void deleteRole(AthenzRole athenzRole)

createSubdomain

void createSubdomain(AthenzDomain parent,
 String name,
 Map<String,Object> attributes)

createSubdomain

default void createSubdomain(AthenzDomain parent,
 String name)

getFullRoleInformation

AthenzRoleInformation getFullRoleInformation(AthenzRole role)

getQuotaUsage

QuotaUsage getQuotaUsage()

deleteSubdomain

void deleteSubdomain(AthenzDomain parent,
 String name)

deletePolicy

void deletePolicy(AthenzDomain domain,
 String athenzPolicy)

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable