class CybridApiId::UsersIdpApi
def create_user(post_user_idp_model, opts = {})
-
(UserIdpModel)
-
Parameters:
-
opts
(Hash
) -- the optional parameters -
post_user_idp_model
(PostUserIdpModel
) --
def create_user(post_user_idp_model, opts = {}) data, _status_code, _headers = create_user_with_http_info(post_user_idp_model, opts) data end
def create_user_with_http_info(post_user_idp_model, opts = {})
-
(Array<(UserIdpModel, Integer, Hash)>)
- UserIdpModel data, response status code and response headers
Parameters:
-
opts
(Hash
) -- the optional parameters -
post_user_idp_model
(PostUserIdpModel
) --
def create_user_with_http_info(post_user_idp_model, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersIdpApi.create_user ...' end # verify the required parameter 'post_user_idp_model' is set if @api_client.config.client_side_validation && post_user_idp_model.nil? fail ArgumentError, "Missing the required parameter 'post_user_idp_model' when calling UsersIdpApi.create_user" end # resource path local_var_path = '/api/users' # 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/json']) 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(post_user_idp_model) # return_type return_type = opts[:debug_return_type] || 'UserIdpModel' # auth_names auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2'] new_options = opts.merge( :operation => :"UsersIdpApi.create_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(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersIdpApi#create_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
def disable_user(user_guid, opts = {})
-
(nil)
-
Parameters:
-
opts
(Hash
) -- the optional parameters -
user_guid
(String
) -- Identifier for the user.
def disable_user(user_guid, opts = {}) disable_user_with_http_info(user_guid, opts) nil end
def disable_user_with_http_info(user_guid, opts = {})
-
(Array<(nil, Integer, Hash)>)
- nil, response status code and response headers
Parameters:
-
opts
(Hash
) -- the optional parameters -
user_guid
(String
) -- Identifier for the user.
def disable_user_with_http_info(user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersIdpApi.disable_user ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling UsersIdpApi.disable_user" end # resource path local_var_path = '/api/users/{user_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.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] || ['BearerAuth', 'oauth2'] new_options = opts.merge( :operation => :"UsersIdpApi.disable_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(:DELETE, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersIdpApi#disable_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
def get_user(user_guid, opts = {})
-
(UserIdpModel)
-
Parameters:
-
opts
(Hash
) -- the optional parameters -
user_guid
(String
) -- Identifier for the user.
def get_user(user_guid, opts = {}) data, _status_code, _headers = get_user_with_http_info(user_guid, opts) data end
def get_user_with_http_info(user_guid, opts = {})
-
(Array<(UserIdpModel, Integer, Hash)>)
- UserIdpModel data, response status code and response headers
Parameters:
-
opts
(Hash
) -- the optional parameters -
user_guid
(String
) -- Identifier for the user.
def get_user_with_http_info(user_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersIdpApi.get_user ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling UsersIdpApi.get_user" end # resource path local_var_path = '/api/users/{user_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.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] || 'UserIdpModel' # auth_names auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2'] new_options = opts.merge( :operation => :"UsersIdpApi.get_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: UsersIdpApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
def initialize(api_client = ApiClient.default)
def initialize(api_client = ApiClient.default) @api_client = api_client end
def list_user(opts = {})
-
(UserListIdpModel)
-
Options Hash:
(**opts)
-
:guid
(String
) -- Comma separated guids to list users for. -
:per_page
(Integer
) -- The number of entities per page to return. -
:page
(Integer
) -- The page index to retrieve.
Parameters:
-
opts
(Hash
) -- the optional parameters
def list_user(opts = {}) data, _status_code, _headers = list_user_with_http_info(opts) data end
def list_user_with_http_info(opts = {})
-
(Array<(UserListIdpModel, Integer, Hash)>)
- UserListIdpModel data, response status code and response headers
Options Hash:
(**opts)
-
:guid
(String
) -- Comma separated guids to list users for. -
:per_page
(Integer
) -- The number of entities per page to return. -
:page
(Integer
) -- The page index to retrieve.
Parameters:
-
opts
(Hash
) -- the optional parameters
def list_user_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersIdpApi.list_user ...' end if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0 fail ArgumentError, 'invalid value for "opts[:"page"]" when calling UsersIdpApi.list_user, must be greater than or equal to 0.' end if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100 fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling UsersIdpApi.list_user, must be smaller than or equal to 100.' end if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1 fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling UsersIdpApi.list_user, must be greater than or equal to 1.' end # resource path local_var_path = '/api/users' # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil? query_params[:'guid'] = opts[:'guid'] if !opts[:'guid'].nil? # 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] || 'UserListIdpModel' # auth_names auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2'] new_options = opts.merge( :operation => :"UsersIdpApi.list_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: UsersIdpApi#list_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end