module Octokit::Client::Tokens

Method to check scopes

@see developer.github.com/v3/oauth_authorizations/#oauth-authorizations-api

Public Instance Methods

scopes(token = @access_token, options = {}) click to toggle source

Check scopes for a token

@param token [String] GitHub OAuth token @param options [Hash] Header params for request @return [Array<String>] OAuth scopes @see developer.github.com/v3/oauth/#scopes

# File lib/octokit/client/tokens.rb, line 15
def scopes(token = @access_token, options = {})
  options = options.dup
  raise ArgumentError, 'Access token required' if token.nil?

  auth = { 'Authorization' => "token #{token}" }
  headers = (options.delete(:headers) || {}).merge(auth)

  agent.call(:get, 'user', headers: headers)
       .headers['X-OAuth-Scopes']
       .to_s
       .split(',')
       .map(&:strip)
       .sort
end