class PlatformAPI::OauthClient
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](devcenter.heroku.com/articles/oauth).
Public Class Methods
new(client)
click to toggle source
# File lib/platform-api/client.rb, line 2196 def initialize(client) @client = client end
Public Instance Methods
create(body = {})
click to toggle source
Create a new OAuth client.
@param body: the object to pass as the request payload
# File lib/platform-api/client.rb, line 2203 def create(body = {}) @client.oauth_client.create(body) end
delete(oauth_client_id)
click to toggle source
Delete OAuth client.
@param oauth_client_id: unique identifier of this OAuth client
# File lib/platform-api/client.rb, line 2210 def delete(oauth_client_id) @client.oauth_client.delete(oauth_client_id) end
info(oauth_client_id)
click to toggle source
Info for an OAuth client
@param oauth_client_id: unique identifier of this OAuth client
# File lib/platform-api/client.rb, line 2217 def info(oauth_client_id) @client.oauth_client.info(oauth_client_id) end
list()
click to toggle source
List OAuth clients
# File lib/platform-api/client.rb, line 2222 def list() @client.oauth_client.list() end
rotate_credentials(oauth_client_id)
click to toggle source
Rotate credentials for an OAuth client
@param oauth_client_id: unique identifier of this OAuth client
# File lib/platform-api/client.rb, line 2237 def rotate_credentials(oauth_client_id) @client.oauth_client.rotate_credentials(oauth_client_id) end
update(oauth_client_id, body = {})
click to toggle source
Update OAuth client
@param oauth_client_id: unique identifier of this OAuth client @param body: the object to pass as the request payload
# File lib/platform-api/client.rb, line 2230 def update(oauth_client_id, body = {}) @client.oauth_client.update(oauth_client_id, body) end