Skip to content

README.md

Latest commit

 

History

History
96 lines (65 loc) · 5.2 KB

README.md

File metadata and controls

96 lines (65 loc) · 5.2 KB
Raw

Userinfo

Overview

Available Operations

process_request

This API gathers information about a user.

Example Usage

require 'authlete_ruby_sdk'

Models = ::Authlete::Models
s = ::Authlete::Client.new(
  bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.userinfo.process_request(service_id: '<id>', userinfo_request: Models::Components::UserinfoRequest.new(
  token: 'Ntm9MDb8WXQAevqrBkd84KTTHbYHVQrTjgUZCOWqEUI'
))

unless res.userinfo_response.nil?
  # handle response
end

Parameters

Parameter Type Required Description
service_id ::String ✔️ A service ID.
userinfo_request Models::Components::UserinfoRequest ✔️ N/A

Response

T.nilable(Models::Operations::AuthUserinfoApiResponse)

Errors

Error Type Status Code Content Type
Models::Errors::ResultError 400, 401, 403 application/json
Models::Errors::ResultError 500 application/json
Errors::APIError 4XX, 5XX */*

issue_response

This API generates an ID token.

Example Usage

require 'authlete_ruby_sdk'

Models = ::Authlete::Models
s = ::Authlete::Client.new(
  bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.userinfo.issue_response(service_id: '<id>', userinfo_issue_request: Models::Components::UserinfoIssueRequest.new(
  token: 'Ntm9MDb8WXQAevqrBkd84KTTHbYHVQrTjgUZCOWqEUI'
))

unless res.userinfo_issue_response.nil?
  # handle response
end

Parameters

Parameter Type Required Description
service_id ::String ✔️ A service ID.
userinfo_issue_request Models::Components::UserinfoIssueRequest ✔️ N/A

Response

T.nilable(Models::Operations::AuthUserinfoIssueApiResponse)

Errors

Error Type Status Code Content Type
Models::Errors::ResultError 400, 401, 403 application/json
Models::Errors::ResultError 500 application/json
Errors::APIError 4XX, 5XX */*