Class: PlatformAPI::OauthToken

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

OAuth tokens provide access for authorized clients to act on behalf of a Heroku user to automate, customize or extend their usage of the platform. For more information please refer to the Heroku OAuth documentation

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ OauthToken

Returns a new instance of OauthToken.



2251
2252
2253
# File 'lib/platform-api/client.rb', line 2251

def initialize(client)
  @client = client
end

Instance Method Details

#create(body = {}) ⇒ Object

Create a new OAuth token.

Parameters:

  • body:

    the object to pass as the request payload



2258
2259
2260
# File 'lib/platform-api/client.rb', line 2258

def create(body = {})
  @client.oauth_token.create(body)
end

#delete(oauth_token_id) ⇒ Object

Revoke OAuth access token.

Parameters:

  • oauth_token_id:

    unique identifier of OAuth token



2265
2266
2267
# File 'lib/platform-api/client.rb', line 2265

def delete(oauth_token_id)
  @client.oauth_token.delete(oauth_token_id)
end