Module: Sonarqube::Client::Tokens

Included in:
Sonarqube::Client
Defined in:
lib/sonarqube/client/tokens.rb

Overview

Defines methods related to tokens.

See Also:

Instance Method Summary collapse

Instance Method Details

#create_token(name, login = nil) ⇒ Sonarqube::ObjectifiedHash Also known as: token_create

Create token for user.

Examples:

Sonarqube.create_token('name_token')
Sonarqube.create_token('name_token', 'login_name')

Parameters:

  • name (String) —

    (required) Token name.

  • login (String) (defaults to: nil) —

    (optional) Login user name.

Returns:

Raises:

  • (ArgumentError) 


16
17
18
19
20
21
22
 
# File 'lib/sonarqube/client/tokens.rb', line 16

def create_token(name,  = nil)
  raise ArgumentError, 'Missing required parameters' if name.nil?

  body = { name: name }
  body = { login:  }.merge!(body) unless .nil?
  post('/api/user_tokens/generate', body: body)
end

#list_tokens(login) ⇒ Sonarqube::ObjectifiedHash Also known as: tokens_list

List token for user.

Examples:

Sonarqube.list_token('login')

Parameters:

  • login (String) —

    (required) The login name of user

Returns:

Raises:

  • (ArgumentError) 


50
51
52
53
54
 
# File 'lib/sonarqube/client/tokens.rb', line 50

def list_tokens()
  raise ArgumentError, 'Missing required parameters' if .nil?

  get('/api/user_tokens/search', query: { login:  })
end

#revoke_token(name, login = nil) ⇒ Sonarqube::ObjectifiedHash Also known as: token_revoke

Revoke a token.

Examples:

Sonarqube.revoke_token('new-group')
Sonarqube.revoke_token('sonarqube', { description: 'New Sonarqube project' })

Parameters:

  • name (String) —

    (required) Token name.

  • login (String) (defaults to: nil) —

    (optional) Login user name.

Returns:

Raises:

  • (ArgumentError) 


34
35
36
37
38
39
40
 
# File 'lib/sonarqube/client/tokens.rb', line 34

def revoke_token(name,  = nil)
  raise ArgumentError, 'Missing required parameters' if name.nil?

  body = { name: name }
  body = { login:  }.merge!(body) unless .nil?
  post('/api/user_tokens/revoke', body: body)
end