Class: PlatformAPI::OauthAuthorization

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

Overview

OAuth authorizations represent clients that a Heroku user has authorized 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) ⇒ OauthAuthorization

Returns a new instance of OauthAuthorization.



2156
2157
2158
# File 'lib/platform-api/client.rb', line 2156

def initialize(client)
  @client = client
end

Instance Method Details

#create(body = {}) ⇒ Object

Create a new OAuth authorization.

Parameters:

  • body:

    the object to pass as the request payload



2163
2164
2165
# File 'lib/platform-api/client.rb', line 2163

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

#delete(oauth_authorization_id) ⇒ Object

Delete OAuth authorization.

Parameters:

  • oauth_authorization_id:

    unique identifier of OAuth authorization



2170
2171
2172
# File 'lib/platform-api/client.rb', line 2170

def delete(oauth_authorization_id)
  @client.oauth_authorization.delete(oauth_authorization_id)
end

#info(oauth_authorization_id) ⇒ Object

Info for an OAuth authorization.

Parameters:

  • oauth_authorization_id:

    unique identifier of OAuth authorization



2177
2178
2179
# File 'lib/platform-api/client.rb', line 2177

def info(oauth_authorization_id)
  @client.oauth_authorization.info(oauth_authorization_id)
end

#listObject

List OAuth authorizations.



2182
2183
2184
# File 'lib/platform-api/client.rb', line 2182

def list()
  @client.oauth_authorization.list()
end

#regenerate(oauth_authorization_id) ⇒ Object

Regenerate OAuth tokens. This endpoint is only available to direct authorizations or privileged OAuth clients.

Parameters:

  • oauth_authorization_id:

    unique identifier of OAuth authorization



2189
2190
2191
# File 'lib/platform-api/client.rb', line 2189

def regenerate(oauth_authorization_id)
  @client.oauth_authorization.regenerate(oauth_authorization_id)
end