From 431cb397d90d8f5c8194196a0dd37b80c6002719 Mon Sep 17 00:00:00 2001 From: r4cc00n Date: Mon, 22 Nov 2021 21:00:54 +0100 Subject: [PATCH] fixed documentation --- lib/oktakit/client/users.rb | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/oktakit/client/users.rb b/lib/oktakit/client/users.rb index 882fad6..c4512d4 100644 --- a/lib/oktakit/client/users.rb +++ b/lib/oktakit/client/users.rb @@ -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] Returns empty object by default. If sendEmail is false, a user reactivation link. + # @return [Hash]. # @note The user must be in a PROVISIONED status # @see https://developer.okta.com/docs/reference/api/users/#reactivate-user # @example @@ -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] 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 = {})