Module: Gitlab::Client::ProjectAccessTokens

Included in:
Gitlab::Client
Defined in:
lib/gitlab/client/project_access_tokens.rb

Overview

Defines methods related to project access tokens.

See Also:

Instance Method Summary collapse

Instance Method Details

#create_project_access_token(project, options = {}) ⇒ Gitlab::ObjectifiedHash

Create a project access token.

Examples:

Gitlab.create_project_access_token(5, { name: "test_token", scopes: ["api", "read_repository"], expires_at: "2021-01-01"})

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Options Hash (options):

  • :name(required) (String) —

    Name of the token

  • :scopes(required) (List[String]) —

    List of api scopes

  • :expires_at(required) (String) —

    Expiration date in the format (YYYY-MM-DD)

  • :access_level(optional) (String) —

    Access level of the token (Defaults to 40 (maintainer access))

Returns:



42
43
44
 
# File 'lib/gitlab/client/project_access_tokens.rb', line 42

def create_project_access_token(project, options = {})
  post("/projects/#{url_encode project}/access_tokens", body: options)
end

#project_access_token(project, token_id) ⇒ Gitlab::ObjectifiedHash

Gets an access token of a project.

Examples:

Gitlab.project_access_token(5, 42)

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • token_id (Integer) —

    The token ID.

Returns:



26
27
28
 
# File 'lib/gitlab/client/project_access_tokens.rb', line 26

def project_access_token(project, token_id)
  get("/projects/#{url_encode project}/access_tokens/#{token_id}")
end

#project_access_tokens(project) ⇒ Array<Gitlab::ObjectifiedHash>

Gets a list of a projects access tokens.

Examples:

Gitlab.project_access_tokens(5)

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

Returns:



14
15
16
 
# File 'lib/gitlab/client/project_access_tokens.rb', line 14

def project_access_tokens(project)
  get("/projects/#{url_encode project}/access_tokens")
end