Class: KeycloakAdmin::ClientScopeClient

Inherits:
Client
  • Object
show all
Defined in:
lib/keycloak-admin/client/client_scope_client.rb

Instance Method Summary collapse

Methods inherited from Client

#create_payload, #created_id, #current_token, #execute_http, #headers, #server_url

Constructor Details

#initialize(configuration, realm_client) ⇒ ClientScopeClient

Returns a new instance of ClientScopeClient.

Raises:

  • (ArgumentError) 


3
4
5
6
7
8
9
 
# File 'lib/keycloak-admin/client/client_scope_client.rb', line 3

def initialize(configuration, realm_client)
  super(configuration)

  raise ArgumentError.new("realm must be defined") unless realm_client.name_defined?

  @realm_client = realm_client
end

Instance Method Details

#client_scopes_url(client_scope_id = nil) ⇒ Object 



59
60
61
62
63
 
# File 'lib/keycloak-admin/client/client_scope_client.rb', line 59

def client_scopes_url(client_scope_id = nil)
  base = "#{@realm_client.realm_admin_url}/client-scopes"

  client_scope_id ? "#{base}/#{client_scope_id}" : base
end

#create!(client_scope_representation) ⇒ Object 



27
28
29
30
31
32
33
34
35
 
# File 'lib/keycloak-admin/client/client_scope_client.rb', line 27

def create!(client_scope_representation)
  execute_http do
    resource(client_scopes_url).post(
      create_payload(client_scope_representation), headers
    )
  end

  true
end

#delete(client_scope_id) ⇒ Object 



51
52
53
54
55
56
57
 
# File 'lib/keycloak-admin/client/client_scope_client.rb', line 51

def delete(client_scope_id)
  execute_http do
    resource(client_scopes_url(client_scope_id)).delete(headers)
  end

  true
end

#get(client_scope_id) ⇒ Object 



19
20
21
22
23
24
25
 
# File 'lib/keycloak-admin/client/client_scope_client.rb', line 19

def get(client_scope_id)
  response = execute_http do
    resource(client_scopes_url(client_scope_id)).get(headers)
  end

  ClientScopeRepresentation.from_hash(JSON.parse(response))
end

#list ⇒ Object 



11
12
13
14
15
16
17
 
# File 'lib/keycloak-admin/client/client_scope_client.rb', line 11

def list
  response = execute_http do
    resource(client_scopes_url).get(headers)
  end

  JSON.parse(response).map { |h| ClientScopeRepresentation.from_hash(h) }
end

#save(client_scope_representation) ⇒ Object 



37
38
39
40
41
42
43
44
45
 
# File 'lib/keycloak-admin/client/client_scope_client.rb', line 37

def save(client_scope_representation)
  execute_http do
    resource(client_scopes_url(client_scope_representation.id)).put(
      create_payload(client_scope_representation), headers
    )
  end

  true
end

#search(name) ⇒ Object 



47
48
49
 
# File 'lib/keycloak-admin/client/client_scope_client.rb', line 47

def search(name)
  list.select { |scope| scope&.name&.include?(name) }
end