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.



2172
2173
2174
 
# File 'lib/platform-api/client.rb', line 2172

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



2179
2180
2181
 
# File 'lib/platform-api/client.rb', line 2179

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



2186
2187
2188
 
# File 'lib/platform-api/client.rb', line 2186

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



2193
2194
2195
 
# File 'lib/platform-api/client.rb', line 2193

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

#list ⇒ Object

List OAuth clients



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

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



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

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



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

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