ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/controllers/authentication_controller.rb

@@ -0,0 +1,498 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # AuthenticationController
+  class AuthenticationController < BaseController
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Retrieves details of the current user session for the token provided in
+    # the request header.
+    # Any ThoughtSpot user can access this endpoint and send an API request. The
+    # data returned in the API response varies according to user's privilege and
+    # object access permissions.
+    # #### Endpoint URL
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_current_user_info
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/rest/2.0/auth/session/user',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(User.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 9.4.0.cl or later</span>
+    # Retrieves details of the current session token for the bearer token
+    # provided in the request header.
+    # This API endpoint does not create a new token. Instead, it returns details
+    # about the token, including the token string, creation time, expiration
+    # time, and the associated user.
+    # Use this endpoint to introspect your current session token, debug
+    # authentication issues, or when a frontend application needs session token
+    # details.
+    # Any ThoughtSpot user with a valid bearer token can access this endpoint
+    # and send an API request
+    # #### Endpoint URL
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_current_user_token
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/rest/2.0/auth/session/token',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetTokenResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 10.4.0.cl or later</span>
+    # Gets an authentication token with custom rules and security attributes and
+    # creates a full session in ThoughtSpot for a given user. By default, the
+    # token obtained from ThoughtSpot remains valid for 5 mins.
+    # To add a new user and assign privileges during auto creation, you need
+    # `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If
+    # [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the
+    # `CONTROL_TRUSTED_AUTH`(**Can Enable or Disable Trusted Authentication**)
+    # privilege and edit access to the data source is required.
+    # To assign security attributes with filter rules and Parameters to the JWT
+    # token, you'll need administrator privileges and edit access to the data
+    # source (Worksheet or Model). If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the
+    # `CONTROL_TRUSTED_AUTH`(**Can Enable or Disable Trusted Authentication**)
+    # privilege and edit access to the data source is required.
+    # #### Usage guidelines
+    # You can generate the token for a user by providing a `username` and
+    # `password`, or by using the cluster’s `secret_key`.
+    # To generate a `secret_key` on your cluster, the administrator must enable
+    # [Trusted
+    # authentication](https://developers.thoughtspot.com/docs/?pageid=trusted-au
+    # th#trusted-auth-enable) in the **Develop** > **Customizations** >
+    # **Security Settings** page.
+    # **Note**: When both `password` and `secret_key` are included in the API
+    # request, `password` takes precedence.
+    # If Multi-Factor Authentication (MFA) is enabled on your instance, the API
+    # login request with basic authentication (`username`  and `password` )
+    # returns an error. You can switch to token-based authentication with
+    # `secret_key`  or contact ThoughtSpot Support for assistance.
+    # ##### Attribute-Based Access Control (ABAC) with tokens
+    # To implement Attribute-Based Access Control (ABAC) and assign security
+    # entitlements to users during session creation, you can generate a token
+    # with custom filtering rules and Parameters in the `filter_rules` and
+    # `parameter_values` array respectively. These attributes can be configured
+    # to persist on a specific set of objects for user sessions initiated using
+    # the token. Once defined, the rules are added to the user's
+    # `access_control_properties` object, after which all sessions will use the
+    # persisted values.
+    # Specify the object type as `LOGICAL_TABLE`.
+    # For more information, see [ABAC via tokens
+    # Documentation](https://developers.thoughtspot.com/docs/api-authv2#_get_tok
+    # ens_with_custom_rules_and_filter_conditions).
+    # ##### Just-in-time provisioning
+    # For just-in-time user creation and provisioning, define the following
+    # attributes:
+    # * `auto_create`
+    # * `username`
+    # * `display_name`
+    # * `email`
+    # * `groups`
+    # Set `auto_create` to `true` if the user is not available in ThoughtSpot.
+    # If the user already exists in ThoughtSpot and the `auto_create` parameter
+    # is set to `true` in the API request, the user properties such as the
+    # display name, email, Org and group assignment will not be updated with new
+    # values. If `auto_create` is set to `true`, it won't create formula
+    # variables and hence won't be applicable for `variable_values`.
+    # For more information, see [Just-in-time
+    # provisioning](https://developers.thoughtspot.com/docs/just-in-time-provisi
+    # oning).
+    # ##### Important point to note
+    # All options in the token creation APIs that define access to the content
+    # in ThoughtSpot will do so during the token creation and not when the token
+    # is being used for authentication. For example, `auto_create:true` will
+    # create the user when the authentication token is created. Persist options
+    # such as  `APPEND`, `REPLACE`, `RESET` will persist security parameters on
+    # the user profile when the token is created, while Persist option `NONE`
+    # will not persist anything but will be honoured in the session.
+    # ##### Formula Variables
+    # Before using variables_values, variables must be created using Create
+    # Variable API with type as Formula_Variable
+    # (/api/rest/2.0/template/variables/create)
+    # The persist_option RESET and NONE cannot be used when variable_values are
+    # provided in the request.
+    # If you are working with variable_values, you must use other (APPEND,
+    # REPLACE) supported modes.
+    # If you want to use RESET or NONE, do not pass any variable_values. In such
+    # cases, variable_values will remain unaffected.
+    # When using object_id with variable_values, models are supported.
+    # #### Endpoint URL
+    # @param [GetCustomAccessTokenRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_custom_access_token(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/auth/token/custom',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccessToken.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request. This could be due to missing or incorrect'\
+                                  ' parameters.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access. The request could not be authenticated.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access. The user does not have permission to access'\
+                                  ' this resource.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'An unexpected error occurred on the server.',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Gets an authentication token and creates a full session in ThoughtSpot for
+    # a given user. By default, the token obtained from ThoughtSpot remains
+    # valid for 5 mins.
+    # You can generate the token for a user by providing a `username` and
+    # `password`, or by using the cluster’s `secret_key` (for [Trusted
+    # authentication](https://developers.thoughtspot.com/docs/?pageid=trusted-au
+    # th#trusted-auth-enable)).
+    # To generate a `secret_key` on your cluster, the administrator must enable
+    # **Trusted authentication** in the **Develop** > **Customizations** >
+    # **Security Settings** page. For more information, see [Trusted
+    # authentication](https://developers.thoughtspot.com/docs/?pageid=trusted-au
+    # th#trusted-auth-enable).
+    # **Note**: When both `password` and `secret_key` are included in the API
+    # request, `password` takes precedence.
+    # If Multi-Factor Authentication (MFA) is enabled on your instance, the API
+    # login request with basic authentication (`username`  and `password` )
+    # returns an error. You can switch to token-based authentication with
+    # `secret_key`  or contact ThoughtSpot Support for assistance.
+    # #### Just-in-time provisioning
+    # For just-in-time user creation and provisioning, define the following
+    # attributes:
+    # * `auto_create`
+    # * `username`
+    # * `display_name`
+    # * `email`
+    # * `group_identifiers`
+    # Set `auto_create` to `True` if the user is not available in ThoughtSpot.
+    # If the user already exists in ThoughtSpot and the `auto_create` parameter
+    # is set to `true`, the API call will update user properties like display
+    # name, email and group assignment.
+    # For more information, see [Just-in-time
+    # provisioning](https://developers.thoughtspot.com/docs/just-in-time-provisi
+    # oning).
+    # To add a new user and assign privileges, you need `ADMINISTRATION` (**Can
+    # administer ThoughtSpot**) privilege. If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the
+    # `CONTROL_TRUSTED_AUTH`(**Can Enable or Disable Trusted Authentication**)
+    # privilege is required.
+    # #### Important point to note
+    # All options in the token creation APIs changing the content in ThoughtSpot
+    # will do so during the token creation and not when the token is being used
+    # for authentication. For example, `auto_create:true` will create the user
+    # when the authentication token is created.
+    # #### Endpoint URL
+    # @param [GetFullAccessTokenRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_full_access_token(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/auth/token/full',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Token.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Gets an authentication token that provides access to a specific metadata
+    # object. By default, the token obtained from ThoughtSpot remains valid for
+    # 5 mins.
+    # You can generate the token for a user by providing a `username` and
+    # `password`, or by using the cluster’s `secret key` (for [Trusted
+    # authentication](https://developers.thoughtspot.com/docs/?pageid=trusted-au
+    # th#trusted-auth-enable)).
+    # To generate a `secret_key` on your cluster, the administrator must enable
+    # **Trusted authentication** in the **Develop** > **Customizations** >
+    # **Security Settings** page.
+    # **Note**: When both `password` and `secret_key` are included in the API
+    # request,  `password` takes precedence.
+    # If Multi-Factor Authentication (MFA) is enabled on your instance, the API
+    # login request with basic authentication (`username`  and `password` )
+    # returns an error. You can switch to token-based authentication with
+    # `secret_key`  or contact ThoughtSpot Support for assistance.
+    # #### Just-in-time provisioning
+    # For just-in-time user creation and provisioning, define the following
+    # attributes:
+    # * `auto_create`
+    # * `username`
+    # * `display_name`
+    # * `email`
+    # * `group_identifiers`
+    # Set `auto_create` to `True` if the user is not available in ThoughtSpot.
+    # If the user already exists in ThoughtSpot and the `auto_create` parameter
+    # is set to `true`, the API call will update user properties like display
+    # name, email and group assignment.
+    # For more information, see [Just-in-time
+    # provisioning](https://developers.thoughtspot.com/docs/just-in-time-provisi
+    # oning).
+    # To add a new user and assign privileges, you need `ADMINISTRATION` (**Can
+    # administer ThoughtSpot**) privilege. If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the
+    # `CONTROL_TRUSTED_AUTH`(**Can Enable or Disable Trusted Authentication**)
+    # privilege is required.
+    # #### Important point to note
+    # All options in the token creation APIs changing the content in ThoughtSpot
+    # will do so during the token creation and not when the token is being used
+    # for authentication. For example, `auto_create:true` will create the user
+    # when the authentication token is created.
+    # #### Endpoint URL
+    # @param [GetObjectAccessTokenRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_object_access_token(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/auth/token/object',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Token.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Creates a login session for a ThoughtSpot user with Basic authentication.
+    # In Basic authentication method, REST clients log in to ThoughtSpot using
+    # `username` and `password` attributes. On a multi-tenant cluster with Orgs,
+    # users can pass the ID of the Org in the API request to log in to a
+    # specific Org context.
+    # **Note**: If Multi-Factor Authentication (MFA) is enabled on your
+    # instance, the API login request with basic authentication (`username`  and
+    # `password` ) returns an error. Contact ThoughtSpot Support for assistance.
+    # A successful login returns a session cookie that can be used in your
+    # subsequent API requests.
+    # #### Endpoint URL
+    # @param [LoginRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def login(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/auth/session/login',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Logs out a user from their current session.
+    # #### Endpoint URL
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def logout
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/auth/session/logout',
+                                     Server::DEFAULT)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Revokes the authentication token issued for current user session.
+    # The token of your current session expires when you make a call to the
+    # `/api/rest/2.0/auth/token/revoke` endpoint.
+    # the users will not be able to access ThoughtSpot objects until a new token
+    # is obtained.
+    # To restart your session, request for a new token from ThoughtSpot. See
+    # [Get Full Access
+    # Token](#/http/api-endpoints/authentication/get-full-access-token).
+    # #### Endpoint URL
+    # @param [RevokeTokenRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def revoke_token(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/auth/token/revoke',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 9.12.0.cl or later</span>
+    # Validates the authentication token specified in the API request.
+    # If your token is not valid, [Get a new
+    # token](#/http/api-endpoints/authentication/get-full-access-token).
+    # #### Endpoint URL
+    # @param [ValidateTokenRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def validate_token(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/auth/token/validate',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TokenValidationResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/controllers/base_controller.rb

@@ -0,0 +1,65 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # BaseController.
+  class BaseController
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'Ruby SDK, Version: 1.0.0, on OS {os-info}'
+    end
+
+    def self.user_agent_parameters
+      {
+        '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
+      }
+    end
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end