org.gitlab4j.api

Class PersonalAccessTokenApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.PersonalAccessTokenApi

All Implemented Interfaces:

Constants

public class PersonalAccessTokenApi
extends AbstractApi

This class provides an entry point to all the GitLab API personal access token calls.

See Also:

Personal access token API at GitLab

Nested Class Summary

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

Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.AutoDevopsDeployStrategy, Constants.BuildGitStrategy, Constants.CommitBuildState, Constants.ContributorOrderBy, Constants.DefaultBranchProtectionLevel, Constants.DeploymentOrderBy, Constants.DeploymentStatus, Constants.DeployTokenScope, Constants.Encoding, Constants.EpicOrderBy, Constants.EventScope, Constants.GroupOrderBy, Constants.GroupSearchScope, Constants.ImpersonationState, Constants.IssueOrderBy, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestSearchIn, Constants.MergeRequestState, Constants.MilestoneState, Constants.PackageOrderBy, Constants.PackageStatus, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.PipelineSource, Constants.ProjectAccessTokenScope, Constants.ProjectCreationLevel, Constants.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, Constants.SquashOption, Constants.StateEvent, Constants.SubgroupCreationLevel, Constants.TagOrderBy, Constants.TargetType, Constants.TodoAction, Constants.TodoState, Constants.TodoType, Constants.TokenType

Field Summary

Fields inherited from class org.gitlab4j.api.AbstractApi

gitLabApi

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
PersonalAccessTokenApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method and Description
PersonalAccessToken	getPersonalAccessToken() Get information about the personal access token used in the request header.
PersonalAccessToken	getPersonalAccessToken(java.lang.String id) Get a specific personal access token.
void	revokePersonalAccessToken(java.lang.Long tokenId) Revokes a personal access token.
PersonalAccessToken	rotatePersonalAccessToken() Rotates the given personal access token.
PersonalAccessToken	rotatePersonalAccessToken(java.util.Date expiresAt) Rotates the personal access token used in the request header.
PersonalAccessToken	rotatePersonalAccessToken(java.lang.String id, java.util.Date expiresAt) Rotates a specific personal access token.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getDefaultPerPageParam, getGroupIdOrPath, getLabelIdOrName, getNamespaceIdOrPath, getPageQueryParams, getPageQueryParams, getPerPageQueryParam, getProjectIdOrPath, getUserIdOrUsername, getWithAccepts, handle, head, isApiVersion, patch, patch, post, post, post, post, post, put, put, put, putUpload, putUpload, putWithFormData, upload, 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

PersonalAccessTokenApi

public PersonalAccessTokenApi(GitLabApi gitLabApi)

Method Detail

rotatePersonalAccessToken

public PersonalAccessToken rotatePersonalAccessToken()
                                              throws GitLabApiException

Rotates the given personal access token. The token is revoked and a new one which will expire in one week is created to replace it. Only working with GitLab 16.0 and above.

GitLab Endpoint: POST /personal_access_tokens/self/rotate

Returns:

the newly created PersonalAccessToken.

Throws:

GitLabApiException - if any exception occurs

rotatePersonalAccessToken

public PersonalAccessToken rotatePersonalAccessToken(java.util.Date expiresAt)
                                              throws GitLabApiException

Rotates the personal access token used in the request header. The token is revoked and a new one which will expire at the given expiresAt-date is created to replace it. Only working with GitLab 16.0 and above.

GitLab Endpoint: POST /personal_access_tokens/self/rotate

Parameters:

expiresAt - Expiration date of the access token

Returns:

the newly created PersonalAccessToken.

Throws:

GitLabApiException - if any exception occurs

rotatePersonalAccessToken

public PersonalAccessToken rotatePersonalAccessToken(java.lang.String id,
                                                     java.util.Date expiresAt)
                                              throws GitLabApiException

Rotates a specific personal access token. The token is revoked and a new one which will expire at the given expiresAt-date is created to replace it. Only working with GitLab 16.0 and above.

GitLab Endpoint: POST /personal_access_tokens/:id/rotate

Parameters:

id - ID of the personal access token

expiresAt - Expiration date of the access token

Returns:

the newly created PersonalAccessToken.

Throws:

GitLabApiException - if any exception occurs

getPersonalAccessToken

public PersonalAccessToken getPersonalAccessToken()
                                           throws GitLabApiException

Get information about the personal access token used in the request header. Only working with GitLab 16.0 and above.

GitLab Endpoint: GET /personal_access_tokens/self

Returns:

the specified PersonalAccessToken.

Throws:

GitLabApiException - if any exception occurs

getPersonalAccessToken

public PersonalAccessToken getPersonalAccessToken(java.lang.String id)
                                           throws GitLabApiException

Get a specific personal access token. Only working with GitLab 16.0 and above.

GitLab Endpoint: GET /personal_access_tokens/:id

Parameters:

id - ID of the personal access token

Returns:

the specified PersonalAccessToken.

Throws:

GitLabApiException - if any exception occurs

revokePersonalAccessToken

public void revokePersonalAccessToken(java.lang.Long tokenId)
                               throws GitLabApiException

Revokes a personal access token. Available only for admin users.

GitLab Endpoint: DELETE /personal_access_tokens/:token_id

Parameters:

tokenId - the personal access token ID to revoke

Throws:

GitLabApiException - if any exception occurs