Class: PlatformAPI::OauthToken

Inherits:

Object

• Object
• PlatformAPI::OauthToken

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

• #create(body = {}) ⇒ Object

  Create a new OAuth token.

• #delete(oauth_token_id) ⇒ Object

  Revoke OAuth access token.

• #initialize(client) ⇒ OauthToken constructor

  A new instance of OauthToken.

Constructor Details

#initialize(client) ⇒ OauthToken

Returns a new instance of OauthToken.

# File 'lib/platform-api/client.rb', line 1543

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

# File 'lib/platform-api/client.rb', line 1550

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

# File 'lib/platform-api/client.rb', line 1557

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