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.



2198
2199
2200
 
# File 'lib/platform-api/client.rb', line 2198

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



2205
2206
2207
 
# File 'lib/platform-api/client.rb', line 2205

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



2212
2213
2214
 
# File 'lib/platform-api/client.rb', line 2212

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

#info(oauth_client_id) ⇒ Object

Info for an OAuth client. The output for unauthenticated requests excludes the secret parameter.

Parameters:

  • oauth_client_id: —

    unique identifier of this OAuth client



2219
2220
2221
 
# File 'lib/platform-api/client.rb', line 2219

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

#list ⇒ Object

List OAuth clients



2224
2225
2226
 
# File 'lib/platform-api/client.rb', line 2224

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



2239
2240
2241
 
# File 'lib/platform-api/client.rb', line 2239

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



2232
2233
2234
 
# File 'lib/platform-api/client.rb', line 2232

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