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.



1341
1342
1343
 
# File 'lib/platform-api/client.rb', line 1341

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



1348
1349
1350
 
# File 'lib/platform-api/client.rb', line 1348

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



1355
1356
1357
 
# File 'lib/platform-api/client.rb', line 1355

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



1362
1363
1364
 
# File 'lib/platform-api/client.rb', line 1362

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

#list ⇒ Object

List OAuth authorizations.



1367
1368
1369
 
# File 'lib/platform-api/client.rb', line 1367

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



1374
1375
1376
 
# File 'lib/platform-api/client.rb', line 1374

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