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.



2221
2222
2223
 
# File 'lib/platform-api/client.rb', line 2221

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



2228
2229
2230
 
# File 'lib/platform-api/client.rb', line 2228

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



2235
2236
2237
 
# File 'lib/platform-api/client.rb', line 2235

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



2242
2243
2244
 
# File 'lib/platform-api/client.rb', line 2242

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

#list ⇒ Object

List OAuth authorizations.



2255
2256
2257
 
# File 'lib/platform-api/client.rb', line 2255

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



2262
2263
2264
 
# File 'lib/platform-api/client.rb', line 2262

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

#update(oauth_authorization_id, body = {}) ⇒ Object

Update an existing OAuth authorization.

Parameters:

  • oauth_authorization_id: —

    unique identifier of OAuth authorization

  • body: —

    the object to pass as the request payload



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

def update(oauth_authorization_id, body = {})
  @client.oauth_authorization.update(oauth_authorization_id, body)
end