Skip to content

Commit

Permalink
fixed documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
r4cc00n committed Nov 22, 2021
1 parent 63eb855 commit 431cb39
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions lib/oktakit/client/users.rb
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ def activate_user(id, options = {})
# @param options[:accept] [String] Optional. The content type to accept. Default application/json
# @param options[:content_type] [String] Optional. The content type for the request. Default application/json
# @param options [Hash] Optional. Body params for request.
# @return [Hash<Sawyer::Resource>] Returns empty object by default. If sendEmail is false, a user reactivation link.
# @return [Hash<Sawyer::Resource>].
# @note The user must be in a PROVISIONED status
# @see https://developer.okta.com/docs/reference/api/users/#reactivate-user
# @example
Expand Down Expand Up @@ -172,11 +172,11 @@ def deactivate_user(id, options = {})
# @param options[:headers] [Hash] Optional. Header params for the request.
# @param options[:accept] [String] Optional. The content type to accept. Default application/json
# @param options[:content_type] [String] Optional. The content type for the request. Default application/json
# @param options [Hash] Optional. Body params for request.
# @return [Hash<Sawyer::Resource>] Returns an empty object.
# @param options [Hash] Optional. Body params for the request.
# @return 204 'No Content'
# @note Deletes a user permanently. This operation can only be performed on users that have a DEPROVISIONED status. This action cannot be recovered!
# This operation on a user that hasn't been deactivated causes that user to be deactivated. A second delete operation is required to delete the user.
# @see https://developer.okta.com/docs/api/resources/users#deactivate-user
# @see https://developer.okta.com/docs/reference/api/users/#delete-user
# @example
# Oktakit.delete_user('id')
def delete_user(id, options = {})
Expand Down

0 comments on commit 431cb39

Please sign in to comment.