Class: PlatformAPI::OauthClient
- Inherits:
-
Object
- Object
- PlatformAPI::OauthClient
- 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
-
#create(body = {}) ⇒ Object
Create a new OAuth client.
-
#delete(oauth_client_id) ⇒ Object
Delete OAuth client.
-
#info(oauth_client_id) ⇒ Object
Info for an OAuth client.
-
#initialize(client) ⇒ OauthClient
constructor
A new instance of OauthClient.
-
#list ⇒ Object
List OAuth clients.
-
#rotate_credentials(oauth_client_id) ⇒ Object
Rotate credentials for an OAuth client.
-
#update(oauth_client_id, body = {}) ⇒ Object
Update OAuth client.
Constructor Details
#initialize(client) ⇒ OauthClient
Returns a new instance of OauthClient.
1604 1605 1606 |
# File 'lib/platform-api/client.rb', line 1604 def initialize(client) @client = client end |
Instance Method Details
#create(body = {}) ⇒ Object
Create a new OAuth client.
1611 1612 1613 |
# File 'lib/platform-api/client.rb', line 1611 def create(body = {}) @client.oauth_client.create(body) end |
#delete(oauth_client_id) ⇒ Object
Delete OAuth client.
1618 1619 1620 |
# File 'lib/platform-api/client.rb', line 1618 def delete(oauth_client_id) @client.oauth_client.delete(oauth_client_id) end |
#info(oauth_client_id) ⇒ Object
Info for an OAuth client
1625 1626 1627 |
# File 'lib/platform-api/client.rb', line 1625 def info(oauth_client_id) @client.oauth_client.info(oauth_client_id) end |
#list ⇒ Object
List OAuth clients
1630 1631 1632 |
# File 'lib/platform-api/client.rb', line 1630 def list() @client.oauth_client.list() end |
#rotate_credentials(oauth_client_id) ⇒ Object
Rotate credentials for an OAuth client
1645 1646 1647 |
# File 'lib/platform-api/client.rb', line 1645 def rotate_credentials(oauth_client_id) @client.oauth_client.rotate_credentials(oauth_client_id) end |
#update(oauth_client_id, body = {}) ⇒ Object
Update OAuth client
1638 1639 1640 |
# File 'lib/platform-api/client.rb', line 1638 def update(oauth_client_id, body = {}) @client.oauth_client.update(oauth_client_id, body) end |