github.com/cs3org/reva/v2@v2.27.7/pkg/user/user.go (about)

     1  // Copyright 2018-2021 CERN
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  //
    15  // In applying this license, CERN does not waive the privileges and immunities
    16  // granted to it by virtue of its status as an Intergovernmental Organization
    17  // or submit itself to any jurisdiction.
    18  
    19  package user
    20  
    21  import (
    22  	"context"
    23  
    24  	userpb "github.com/cs3org/go-cs3apis/cs3/identity/user/v1beta1"
    25  	"github.com/cs3org/reva/v2/pkg/plugin"
    26  )
    27  
    28  // Manager is the interface to implement to manipulate users.
    29  type Manager interface {
    30  	plugin.Plugin
    31  	// GetUser returns the user metadata identified by a uid.
    32  	// The groups of the user are omitted if specified, as these might not be required for certain operations
    33  	// and might involve computational overhead.
    34  	GetUser(ctx context.Context, uid *userpb.UserId, skipFetchingGroups bool) (*userpb.User, error)
    35  	// GetUserByClaim returns the user identified by a specific value for a given claim.
    36  	GetUserByClaim(ctx context.Context, claim, value string, skipFetchingGroups bool) (*userpb.User, error)
    37  	// GetUserGroups returns the groups a user identified by a uid belongs to.
    38  	GetUserGroups(ctx context.Context, uid *userpb.UserId) ([]string, error)
    39  	// FindUsers returns all the user objects which match a query parameter.
    40  	FindUsers(ctx context.Context, query string, skipFetchingGroups bool) ([]*userpb.User, error)
    41  }