class Fastly::TokensApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/fastly/api/tokens_api.rb, line 17
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

bulk_revoke_tokens(opts = {}) click to toggle source

Revoke multiple tokens Revoke Tokens in bulk format. Users may only revoke their own tokens. Superusers may revoke tokens of others. @option opts [Hash<String, Object>] :request_body @return [nil]

# File lib/fastly/api/tokens_api.rb, line 24
def bulk_revoke_tokens(opts = {})
  bulk_revoke_tokens_with_http_info(opts)
  nil
end
bulk_revoke_tokens_with_http_info(opts = {}) click to toggle source

Revoke multiple tokens Revoke Tokens in bulk format. Users may only revoke their own tokens. Superusers may revoke tokens of others. @option opts [Hash<String, Object>] :request_body @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/fastly/api/tokens_api.rb, line 33
def bulk_revoke_tokens_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TokensApi.bulk_revoke_tokens ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/tokens'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+json; ext=bulk'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'request_body'])

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"TokensApi.bulk_revoke_tokens",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TokensApi#bulk_revoke_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
create_token(opts = {}) click to toggle source

Create a token Create an API token. If two-factor authentication is enabled for your account, review [the instructions](www.fastly.com/documentation/reference/api/auth-tokens/user/) for including a one-time password in the request. @return [TokenCreatedResponse]

# File lib/fastly/api/tokens_api.rb, line 84
def create_token(opts = {})
  data, _status_code, _headers = create_token_with_http_info(opts)
  data
end
create_token_with_http_info(opts = {}) click to toggle source

Create a token Create an API token. If two-factor authentication is enabled for your account, review [the instructions](www.fastly.com/documentation/reference/api/auth-tokens/user/) for including a one-time password in the request. @return [Array<(TokenCreatedResponse, Integer, Hash)>] TokenCreatedResponse data, response status code and response headers

