Interface Authorizations

All Known Implementing Classes:
AuthorizationsImpl

public interface Authorizations
The Authorizations class provides functionality to retrieve the authorizations stored in the Camunda Identity instance.
  • Method Details

    • forToken

      List<Authorization> forToken(String token)
      Returns the list of authorizations which are assigned to the user linked to the token.
      Parameters:
      token - the token
      Returns:
      the list of authorizations
    • forToken

      List<Authorization> forToken(String token, String organizationId)
      Returns the list of authorizations which are assigned to the user linked to the token taking into account the organizationId passed in.
      Parameters:
      token - the token
      organizationId - the orgainzation to retrieve authorizations for
      Returns:
      the list of authorizations
    • assignAuthorization

      void assignAuthorization(String token, String entityId, String entityType, String organizationId, String resourceKey, String resourceType, Set<String> requestedPermissions)
      Assigns an authorization to the user belonging to the token passed in
      Parameters:
      token - the user token to authenticate the request with
      entityId - the ID of the entity to assign the authorization to
      entityType - the type of entity see: EntityType
      organizationId - the organization ID to create the authorization for, the user must have access to the organization.
      resourceKey - the key of the resource
      resourceType - the type of resource see: ResourceType
      requestedPermissions - the permissions to assign to the authorization see: ResourcePermissions
    • update

      void update(String token, UpdateAuthorizations updateAuthorizations)
      Updates authorizations for the user belonging to the token passed in
      Parameters:
      token - the user token to authenticate the request with
      updateAuthorizations - the representation of the authorizations to update, see UpdateAuthorizations
    • create

      static Authorizations create(IdentityConfiguration configuration)
      Factory function to create a new authorizations instance
      Parameters:
      configuration - Identity configuration
      Returns:
      Authorizations instance