Skip to content

Commit f204c7b

Browse files
committed
📝 Documentation updates
1 parent 19d4506 commit f204c7b

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

lib/oauth2/client.rb

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -291,6 +291,15 @@ def client_credentials
291291
@client_credentials ||= OAuth2::Strategy::ClientCredentials.new(self)
292292
end
293293

294+
# The Assertion strategy
295+
#
296+
# This allows for assertion-based authentication where an identity provider
297+
# asserts the identity of the user or client application seeking access.
298+
#
299+
# @see http://datatracker.ietf.org/doc/html/rfc7521
300+
# @see http://datatracker.ietf.org/doc/html/draft-ietf-oauth-assertions-01#section-4.1
301+
#
302+
# @return [OAuth2::Strategy::Assertion] the initialized Assertion strategy
294303
def assertion
295304
@assertion ||= OAuth2::Strategy::Assertion.new(self)
296305
end
@@ -523,4 +532,4 @@ def oauth_debug_logging(builder)
523532
builder.response(:logger, options[:logger], bodies: true) if OAuth2::OAUTH_DEBUG
524533
end
525534
end
526-
end
535+
end

0 commit comments

Comments
 (0)