Module: Oktakit::Client::AdminRoles

Included in:

Oktakit::Client

Defined in:

lib/oktakit/client/admin_roles.rb

Instance Method Summary

• #add_app_target_to_app_admin_role(user_id, role_id, app_name, options = {}) ⇒ Object

  Add App Target to App Admin Role.

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

  Add Group Target to User Admin Role.

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

  Assign Role to User.

• #list_app_targets_for_app_admin_role(user_id, role_id, options = {}) ⇒ Array<Sawyer::Resource>

  List App Targets for App Admin Role.

• #list_group_targets_for_user_admin_role(user_id, role_id, options = {}) ⇒ Array<Sawyer::Resource>

  List Group Targets for User Admin Role.

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

  List Roles Assigned to User.

• #remove_app_target_from_app_admin_role(user_id, role_id, app_name, options = {}) ⇒ Object

  Remove App Target from App Admin Role.

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

  Remove Group Target from User Admin Role.

• #unassign_role_from_user(user_id, role_id, options = {}) ⇒ Object

  Unassign Role from User.

Instance Method Details

#add_app_target_to_app_admin_role(user_id, role_id, app_name, options = {}) ⇒ Object

Add App Target to App Admin Role

Examples:

Oktakit.add_app_target_to_app_admin_role('user_id', 'role_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/roles.html#add-app-target-to-app-admin-role

# File 'lib/oktakit/client/admin_roles.rb', line 137

def add_app_target_to_app_admin_role(user_id, role_id, app_name, options = {})
  put("/users/#{user_id}/roles/#{role_id}/targets/catalog/apps/#{app_name}", options)
end

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

Add Group Target to User Admin Role

Examples:

Oktakit.add_group_target_to_user_admin_role('group_id', 'user_id', 'role_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/roles.html#add-group-target-to-user-admin-role

# File 'lib/oktakit/client/admin_roles.rb', line 84

def add_group_target_to_user_admin_role(user_id, role_id, group_id, options = {})
  put("/users/#{user_id}/roles/#{role_id}/targets/groups/#{group_id}", options)
end

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

Assign Role to User

Examples:

Oktakit.assign_role_to_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:

• (Hash<Sawyer::Resource>) —

  Assigned Role

See Also:

• http://developer.okta.com/docs/api/resources/roles.html#assign-role-to-user

# File 'lib/oktakit/client/admin_roles.rb', line 32

def assign_role_to_user(id, options = {})
  post("/users/#{id}/roles", options)
end

#list_app_targets_for_app_admin_role(user_id, role_id, options = {}) ⇒ Array<Sawyer::Resource>

List App Targets for App Admin Role

Examples:

Oktakit.list_app_targets_for_app_admin_role('user_id', 'role_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 Catalog Apps

See Also:

• http://developer.okta.com/docs/api/resources/roles.html#list-app-targets-for-app-admin-role

# File 'lib/oktakit/client/admin_roles.rb', line 119

def list_app_targets_for_app_admin_role(user_id, role_id, options = {})
  get("/users/#{user_id}/roles/#{role_id}/targets/catalog/apps", options)
end

#list_group_targets_for_user_admin_role(user_id, role_id, options = {}) ⇒ Array<Sawyer::Resource>

List Group Targets for User Admin Role

Examples:

Oktakit.list_group_targets_for_user_admin_role('user_id', 'role_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 Groups

See Also:

• http://developer.okta.com/docs/api/resources/roles.html#list-group-targets-for-user-admin-role

# File 'lib/oktakit/client/admin_roles.rb', line 66

def list_group_targets_for_user_admin_role(user_id, role_id, options = {})
  get("/users/#{user_id}/roles/#{role_id}/targets/groups", options)
end

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

List Roles Assigned to User

Examples:

Oktakit.list_roles_assigned_to_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:

• (Array<Sawyer::Resource>) —

  Array of Role

See Also:

• http://developer.okta.com/docs/api/resources/roles.html#list-roles-assigned-to-user

# File 'lib/oktakit/client/admin_roles.rb', line 16

def list_roles_assigned_to_user(id, options = {})
  get("/users/#{id}/roles", options)
end

#remove_app_target_from_app_admin_role(user_id, role_id, app_name, options = {}) ⇒ Object

Remove App Target from App Admin Role

Examples:

Oktakit.remove_app_target_from_app_admin_role('user_id', 'role_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/roles.html#remove-app-target-from-app-admin-role

# File 'lib/oktakit/client/admin_roles.rb', line 155

def remove_app_target_from_app_admin_role(user_id, role_id, app_name, options = {})
  delete("/users/#{user_id}/roles/#{role_id}/targets/catalog/apps/#{app_name}", options)
end

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

Remove Group Target from User Admin Role

Examples:

Oktakit.remove_group_target_from_user_admin_role('group_id', 'user_id', 'role_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/roles.html#remove-group-target-from-user-admin-role

# File 'lib/oktakit/client/admin_roles.rb', line 102

def remove_group_target_from_user_admin_role(user_id, role_id, group_id, options = {})
  delete("/users/#{user_id}/roles/#{role_id}/targets/groups/#{group_id}", options)
end

#unassign_role_from_user(user_id, role_id, options = {}) ⇒ Object

Unassign Role from User

Examples:

Oktakit.unassign_role_from_user('user_id', 'role_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/roles.html#unassign-role-from-user

# File 'lib/oktakit/client/admin_roles.rb', line 49

def unassign_role_from_user(user_id, role_id, options = {})
  delete("/users/#{user_id}/roles/#{role_id}", options)
end