module Sonarqube::Client::Tokens
Defines methods related to tokens. @see SONAR_URL/web_api/api/user_tokens
Public Instance Methods
create_token(name, login = nil)
click to toggle source
Create token for user.
@example
Sonarqube.create_token('name_token') Sonarqube.create_token('name_token', 'login_name')
@param [String] name (required) Token name. @param [String] login (optional) Login user name. @return [Sonarqube::ObjectifiedHash]
# File lib/sonarqube/client/tokens.rb, line 16 def create_token(name, login = nil) raise ArgumentError, 'Missing required parameters' if name.nil? body = { name: name } body = { login: login }.merge!(body) unless login.nil? post('/api/user_tokens/generate', body: body) end
Also aliased as: token_create
list_tokens(login)
click to toggle source
List token for user.
@example
Sonarqube.list_token('login')
@param [String] login (required) The login name of user @return [Sonarqube::ObjectifiedHash].
# File lib/sonarqube/client/tokens.rb, line 50 def list_tokens(login) raise ArgumentError, 'Missing required parameters' if login.nil? get('/api/user_tokens/search', query: { login: login }) end
Also aliased as: tokens_list
revoke_token(name, login = nil)
click to toggle source
Revoke a token.
@example
Sonarqube.revoke_token('new-group') Sonarqube.revoke_token('sonarqube', { description: 'New Sonarqube project' })
@param [String] name (required) Token name. @param [String] login (optional) Login user name. @return [Sonarqube::ObjectifiedHash] Empty hash response.
# File lib/sonarqube/client/tokens.rb, line 34 def revoke_token(name, login = nil) raise ArgumentError, 'Missing required parameters' if name.nil? body = { name: name } body = { login: login }.merge!(body) unless login.nil? post('/api/user_tokens/revoke', body: body) end
Also aliased as: token_revoke