Module: Oktakit::Client::Groups

Included in:
Oktakit::Client
Defined in:
lib/oktakit/client/groups.rb

Instance Method Summary collapse

Instance Method Details

#add_group(options = {}) ⇒ Hash<Sawyer::Resource>

Add Group

Examples:

Oktakit.add_group

See Also:



15
16
17
 
# File 'lib/oktakit/client/groups.rb', line 15

def add_group(options = {})
  post('/groups', options)
end

#add_user_to_group(group_id, user_id, options = {}) ⇒ Object

Add User to Group

Examples:

Oktakit.add_user_to_group('group_id', 'user_id')

See Also:



111
112
113
 
# File 'lib/oktakit/client/groups.rb', line 111

def add_user_to_group(group_id, user_id, options = {})
  put("/groups/#{group_id}/users/#{user_id}", options)
end

#get_group(id, options = {}) ⇒ Hash<Sawyer::Resource>

Get Group

Examples:

Oktakit.get_group('id')

See Also:



31
32
33
 
# File 'lib/oktakit/client/groups.rb', line 31

def get_group(id, options = {})
  get("/groups/#{id}", options)
end

#list_assigned_applications(id, options = {}) ⇒ Array<Sawyer::Resource>

List Assigned Applications

Examples:

Oktakit.list_assigned_applications('id')

See Also:



144
145
146
 
# File 'lib/oktakit/client/groups.rb', line 144

def list_assigned_applications(id, options = {})
  get("/groups/#{id}/apps", options)
end

#list_group_members(id, options = {}) ⇒ Array<Sawyer::Resource>

List Group Members

Examples:

Oktakit.list_group_members('id')

See Also:



94
95
96
 
# File 'lib/oktakit/client/groups.rb', line 94

def list_group_members(id, options = {})
  get("/groups/#{id}/users", options)
end

#list_groups(options = {}) ⇒ Array<Sawyer::Resource>

List Groups

Examples:

Oktakit.list_groups

See Also:



46
47
48
 
# File 'lib/oktakit/client/groups.rb', line 46

def list_groups(options = {})
  get('/groups', options)
end

#remove_group(id, options = {}) ⇒ Object

Remove Group

Examples:

Oktakit.remove_group('id')

See Also:



78
79
80
 
# File 'lib/oktakit/client/groups.rb', line 78

def remove_group(id, options = {})
  delete("/groups/#{id}", options)
end

#remove_user_from_group(group_id, user_id, options = {}) ⇒ Object

Remove User from Group

Examples:

Oktakit.remove_user_from_group('group_id', 'user_id')

See Also:



128
129
130
 
# File 'lib/oktakit/client/groups.rb', line 128

def remove_user_from_group(group_id, user_id, options = {})
  delete("/groups/#{group_id}/users/#{user_id}", options)
end

#update_group(id, options = {}) ⇒ Hash<Sawyer::Resource>

Update Group

Examples:

Oktakit.update_group('id')

See Also:



62
63
64
 
# File 'lib/oktakit/client/groups.rb', line 62

def update_group(id, options = {})
  put("/groups/#{id}", options)
end