class LosantRest::InstanceApiToken
Class containing all the actions for the Instance
Api Token Resource
Public Class Methods
# File lib/losant_rest/instance_api_token.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
Deletes an API Token
Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.User, instanceApiToken.*, or instanceApiToken.delete.
Parameters:
-
{string} instanceId - ID associated with the instance
-
{string} apiTokenId - ID associated with the API token
-
{string} losantdomain - Domain scope of request (rarely needed)
-
{boolean} _actions - Return resource actions in response
-
{boolean} _links - Return resource link in response
-
{boolean} _embedded - Return embedded resources in response
Responses:
-
200 - If API token was successfully deleted (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if API token was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/instance_api_token.rb, line 56 def delete(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId) raise ArgumentError.new("apiTokenId is required") unless params.has_key?(:apiTokenId) headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain) query_params[:_actions] = params[:_actions] if params.has_key?(:_actions) query_params[:_links] = params[:_links] if params.has_key?(:_links) query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded) path = "/instances/#{params[:instanceId]}/tokens/#{params[:apiTokenId]}" @client.request( method: :delete, path: path, query: query_params, headers: headers, body: body) end
Retrieves information on an API token
Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instanceApiToken.*, or instanceApiToken.get.
Parameters:
-
{string} instanceId - ID associated with the instance
-
{string} apiTokenId - ID associated with the API token
-
{string} losantdomain - Domain scope of request (rarely needed)
-
{boolean} _actions - Return resource actions in response
-
{boolean} _links - Return resource link in response
-
{boolean} _embedded - Return embedded resources in response
Responses:
-
200 - API token information (api.losant.com/#/definitions/apiToken)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if API token was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/instance_api_token.rb, line 102 def get(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId) raise ArgumentError.new("apiTokenId is required") unless params.has_key?(:apiTokenId) headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain) query_params[:_actions] = params[:_actions] if params.has_key?(:_actions) query_params[:_links] = params[:_links] if params.has_key?(:_links) query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded) path = "/instances/#{params[:instanceId]}/tokens/#{params[:apiTokenId]}" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Updates information about an API token
Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.User, instanceApiToken.*, or instanceApiToken.patch.
Parameters:
-
{string} instanceId - ID associated with the instance
-
{string} apiTokenId - ID associated with the API token
-
{hash} apiToken - Object containing new properties of the API token (api.losant.com/#/definitions/apiTokenPatch)
-
{string} losantdomain - Domain scope of request (rarely needed)
-
{boolean} _actions - Return resource actions in response
-
{boolean} _links - Return resource link in response
-
{boolean} _embedded - Return embedded resources in response
Responses:
-
200 - Updated API token information (api.losant.com/#/definitions/apiToken)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if API token was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/instance_api_token.rb, line 149 def patch(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId) raise ArgumentError.new("apiTokenId is required") unless params.has_key?(:apiTokenId) raise ArgumentError.new("apiToken is required") unless params.has_key?(:apiToken) body = params[:apiToken] if params.has_key?(:apiToken) headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain) query_params[:_actions] = params[:_actions] if params.has_key?(:_actions) query_params[:_links] = params[:_links] if params.has_key?(:_links) query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded) path = "/instances/#{params[:instanceId]}/tokens/#{params[:apiTokenId]}" @client.request( method: :patch, path: path, query: query_params, headers: headers, body: body) end