Class: Conductor::Http::Api::UserResourceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/conductor/http/api/user_resource_api.rb

Overview

UserResourceApi - API for user management operations (Orkes)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = nil) ⇒ UserResourceApi

Returns a new instance of UserResourceApi.



12
13
14
 
# File 'lib/conductor/http/api/user_resource_api.rb', line 12

def initialize(api_client = nil)
  @api_client = api_client || ApiClient.new
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



10
11
12
 
# File 'lib/conductor/http/api/user_resource_api.rb', line 10

def api_client
  @api_client
end

Instance Method Details

#check_permissions(user_id, target_type, target_id) ⇒ Object

Check permissions for a user



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/conductor/http/api/user_resource_api.rb', line 40

def check_permissions(user_id, target_type, target_id)
  @api_client.call_api(
    '/users/{userId}/checkPermissions',
    'GET',
    path_params: { userId: user_id },
    query_params: { type: target_type, id: target_id },
    return_type: 'Object',
    return_http_data_only: true
  )
end

#delete_user(id) ⇒ Object

Delete a user



35
36
37
 
# File 'lib/conductor/http/api/user_resource_api.rb', line 35

def delete_user(id)
  @api_client.call_api('/users/{id}', 'DELETE', path_params: { id: id }, return_http_data_only: true)
end

#get_granted_permissions(user_id) ⇒ Object

Get granted permissions for a user



52
53
54
55
 
# File 'lib/conductor/http/api/user_resource_api.rb', line 52

def get_granted_permissions(user_id)
  @api_client.call_api('/users/{userId}/permissions', 'GET', path_params: { userId: user_id },
                                                             return_type: 'Object', return_http_data_only: true)
end

#get_user(id) ⇒ Object

Get a user by ID



23
24
25
26
 
# File 'lib/conductor/http/api/user_resource_api.rb', line 23

def get_user(id)
  @api_client.call_api('/users/{id}', 'GET', path_params: { id: id }, return_type: 'ConductorUser',
                                             return_http_data_only: true)
end

#list_users(apps: false) ⇒ Object

List all users



29
30
31
32
 
# File 'lib/conductor/http/api/user_resource_api.rb', line 29

def list_users(apps: false)
  @api_client.call_api('/users', 'GET', query_params: { apps: apps }, return_type: 'Array<ConductorUser>',
                                        return_http_data_only: true)
end

#upsert_user(body, id) ⇒ Object

Create or update a user



17
18
19
20
 
# File 'lib/conductor/http/api/user_resource_api.rb', line 17

def upsert_user(body, id)
  @api_client.call_api('/users/{id}', 'PUT', path_params: { id: id }, body: body, return_type: 'ConductorUser',
                                             return_http_data_only: true)
end