class PureCloud::TokensApi
Attributes
Public Class Methods
# File lib/purecloudplatformclientv2/api/tokens_api.rb, line 23 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Delete all auth tokens for the specified user.
@param user_id User
ID @param [Hash] opts the optional parameters @return [nil]
# File lib/purecloudplatformclientv2/api/tokens_api.rb, line 32 def delete_token(user_id, opts = {}) delete_token_with_http_info(user_id, opts) return nil end
Delete all auth tokens for the specified user.
@param user_id User
ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/purecloudplatformclientv2/api/tokens_api.rb, line 42 def delete_token_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TokensApi.delete_token ..." end # verify the required parameter 'user_id' is set fail ArgumentError, "Missing the required parameter 'user_id' when calling TokensApi.delete_token" if user_id.nil? # resource path local_var_path = "/api/v2/tokens/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: TokensApi#delete_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete auth token used to make the request.
@param [Hash] opts the optional parameters @return [nil]
# File lib/purecloudplatformclientv2/api/tokens_api.rb, line 95 def delete_tokens_me(opts = {}) delete_tokens_me_with_http_info(opts) return nil end
Delete auth token used to make the request.
@param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/purecloudplatformclientv2/api/tokens_api.rb, line 104 def delete_tokens_me_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TokensApi.delete_tokens_me ..." end # resource path local_var_path = "/api/v2/tokens/me".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: TokensApi#delete_tokens_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Fetch information about the current token
@param [Hash] opts the optional parameters @return [TokenInfo]
# File lib/purecloudplatformclientv2/api/tokens_api.rb, line 149 def get_tokens_me(opts = {}) data, _status_code, _headers = get_tokens_me_with_http_info(opts) return data end
Fetch information about the current token
@param [Hash] opts the optional parameters @return [Array<(TokenInfo
, Fixnum, Hash)>] TokenInfo
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/tokens_api.rb, line 158 def get_tokens_me_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TokensApi.get_tokens_me ..." end # resource path local_var_path = "/api/v2/tokens/me".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'TokenInfo') if @api_client.config.debugging @api_client.config.logger.debug "API called: TokensApi#get_tokens_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end