Package co.ankatech.ankasecure.keymanagement

Class CapabilityGrantOperations

java.lang.Object

co.ankatech.ankasecure.keymanagement.CapabilityGrantOperations

public final class CapabilityGrantOperations
extends Object

The tenant's explicit capability grants: which actor may use which key for which operation, under which constraints. Obtained from AuthenticatedKeyManagementSdk.capabilityGrants().

 ConferralPlanResponse plan = sdk.capabilityGrants().preview(request);
 CapabilityGrantResponse grant = sdk.capabilityGrants().create(request);
 

Method Summary

Modifier and Type	Method	Description
CapabilityGrantResponse	create(CreateCapabilityGrantRequest request)	Creates a capability grant (POST /tenants/{t}/capability-grants).
void	delete(UUID grantId)	Revokes a capability grant (DELETE /tenants/{t}/capability-grants/{g}).
CapabilityGrantResponse	get(UUID grantId)	Reads one capability grant (GET /tenants/{t}/capability-grants/{g}).
PageCapabilityGrantResponse	list(CapabilityGrantListQuery query)	Lists capability grants (GET /tenants/{t}/capability-grants).
ConferralPlanResponse	preview(CreateCapabilityGrantRequest request)	Previews what a grant would confer, without creating it (POST /tenants/{t}/capability-grants/preview).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

list

public PageCapabilityGrantResponse list(CapabilityGrantListQuery query)

Lists capability grants (GET /tenants/{t}/capability-grants).

Parameters:

query - the filters and page; must not be null

Returns:

one page of grants

Throws:

KeyManagementSdkException - when the call is refused

create

public CapabilityGrantResponse create(CreateCapabilityGrantRequest request)

Creates a capability grant (POST /tenants/{t}/capability-grants).

Parameters:

request - the grant; must not be null

Returns:

the created grant

Throws:

KeyManagementSdkException - when the call is refused

preview

public ConferralPlanResponse preview(CreateCapabilityGrantRequest request)

Previews what a grant would confer, without creating it (POST /tenants/{t}/capability-grants/preview).

Parameters:

request - the grant to preview; must not be null

Returns:

the conferral plan

Throws:

KeyManagementSdkException - when the call is refused

get

public CapabilityGrantResponse get(UUID grantId)

Reads one capability grant (GET /tenants/{t}/capability-grants/{g}).

Parameters:

grantId - the grant; must not be null

Returns:

the grant

Throws:

KeyManagementSdkException - when the call is refused

delete

public void delete(UUID grantId)

Revokes a capability grant (DELETE /tenants/{t}/capability-grants/{g}).

Parameters:

grantId - the grant; must not be null

Throws:

KeyManagementSdkException - when the call is refused