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.



1444
1445
1446
 
# File 'lib/platform-api/client.rb', line 1444

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



1451
1452
1453
 
# File 'lib/platform-api/client.rb', line 1451

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



1458
1459
1460
 
# File 'lib/platform-api/client.rb', line 1458

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



1465
1466
1467
 
# File 'lib/platform-api/client.rb', line 1465

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

#list ⇒ Object

List OAuth clients



1470
1471
1472
 
# File 'lib/platform-api/client.rb', line 1470

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



1485
1486
1487
 
# File 'lib/platform-api/client.rb', line 1485

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



1478
1479
1480
 
# File 'lib/platform-api/client.rb', line 1478

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