Skip to content

README.md

Latest commit

 

History

History
198 lines (139 loc) · 14.5 KB

README.md

File metadata and controls

198 lines (139 loc) · 14.5 KB
Raw

DynamicClientRegistration

Overview

Available Operations

register

Register a client. This API is supposed to be used to implement a client registration endpoint that complies with RFC 7591 (OAuth 2.0 Dynamic Client Registration Protocol).

Example Usage

require 'authlete_ruby_sdk'

Models = ::Authlete::Models
s = ::Authlete::Client.new(
  bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.dynamic_client_registration.register(service_id: '<id>', request_body: Models::Operations::ClientRegistrationApiRequestBody.new(
  json: '{ "client_name": "My Dynamic Client" }'
))

unless res.client_registration_response.nil?
  # handle response
end

Parameters

Parameter Type Required Description
service_id ::String ✔️ A service ID.
request_body Models::Operations::ClientRegistrationApiRequestBody ✔️ N/A

Response

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

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

retrieve

Get a dynamically registered client. This API is supposed to be used to implement a client registration management endpoint that complies with RFC 7592 (OAuth 2.0 Dynamic Registration Management).

Example Usage

require 'authlete_ruby_sdk'

Models = ::Authlete::Models
s = ::Authlete::Client.new(
  bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.dynamic_client_registration.retrieve(service_id: '<id>', request_body: Models::Operations::ClientRegistrationGetApiRequestBody.new(
  token: 'qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA',
  client_id: '26837717140341'
))

unless res.client_registration_response.nil?
  # handle response
end

Parameters

Parameter Type Required Description
service_id ::String ✔️ A service ID.
request_body Models::Operations::ClientRegistrationGetApiRequestBody ✔️ N/A

Response

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

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

update

Update a dynamically registered client. This API is supposed to be used to implement a client registration management endpoint that complies with RFC 7592 (OAuth 2.0 Dynamic Registration Management).

Example Usage

require 'authlete_ruby_sdk'

Models = ::Authlete::Models
s = ::Authlete::Client.new(
  bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.dynamic_client_registration.update(service_id: '<id>', request_body: Models::Operations::ClientRegistrationUpdateApiRequestBody.new(
  json: '{"client_name":"My Updated Dynamic Client","default_max_age":0,"registration_client_uri":"https://my-service.example.com/dcr/register/26837717140341","client_id":"26837717140341","token_endpoint_auth_method":"client_secret_basic","require_pushed_authorization_requests":false,"backchannel_user_code_parameter":false,"client_secret":"bMsjvZm2FE1_mqJgxhmYj_Wr8rA0Pia_A_j-V076qQm6-P1edKB055W579GBe7MSbOdxZ3dJKsKinCtdIFwxpw","tls_client_certificate_bound_access_tokens":false,"id_token_signed_response_alg":"RS256","subject_type":"public","require_signed_request_object":false}',
  token: 'qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA',
  client_id: '26837717140341'
))

unless res.client_registration_response.nil?
  # handle response
end

Parameters

Parameter Type Required Description
service_id ::String ✔️ A service ID.
request_body Models::Operations::ClientRegistrationUpdateApiRequestBody ✔️ N/A

Response

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

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

destroy

Delete a dynamically registered client. This API is supposed to be used to implement a client registration management endpoint that complies with RFC 7592 (OAuth 2.0 Dynamic Registration Management).

Example Usage

require 'authlete_ruby_sdk'

Models = ::Authlete::Models
s = ::Authlete::Client.new(
  bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.dynamic_client_registration.destroy(service_id: '<id>', request_body: Models::Operations::ClientRegistrationDeleteApiRequestBody.new(
  token: 'qs4Tu5TV7qqDYT93bFs6ISyhTByMF9o-54GY4JU5vTA',
  client_id: '26837717140341'
))

unless res.client_registration_response.nil?
  # handle response
end

Parameters

Parameter Type Required Description
service_id ::String ✔️ A service ID.
request_body Models::Operations::ClientRegistrationDeleteApiRequestBody ✔️ N/A

Response

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

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