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.



1488
1489
1490
 
# File 'lib/platform-api/client.rb', line 1488

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



1495
1496
1497
 
# File 'lib/platform-api/client.rb', line 1495

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



1502
1503
1504
 
# File 'lib/platform-api/client.rb', line 1502

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



1509
1510
1511
 
# File 'lib/platform-api/client.rb', line 1509

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

#list ⇒ Object

List OAuth clients



1514
1515
1516
 
# File 'lib/platform-api/client.rb', line 1514

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



1529
1530
1531
 
# File 'lib/platform-api/client.rb', line 1529

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



1522
1523
1524
 
# File 'lib/platform-api/client.rb', line 1522

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