Skip to content

README.md

Latest commit

 

History

History
149 lines (104 loc) · 9.08 KB

README.md

File metadata and controls

149 lines (104 loc) · 9.08 KB
Raw

DeviceFlow

Overview

Available Operations

authorization

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

Example Usage

require 'authlete_ruby_sdk'

Models = ::Authlete::Models
s = ::Authlete::Client.new(
  bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.device_flow.authorization(service_id: '<id>', device_authorization_request: Models::Components::DeviceAuthorizationRequest.new(
  parameters: 'client_id=26888344961664&scope=history.read',
  client_id: '26888344961664',
  client_secret: 'SfnYOLkJdofrb_66mTd6q03_SDoDEUnpXtvqFaE4k6L6UcpZzbdVJi2GpBj48AvGeDDllwsTruC62WYqQ_LGog'
))

unless res.device_authorization_response.nil?
  # handle response
end

Parameters

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

Response

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

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

verification

The API returns information associated with a user code.

Example Usage

require 'authlete_ruby_sdk'

Models = ::Authlete::Models
s = ::Authlete::Client.new(
  bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.device_flow.verification(service_id: '<id>', device_verification_request: Models::Components::DeviceVerificationRequest.new(
  user_code: 'XWWKPBWVXQ'
))

unless res.device_verification_response.nil?
  # handle response
end

Parameters

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

Response

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

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

complete_request

This API returns information about what action the authorization server should take after it receives the result of end-user's decision about whether the end-user has approved or rejected a client application's request.

Example Usage

require 'authlete_ruby_sdk'

Models = ::Authlete::Models
s = ::Authlete::Client.new(
  bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.device_flow.complete_request(service_id: '<id>', device_complete_request: Models::Components::DeviceCompleteRequest.new(
  user_code: 'XWWKPBWVXQ',
  result: Models::Components::DeviceCompleteRequestResult::AUTHORIZED,
  subject: 'john'
))

unless res.device_complete_response.nil?
  # handle response
end

Parameters

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

Response

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

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