Interface CredHubPermissionV2Operations
- All Known Implementing Classes:
CredHubPermissionV2Template
public interface CredHubPermissionV2Operations
Specifies the interactions with CredHub to add, retrieve, and delete permissions.
- Author:
- Scott Frederick, Alberto C. RĂos
-
Method Summary
Modifier and TypeMethodDescriptionaddPermissions(CredentialName path, Permission permission) Add permissions to an credential path.voidDelete a permission.getPermissions(String id) Get a permission.getPermissionsByPathAndActor(CredentialName path, Actor actor) Get a permission by path and actor.updatePermissions(String id, CredentialName path, Permission permission) Add permissions to an existing credential.
-
Method Details
-
getPermissions
Get a permission.- Parameters:
id- the CredHub-assigned ID of the permission; must not be null- Returns:
- the details if the specified permission
-
getPermissionsByPathAndActor
Get a permission by path and actor.- Parameters:
path- the path of the credentials; must not be nullactor- the actor of the credentials; must not be null- Returns:
- the details if the specified permission
- Since:
- API 2.1
-
addPermissions
Add permissions to an credential path.- Parameters:
path- the path of the credentials; must not be nullpermission- a permission to add- Returns:
- the details if the added permission
-
updatePermissions
Add permissions to an existing credential.- Parameters:
id- the CredHub-assigned ID of the permission; must not be nullpath- the path of the credentials; must not be nullpermission- a permission to add- Returns:
- the details if the added permission
-
deletePermission
Delete a permission.- Parameters:
id- the CredHub-assigned ID of the permission; must not be null
-