Class: CybridApiId::UsersIdpApi
- Inherits:
-
Object
- Object
- CybridApiId::UsersIdpApi
- Defined in:
- lib/cybrid_api_id_ruby/api/users_idp_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_user(post_user_idp_model, opts = {}) ⇒ UserIdpModel
Create user Creates a user.
-
#create_user_with_http_info(post_user_idp_model, opts = {}) ⇒ Array<(UserIdpModel, Integer, Hash)>
Create user Creates a user.
-
#disable_user(user_guid, opts = {}) ⇒ nil
Disable User Disables a user.
-
#disable_user_with_http_info(user_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Disable User Disables a user.
-
#get_user(user_guid, opts = {}) ⇒ UserIdpModel
Get User Retrieves a user.
-
#get_user_with_http_info(user_guid, opts = {}) ⇒ Array<(UserIdpModel, Integer, Hash)>
Get User Retrieves a user.
-
#initialize(api_client = ApiClient.default) ⇒ UsersIdpApi
constructor
A new instance of UsersIdpApi.
-
#list_user(opts = {}) ⇒ UserListIdpModel
List users Retrieve a list users.
-
#list_user_with_http_info(opts = {}) ⇒ Array<(UserListIdpModel, Integer, Hash)>
List users Retrieve a list users.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ UsersIdpApi
Returns a new instance of UsersIdpApi.
19 20 21 |
# File 'lib/cybrid_api_id_ruby/api/users_idp_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/cybrid_api_id_ruby/api/users_idp_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_user(post_user_idp_model, opts = {}) ⇒ UserIdpModel
Create user Creates a user.
27 28 29 30 |
# File 'lib/cybrid_api_id_ruby/api/users_idp_api.rb', line 27 def create_user(post_user_idp_model, opts = {}) data, _status_code, _headers = create_user_with_http_info(post_user_idp_model, opts) data end |
#create_user_with_http_info(post_user_idp_model, opts = {}) ⇒ Array<(UserIdpModel, Integer, Hash)>
Create user Creates a user.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/cybrid_api_id_ruby/api/users_idp_api.rb', line 37 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'] = 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, ) 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 |
#disable_user(user_guid, opts = {}) ⇒ nil
Disable User Disables a user. User is not deleted. Required scope: users:execute
95 96 97 98 |
# File 'lib/cybrid_api_id_ruby/api/users_idp_api.rb', line 95 def disable_user(user_guid, opts = {}) disable_user_with_http_info(user_guid, opts) nil end |
#disable_user_with_http_info(user_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Disable User Disables a user. User is not deleted. Required scope: users:execute
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'lib/cybrid_api_id_ruby/api/users_idp_api.rb', line 105 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'] = 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, ) 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 |
#get_user(user_guid, opts = {}) ⇒ UserIdpModel
Get User Retrieves a user. Required scope: users:read
158 159 160 161 |
# File 'lib/cybrid_api_id_ruby/api/users_idp_api.rb', line 158 def get_user(user_guid, opts = {}) data, _status_code, _headers = get_user_with_http_info(user_guid, opts) data end |
#get_user_with_http_info(user_guid, opts = {}) ⇒ Array<(UserIdpModel, Integer, Hash)>
Get User Retrieves a user. Required scope: users:read
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
# File 'lib/cybrid_api_id_ruby/api/users_idp_api.rb', line 168 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'] = 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, ) 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 |
#list_user(opts = {}) ⇒ UserListIdpModel
List users Retrieve a list users. Required scope: users:read
223 224 225 226 |
# File 'lib/cybrid_api_id_ruby/api/users_idp_api.rb', line 223 def list_user(opts = {}) data, _status_code, _headers = list_user_with_http_info(opts) data end |
#list_user_with_http_info(opts = {}) ⇒ Array<(UserListIdpModel, Integer, Hash)>
List users Retrieve a list users. Required scope: users:read
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/cybrid_api_id_ruby/api/users_idp_api.rb', line 235 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'] = 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, ) 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 |