Module: Oktakit::Client::Groups

Included in:

Oktakit::Client

Defined in:

lib/oktakit/client/groups.rb

Instance Method Summary

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

  Add Group.

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

  Add User to Group.

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

  Get Group.

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

  List Assigned Applications.

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

  List Group Members.

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

  List Groups.

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

  Remove Group.

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

  Remove User from Group.

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

  Update Group.

Instance Method Details

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

Add Group

Examples:

Oktakit.add_group

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  The created Group.

See Also:

• http://developer.okta.com/docs/api/resources/groups.html#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 = {}) ⇒ Object

Add User to Group

Examples:

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

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• HTTP 204 No Content

See Also:

• http://developer.okta.com/docs/api/resources/groups.html#add-user-to-group

# 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')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Fetched Group

See Also:

• http://developer.okta.com/docs/api/resources/groups.html#get-group

# 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')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Array<Sawyer::Resource>) —

  Array of Applications

See Also:

• http://developer.okta.com/docs/api/resources/groups.html#list-assigned-applications

# 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')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Array<Sawyer::Resource>) —

  Array of Users

See Also:

• http://developer.okta.com/docs/api/resources/groups.html#list-group-members

# 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

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Array<Sawyer::Resource>) —

  Array of Groups

See Also:

• http://developer.okta.com/docs/api/resources/groups.html#list-groups

# 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')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• HTTP 204 No Content

See Also:

• http://developer.okta.com/docs/api/resources/groups.html#remove-group

# 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')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• HTTP 204 No Content

See Also:

• http://developer.okta.com/docs/api/resources/groups.html#remove-user-from-group

# 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')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Updated Group

See Also:

• http://developer.okta.com/docs/api/resources/groups.html#update-group

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

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