module Oktakit::Client::AdminRoles
Public Instance Methods
Add App Target to App Admin Role
@params user_id [string] User ID @params role_id [string] Role ID @params app_name [string] App Name @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/roles.html#add-app-target-to-app-admin-role @example
Oktakit.add_app_target_to_app_admin_role('user_id', 'role_id')
# 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
@params user_id [string] User ID @params role_id [string] Role ID @params group_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/roles.html#add-group-target-to-user-admin-role @example
Oktakit.add_group_target_to_user_admin_role('group_id', 'user_id', 'role_id')
# 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
@params 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 [Hash<Sawyer::Resource>] Assigned Role @see developer.okta.com/docs/api/resources/roles.html#assign-role-to-user @example
Oktakit.assign_role_to_user('id')
# 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
@params user_id [string] User ID @params role_id [string] Role 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 Catalog Apps
@see developer.okta.com/docs/api/resources/roles.html#list-app-targets-for-app-admin-role @example
Oktakit.list_app_targets_for_app_admin_role('user_id', 'role_id')
# 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
@params user_id [string] User ID @params role_id [string] Role 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 Groups
@see developer.okta.com/docs/api/resources/roles.html#list-group-targets-for-user-admin-role @example
Oktakit.list_group_targets_for_user_admin_role('user_id', 'role_id')
# 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
@params 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 [Array<Sawyer::Resource>] Array of Role @see developer.okta.com/docs/api/resources/roles.html#list-roles-assigned-to-user @example
Oktakit.list_roles_assigned_to_user('id')
# 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
@params user_id [string] User ID @params role_id [string] Role ID @params app_name [string] App Name @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/roles.html#remove-app-target-from-app-admin-role @example
Oktakit.remove_app_target_from_app_admin_role('user_id', 'role_id')
# 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
@params user_id [string] User ID @params role_id [string] Role ID @params group_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/roles.html#remove-group-target-from-user-admin-role @example
Oktakit.remove_group_target_from_user_admin_role('group_id', 'user_id', 'role_id')
# 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
@params user_id [string] User ID @params role_id [string] Role 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/roles.html#unassign-role-from-user @example
Oktakit.unassign_role_from_user('user_id', 'role_id')
# 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