org.gitlab4j.api

Class SessionApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.SessionApi

All Implemented Interfaces:

Constants

public class SessionApi
extends AbstractApi

This class implements the client side API for the GitLab login call.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gitlab4j.api.Constants

Constants.ActionType, Constants.ArchiveFormat, Constants.CommitBuildState, Constants.EpicOrderBy, Constants.GroupOrderBy, Constants.ImpersonationState, Constants.IssueOrderBy, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestState, Constants.MilestoneState, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.SortOrder, Constants.StateEvent, Constants.TargetType, Constants.TokenType

Field Summary

Fields inherited from interface org.gitlab4j.api.Constants

NEXT_PAGE_HEADER, PAGE_HEADER, PAGE_PARAM, PER_PAGE, PER_PAGE_PARAM, PREV_PAGE_HEADER, TOTAL_HEADER, TOTAL_PAGES_HEADER

Constructor Summary

Constructors

Constructor and Description
SessionApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method and Description
Session	login(String username, String email, String password) Login to get private token.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getDefaultPerPageParam, getGroupIdOrPath, getPageQueryParams, getPageQueryParams, getPerPageQueryParam, getProjectIdOrPath, getUserIdOrUsername, getWithAccepts, handle, head, isApiVersion, post, post, post, post, post, put, put, putUpload, putUpload, putWithFormData, upload, upload, upload, urlEncode, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SessionApi

public SessionApi(GitLabApi gitLabApi)

Method Detail

login

public Session login(String username,
                     String email,
                     String password)
              throws GitLabApiException

Login to get private token. This functionality is not available on GitLab servers 10.2 and above.

GitLab Endpoint: POST /session

Parameters:

username - the username to login

email - the email address to login

password - the password of the user

Returns:

a Session instance with info on the logged in user

Throws:

GitLabApiException - if any exception occurs