man.userClient-OpencgaR-method.Rd Maven / Gradle / Ivy

Go to download
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/User-methods.R
\name{userClient,OpencgaR-method}
\alias{userClient,OpencgaR-method}
\title{UserClient methods}
\usage{
\S4method{userClient}{OpencgaR}(OpencgaR, filterId, user, users, endpointName, params = NULL, ...)
}
\arguments{
\item{filterId}{Filter id.}

\item{user}{User ID.}

\item{users}{Comma separated list of user IDs.}

\item{name}{Unique name (typically the name of the application).}

\item{id}{Filter id. If provided, it will only fetch the specified filter.}

\item{action}{Action to be performed: ADD or REMOVE a group. Allowed values: \link{'ADD', 'REMOVE'}}

\item{limit}{Number of results to be returned.}

\item{skip}{Number of results to skip.}

\item{include}{Fields included in the response, whole JSON path must be provided.}

\item{exclude}{Fields excluded in the response, whole JSON path must be provided.}

\item{includeResult}{Flag indicating to include the created or updated document result in the response.}

\item{data}{JSON containing the params to be updated.}
}
\description{
This function implements the OpenCGA calls for managing Users.
The following table summarises the available \emph{actions} for this client:\tabular{llr}{
   endpointName \tab Endpoint WS \tab parameters accepted \cr
   create \tab /{apiVersion}/users/create \tab body\link{*} \cr
   login \tab /{apiVersion}/users/login \tab body \cr
   password \tab /{apiVersion}/users/password \tab body\link{*} \cr
   info \tab /{apiVersion}/users/{users}/info \tab include, exclude, users\link{*} \cr
   configs \tab /{apiVersion}/users/{user}/configs \tab user\link{*}, name \cr
   updateConfigs \tab /{apiVersion}/users/{user}/configs/update \tab user\link{*}, action, body\link{*} \cr
   filters \tab /{apiVersion}/users/{user}/filters \tab user\link{*}, id \cr
   updateFilters \tab /{apiVersion}/users/{user}/filters/update \tab user\link{*}, action, body\link{*} \cr
   updateFilter \tab /{apiVersion}/users/{user}/filters/{filterId}/update \tab user\link{*}, filterId\link{*}, body\link{*} \cr
   resetPassword \tab /{apiVersion}/users/{user}/password/reset \tab user\link{*} \cr
   projects \tab /{apiVersion}/users/{user}/projects \tab include, exclude, limit, skip, user\link{*} \cr
   update \tab /{apiVersion}/users/{user}/update \tab include, exclude, user\link{*}, includeResult, body\link{*} \cr
}
}
\section{Endpoint /{apiVersion}/users/create}{

Create a new user.
}

\section{Endpoint /{apiVersion}/users/login}{

Get identified and gain access to the system.
}

\section{Endpoint /{apiVersion}/users/password}{

Change the password of a user.
}

\section{Endpoint /{apiVersion}/users/{users}/info}{

Return the user information including its projects and studies.
}

\section{Endpoint /{apiVersion}/users/{user}/configs}{

Fetch a user configuration.
}

\section{Endpoint /{apiVersion}/users/{user}/configs/update}{

Add or remove a custom user configuration.
}

\section{Endpoint /{apiVersion}/users/{user}/filters}{

Fetch user filters.
}

\section{Endpoint /{apiVersion}/users/{user}/filters/update}{

Add or remove a custom user filter.
}

\section{Endpoint /{apiVersion}/users/{user}/filters/{filterId}/update}{

Update a custom filter.
}

\section{Endpoint /{apiVersion}/users/{user}/password/reset}{

Reset password.
}

\section{Endpoint /{apiVersion}/users/{user}/projects}{

Retrieve the projects of the user.
}

\section{Endpoint /{apiVersion}/users/{user}/update}{

Update some user attributes.
}

\seealso{
\url{http://docs.opencb.org/display/opencga/Using+OpenCGA} and the RESTful API documentation
\url{http://bioinfo.hpc.cam.ac.uk/opencga-prod/webservices/}
\link{*}: Required parameter
}