# File lib/fastly/api/tokens_api.rb, line 92
def create_token_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TokensApi.create_token ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/tokens'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TokenCreatedResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token', 'username_and_password']

  new_options = opts.merge(
    :operation => :"TokensApi.create_token",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TokensApi#create_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_token(opts = {}) click to toggle source

Get a token Get a single token by its id. @option opts [String] :token_id Alphanumeric string identifying a token. (required) @return [TokenResponse]

# File lib/fastly/api/tokens_api.rb, line 146
def get_token(opts = {})
  data, _status_code, _headers = get_token_with_http_info(opts)
  data
end
get_token_current(opts = {}) click to toggle source

Get the current token Get a single token based on the access_token used in the request. @return [TokenResponse]

# File lib/fastly/api/tokens_api.rb, line 208
def get_token_current(opts = {})
  data, _status_code, _headers = get_token_current_with_http_info(opts)
  data
end
get_token_current_with_http_info(opts = {}) click to toggle source

Get the current token Get a single token based on the access_token used in the request. @return [Array<(TokenResponse, Integer, Hash)>] TokenResponse data, response status code and response headers

# File lib/fastly/api/tokens_api.rb, line 216
def get_token_current_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TokensApi.get_token_current ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/tokens/self'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TokenResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"TokensApi.get_token_current",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TokensApi#get_token_current\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_token_with_http_info(opts = {}) click to toggle source

Get a token Get a single token by its id. @option opts [String] :token_id Alphanumeric string identifying a token. (required) @return [Array<(TokenResponse, Integer, Hash)>] TokenResponse data, response status code and response headers

# File lib/fastly/api/tokens_api.rb, line 155
def get_token_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TokensApi.get_token ...'
  end
  # unbox the parameters from the hash
  token_id = opts[:'token_id']
  # verify the required parameter 'token_id' is set
  if @api_client.config.client_side_validation && token_id.nil?
    fail ArgumentError, "Missing the required parameter 'token_id' when calling TokensApi.get_token"
  end
  # resource path
  local_var_path = '/tokens/{token_id}'.sub('{' + 'token_id' + '}', CGI.escape(token_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TokenResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"TokensApi.get_token",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TokensApi#get_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_tokens_customer(opts = {}) click to toggle source

List tokens for a customer List all tokens belonging to a specific customer. @option opts [String] :customer_id Alphanumeric string identifying the customer. (required) @return [Array<TokenResponse>]

# File lib/fastly/api/tokens_api.rb, line 265
def list_tokens_customer(opts = {})
  data, _status_code, _headers = list_tokens_customer_with_http_info(opts)
  data
end
list_tokens_customer_with_http_info(opts = {}) click to toggle source

List tokens for a customer List all tokens belonging to a specific customer. @option opts [String] :customer_id Alphanumeric string identifying the customer. (required) @return [Array<(Array<TokenResponse>, Integer, Hash)>] Array<TokenResponse> data, response status code and response headers

# File lib/fastly/api/tokens_api.rb, line 274
def list_tokens_customer_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TokensApi.list_tokens_customer ...'
  end
  # unbox the parameters from the hash
  customer_id = opts[:'customer_id']
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling TokensApi.list_tokens_customer"
  end
  # resource path
  local_var_path = '/customer/{customer_id}/tokens'.sub('{' + 'customer_id' + '}', CGI.escape(customer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<TokenResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"TokensApi.list_tokens_customer",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TokensApi#list_tokens_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_tokens_user(opts = {}) click to toggle source

List tokens for the authenticated user List all tokens belonging to the authenticated user. @return [Array<TokenResponse>]

# File lib/fastly/api/tokens_api.rb, line 327
def list_tokens_user(opts = {})
  data, _status_code, _headers = list_tokens_user_with_http_info(opts)
  data
end
list_tokens_user_with_http_info(opts = {}) click to toggle source

List tokens for the authenticated user List all tokens belonging to the authenticated user. @return [Array<(Array<TokenResponse>, Integer, Hash)>] Array<TokenResponse> data, response status code and response headers

# File lib/fastly/api/tokens_api.rb, line 335
def list_tokens_user_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TokensApi.list_tokens_user ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/tokens'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<TokenResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"TokensApi.list_tokens_user",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TokensApi#list_tokens_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
revoke_token(opts = {}) click to toggle source

Revoke a token Revoke a specific token by its id. @option opts [String] :token_id Alphanumeric string identifying a token. (required) @return [nil]

# File lib/fastly/api/tokens_api.rb, line 384
def revoke_token(opts = {})
  revoke_token_with_http_info(opts)
  nil
end
revoke_token_current(opts = {}) click to toggle source

Revoke the current token Revoke a token that is used to authenticate the request. @return [nil]

# File lib/fastly/api/tokens_api.rb, line 446
def revoke_token_current(opts = {})
  revoke_token_current_with_http_info(opts)
  nil
end
revoke_token_current_with_http_info(opts = {}) click to toggle source

Revoke the current token Revoke a token that is used to authenticate the request. @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/fastly/api/tokens_api.rb, line 454
def revoke_token_current_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TokensApi.revoke_token_current ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/tokens/self'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"TokensApi.revoke_token_current",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TokensApi#revoke_token_current\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
revoke_token_with_http_info(opts = {}) click to toggle source

Revoke a token Revoke a specific token by its id. @option opts [String] :token_id Alphanumeric string identifying a token. (required) @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/fastly/api/tokens_api.rb, line 393
def revoke_token_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TokensApi.revoke_token ...'
  end
  # unbox the parameters from the hash
  token_id = opts[:'token_id']
  # verify the required parameter 'token_id' is set
  if @api_client.config.client_side_validation && token_id.nil?
    fail ArgumentError, "Missing the required parameter 'token_id' when calling TokensApi.revoke_token"
  end
  # resource path
  local_var_path = '/tokens/{token_id}'.sub('{' + 'token_id' + '}', CGI.escape(token_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"TokensApi.revoke_token",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TokensApi#revoke_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end