Module: Oktakit::Client::GroupRules

Included in:

Oktakit::Client

Defined in:

lib/oktakit/client/group_rules.rb

Instance Method Summary

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

  Activate Group Rule.

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

  Add Group Rule.

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

  Deactivate Group Rule.

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

  Get Group Rule.

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

  List Group Rules.

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

  Remove Group Rule.

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

  Update Group Rule.

Instance Method Details

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

Activate Group Rule

Examples:

Oktakit.activate_group_rule('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:

• https://developer.okta.com/docs/reference/api/groups/#activate-a-group-rule

# File 'lib/oktakit/client/group_rules.rb', line 94

def activate_group_rule(id, options = {})
  post("/groups/rules/#{id}/lifecycle/activate", options)
end

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

Add Group Rule

Examples:

Oktakit.add_group_rule

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 Rule.

See Also:

• https://developer.okta.com/docs/reference/api/groups/#create-group-rule

# File 'lib/oktakit/client/group_rules.rb', line 15

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

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

Deactivate Group Rule

Examples:

Oktakit.deactivate_group_rule('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:

• https://developer.okta.com/docs/reference/api/groups/#deactivate-a-group-rule

# File 'lib/oktakit/client/group_rules.rb', line 110

def deactivate_group_rule(id, options = {})
  post("/groups/rules/#{id}/lifecycle/deactivate", options)
end

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

Get Group Rule

Examples:

Oktakit.get_group_rule('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 Rule

See Also:

• https://developer.okta.com/docs/reference/api/groups/#get-group-rule

# File 'lib/oktakit/client/group_rules.rb', line 31

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

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

List Group Rules

Examples:

Oktakit.list_group_rules

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 Group Rules

See Also:

• https://developer.okta.com/docs/reference/api/groups/#list-group-rules

# File 'lib/oktakit/client/group_rules.rb', line 46

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

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

Remove Group Rule

Examples:

Oktakit.remove_group_rule('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 202 Accepted

See Also:

• https://developer.okta.com/docs/reference/api/groups/#delete-a-group-rule

# File 'lib/oktakit/client/group_rules.rb', line 78

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

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

Update Group Rule

Examples:

Oktakit.update_group_rule('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 Rule

See Also:

• https://developer.okta.com/docs/reference/api/groups/#update-group-rule

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

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