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

• #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

# 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.

# 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.

# 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.

# 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

# 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

# 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

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

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