Class: Conductor::Http::Api::AuthorizationResourceApi

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

Overview

AuthorizationResourceApi - API for permission management operations (Orkes)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = nil) ⇒ AuthorizationResourceApi

Returns a new instance of AuthorizationResourceApi.



12
13
14
 
# File 'lib/conductor/http/api/authorization_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/authorization_resource_api.rb', line 10

def api_client
  @api_client
end

Instance Method Details

#get_permissions(type, id) ⇒ Hash

Get permissions for a target

Parameters:

  • type (String) —

    Target type

  • id (String) —

    Target ID

Returns:

  • (Hash) 


32
33
34
35
36
37
38
39
40
 
# File 'lib/conductor/http/api/authorization_resource_api.rb', line 32

def get_permissions(type, id)
  @api_client.call_api(
    '/auth/authorization/{type}/{id}',
    'GET',
    path_params: { type: type, id: id },
    return_type: 'Object',
    return_http_data_only: true
  )
end

#grant_permissions(body) ⇒ void

This method returns an undefined value.

Grant permissions

Parameters:

  • body (AuthorizationRequest) —

    Authorization request



19
20
21
22
23
24
25
26
 
# File 'lib/conductor/http/api/authorization_resource_api.rb', line 19

def grant_permissions(body)
  @api_client.call_api(
    '/auth/authorization',
    'POST',
    body: body,
    return_http_data_only: true
  )
end

#remove_permissions(body) ⇒ void

This method returns an undefined value.

Remove permissions

Parameters:

  • body (AuthorizationRequest) —

    Authorization request



45
46
47
48
49
50
51
52
 
# File 'lib/conductor/http/api/authorization_resource_api.rb', line 45

def remove_permissions(body)
  @api_client.call_api(
    '/auth/authorization',
    'DELETE',
    body: body,
    return_http_data_only: true
  )
end