Package org.springframework.credhub.core.permissionV2

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 Details

    • getPermissions

      CredentialPermission getPermissions(String id)
      Get a permission.
      Parameters:
      id - the CredHub-assigned ID of the permission; must not be null
      Returns:
      the details if the specified permission

    • getPermissionsByPathAndActor

      CredentialPermission getPermissionsByPathAndActor(CredentialName path, Actor actor)
      Get a permission by path and actor.
      Parameters:
      path - the path of the credentials; must not be null
      actor - the actor of the credentials; must not be null
      Returns:
      the details if the specified permission
      Since:
      API 2.1

    • addPermissions

      CredentialPermission addPermissions(CredentialName path, Permission permission)
      Add permissions to an credential path.
      Parameters:
      path - the path of the credentials; must not be null
      permission - a permission to add
      Returns:
      the details if the added permission

    • updatePermissions

      CredentialPermission updatePermissions(String id, CredentialName path, Permission permission)
      Add permissions to an existing credential.
      Parameters:
      id - the CredHub-assigned ID of the permission; must not be null
      path - the path of the credentials; must not be null
      permission - a permission to add
      Returns:
      the details if the added permission

    • deletePermission

      void deletePermission(String id)
      Delete a permission.
      Parameters:
      id - the CredHub-assigned ID of the permission; must not be null