Class: PlatformAPI::OauthClient

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

Overview

OAuth clients are applications that Heroku users can authorize 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) ⇒ OauthClient

Returns a new instance of OauthClient.



1764
1765
1766
 
# File 'lib/platform-api/client.rb', line 1764

def initialize(client)
  @client = client
end

Instance Method Details

#create(body = {}) ⇒ Object

Create a new OAuth client.

Parameters:

  • body: —

    the object to pass as the request payload



1771
1772
1773
 
# File 'lib/platform-api/client.rb', line 1771

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

#delete(oauth_client_id) ⇒ Object

Delete OAuth client.

Parameters:

  • oauth_client_id: —

    unique identifier of this OAuth client



1778
1779
1780
 
# File 'lib/platform-api/client.rb', line 1778

def delete(oauth_client_id)
  @client.oauth_client.delete(oauth_client_id)
end

#info(oauth_client_id) ⇒ Object

Info for an OAuth client

Parameters:

  • oauth_client_id: —

    unique identifier of this OAuth client



1785
1786
1787
 
# File 'lib/platform-api/client.rb', line 1785

def info(oauth_client_id)
  @client.oauth_client.info(oauth_client_id)
end

#list ⇒ Object

List OAuth clients



1790
1791
1792
 
# File 'lib/platform-api/client.rb', line 1790

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

#rotate_credentials(oauth_client_id) ⇒ Object

Rotate credentials for an OAuth client

Parameters:

  • oauth_client_id: —

    unique identifier of this OAuth client



1805
1806
1807
 
# File 'lib/platform-api/client.rb', line 1805

def rotate_credentials(oauth_client_id)
  @client.oauth_client.rotate_credentials(oauth_client_id)
end

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

Update OAuth client

Parameters:

  • oauth_client_id: —

    unique identifier of this OAuth client

  • body: —

    the object to pass as the request payload



1798
1799
1800
 
# File 'lib/platform-api/client.rb', line 1798

def update(oauth_client_id, body = {})
  @client.oauth_client.update(oauth_client_id, body)
end