Skip to content

README.md

Latest commit

 

History

History
146 lines (101 loc) · 9.08 KB

README.md

File metadata and controls

146 lines (101 loc) · 9.08 KB
Raw

Authorization

Overview

Available Operations

process_request

This API parses request parameters of an authorization request and returns necessary data for the authorization server implementation to process the authorization request further.

Example Usage

require 'authlete_ruby_sdk'

Models = ::Authlete::Models
s = ::Authlete::Client.new(
  bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.authorization.process_request(service_id: '<id>', authorization_request: Models::Components::AuthorizationRequest.new(
  parameters: 'response_type=code&client_id=26478243745571&redirect_uri=https%3A%2F%2Fmy-client.example.com%2Fcb1&scope=timeline.read+history.read&code_challenge=E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM&code_challenge_method=S256'
))

unless res.authorization_response.nil?
  # handle response
end

Parameters

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

Response

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

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 */*

fail_request

This API generates a content of an error authorization response that the authorization server implementation returns to the client application.

Example Usage

require 'authlete_ruby_sdk'

Models = ::Authlete::Models
s = ::Authlete::Client.new(
  bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.authorization.fail_request(service_id: '<id>', authorization_fail_request: Models::Components::AuthorizationFailRequest.new(
  ticket: 'qA7wGybwArICpbUSutrf5Xc9-i1fHE0ySOHxR1eBoBQ',
  reason: Models::Components::AuthorizationFailRequestReason::NOT_AUTHENTICATED
))

unless res.authorization_fail_response.nil?
  # handle response
end

Parameters

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

Response

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

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 parses request parameters of an authorization request and returns necessary data for the authorization server implementation to process the authorization request further.

Example Usage

require 'authlete_ruby_sdk'

Models = ::Authlete::Models
s = ::Authlete::Client.new(
  bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.authorization.issue_response(service_id: '<id>', authorization_issue_request: Models::Components::AuthorizationIssueRequest.new(
  ticket: 'FFgB9gwb_WXh6g1u-UQ8ZI-d_k4B-o-cm7RkVzI8Vnc',
  subject: 'john'
))

unless res.authorization_issue_response.nil?
  # handle response
end

Parameters

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

Response

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

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 */*