module Oktakit::Client::Groups

Public Instance Methods

add_group(options = {}) click to toggle source

Add Group

@param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] The created Group. @see developer.okta.com/docs/api/resources/groups.html#add-group @example

Oktakit.add_group
# 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 = {}) click to toggle source

Add User to Group

@params group_id [string] Group ID @params user_id [string] User ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return HTTP 204 No Content @see developer.okta.com/docs/api/resources/groups.html#add-user-to-group @example

Oktakit.add_user_to_group('group_id', 'user_id')
# 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 = {}) click to toggle source

Get Group

@params id [string] Group ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Fetched Group @see developer.okta.com/docs/api/resources/groups.html#get-group @example

Oktakit.get_group('id')
# File lib/oktakit/client/groups.rb, line 31
def get_group(id, options = {})
  get("/groups/#{id}", options)
end
list_assigned_applications(id, options = {}) click to toggle source

List Assigned Applications

@params id [string] Group ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Array<Sawyer::Resource>] Array of Applications @see developer.okta.com/docs/api/resources/groups.html#list-assigned-applications @example

Oktakit.list_assigned_applications('id')
# 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 = {}) click to toggle source

List Group Members

@params id [string] Group ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Array<Sawyer::Resource>] Array of Users @see developer.okta.com/docs/api/resources/groups.html#list-group-members @example

Oktakit.list_group_members('id')
# File lib/oktakit/client/groups.rb, line 94
def list_group_members(id, options = {})
  get("/groups/#{id}/users", options)
end
list_groups(options = {}) click to toggle source

List Groups

@param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Array<Sawyer::Resource>] Array of Groups @see developer.okta.com/docs/api/resources/groups.html#list-groups @example

Oktakit.list_groups
# File lib/oktakit/client/groups.rb, line 46
def list_groups(options = {})
  get('/groups', options)
end
remove_group(id, options = {}) click to toggle source

Remove Group

@params id [string] Group ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return HTTP 204 No Content @see developer.okta.com/docs/api/resources/groups.html#remove-group @example

Oktakit.remove_group('id')
# 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 = {}) click to toggle source

Remove User from Group

@params group_id [string] Group ID @params user_id [string] User ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return HTTP 204 No Content @see developer.okta.com/docs/api/resources/groups.html#remove-user-from-group @example

Oktakit.remove_user_from_group('group_id', 'user_id')
# 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 = {}) click to toggle source

Update Group

@params id [string] Group ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Updated Group @see developer.okta.com/docs/api/resources/groups.html#update-group @example

Oktakit.update_group('id')
# File lib/oktakit/client/groups.rb, line 62
def update_group(id, options = {})
  put("/groups/#{id}", options)
end