- retrieve - Get Client
- list - List Clients
- create - Create Client
- update - Update Client
- update_form - Update Client
- destroy - Delete Client ⚡
Get a client.
require 'authlete_ruby_sdk'
Models = ::Authlete::Models
s = ::Authlete::Client.new(
bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.clients.retrieve(service_id: '<id>', client_id: '<id>')
unless res.client.nil?
# handle response
end| Parameter | Type | Required | Description |
|---|---|---|---|
service_id |
::String | ✔️ | A service ID. |
client_id |
::String | ✔️ | A client ID. |
T.nilable(Models::Operations::ClientGetApiResponse)
| Error Type | Status Code | Content Type |
|---|---|---|
| Models::Errors::ResultError | 400, 401, 403 | application/json |
| Models::Errors::ResultError | 500 | application/json |
| Errors::APIError | 4XX, 5XX | */* |
Get a list of clients on a service.
If the access token can view a full service (including an admin), all clients within the service are returned. Otherwise, only clients that the access token can view within the service are returned.
- ViewClient: []
require 'authlete_ruby_sdk'
Models = ::Authlete::Models
s = ::Authlete::Client.new(
bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.clients.list(service_id: '<id>')
unless res.client_get_list_response.nil?
# handle response
endrequire 'authlete_ruby_sdk'
Models = ::Authlete::Models
s = ::Authlete::Client.new(
bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.clients.list(service_id: '<id>')
unless res.client_get_list_response.nil?
# handle response
end| Parameter | Type | Required | Description |
|---|---|---|---|
service_id |
::String | ✔️ | A service ID. |
developer |
T.nilable(::String) | ➖ | The developer of client applications. The default value is null. If this parameter is not set to null, client application of the specified developer are returned. Otherwise, all clientapplications that belong to the service are returned. |
start |
T.nilable(::Integer) | ➖ | Start index (inclusive) of the result set. The default value is 0. Must not be a negative number. |
end_ |
T.nilable(::Integer) | ➖ | End index (exclusive) of the result set. The default value is 5. Must not be a negative number. |
T.nilable(Models::Operations::ClientGetListApiResponse)
| Error Type | Status Code | Content Type |
|---|---|---|
| Models::Errors::ResultError | 400, 401, 403 | application/json |
| Models::Errors::ResultError | 500 | application/json |
| Errors::APIError | 4XX, 5XX | */* |
Create a new client.
require 'authlete_ruby_sdk'
Models = ::Authlete::Models
s = ::Authlete::Client.new(
bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.clients.create(service_id: '<id>', client: Models::Components::ClientInput.new(
client_name: 'My Client',
client_id_alias: 'my-client',
client_id_alias_enabled: true,
client_type: Models::Components::ClientType::CONFIDENTIAL,
application_type: Models::Components::ApplicationType::WEB,
developer: 'john',
grant_types: [
Models::Components::GrantType::AUTHORIZATION_CODE,
Models::Components::GrantType::REFRESH_TOKEN,
],
response_types: [
Models::Components::ResponseType::CODE,
Models::Components::ResponseType::TOKEN,
],
redirect_uris: [
'https://my-client.example.com/cb1',
'https://my-client.example.com/cb2',
],
token_auth_method: Models::Components::ClientAuthMethod::CLIENT_SECRET_BASIC,
attributes: [
Models::Components::Pair.new(
key: 'attribute1-key',
value: 'attribute1-value'
),
Models::Components::Pair.new(
key: 'attribute2-key',
value: 'attribute2-value'
),
]
))
unless res.client.nil?
# handle response
end| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
service_id |
::String | ✔️ | A service ID. | |
client |
T.nilable(Models::Components::ClientInput) | ➖ | N/A | { "number": 1140735077, "serviceNumber": 715948317, "clientName": "My Test Client", "clientId": "1140735077", "clientSecret": "gXz97ISgLs4HuXwOZWch8GEmgL4YMvUJwu3er_kDVVGcA0UOhA9avLPbEmoeZdagi9yC_-tEiT2BdRyH9dbrQQ", "clientType": "PUBLIC", "redirectUris": [ "https://example.com/callback" ], "responseTypes": [ "CODE" ], "grantTypes": [ "AUTHORIZATION_CODE" ] } |
T.nilable(Models::Operations::ClientCreateApiResponse)
| 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 a client.
require 'authlete_ruby_sdk'
Models = ::Authlete::Models
s = ::Authlete::Client.new(
bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.clients.update(service_id: '<id>', client_id: '<id>', client: Models::Components::ClientInput.new(
client_name: 'My updated client',
client_id_alias: 'my-client',
client_id_alias_enabled: true,
client_type: Models::Components::ClientType::CONFIDENTIAL,
application_type: Models::Components::ApplicationType::WEB,
tls_client_certificate_bound_access_tokens: false,
developer: 'john',
grant_types: [
Models::Components::GrantType::AUTHORIZATION_CODE,
Models::Components::GrantType::REFRESH_TOKEN,
],
response_types: [
Models::Components::ResponseType::CODE,
Models::Components::ResponseType::TOKEN,
],
redirect_uris: [
'https://my-client.example.com/cb1',
'https://my-client.example.com/cb2',
],
token_auth_method: Models::Components::ClientAuthMethod::CLIENT_SECRET_BASIC,
par_required: false,
request_object_required: false,
default_max_age: 0,
id_token_sign_alg: Models::Components::JwsAlg::RS256,
auth_time_required: false,
subject_type: Models::Components::SubjectType::PUBLIC,
bc_user_code_required: false,
attributes: [
Models::Components::Pair.new(
key: 'attribute1-key',
value: 'attribute1-value'
),
Models::Components::Pair.new(
key: 'attribute2-key',
value: 'attribute2-value'
),
],
front_channel_request_object_encryption_required: false,
request_object_encryption_alg_match_required: false,
request_object_encryption_enc_match_required: false,
additional_properties: {
'derivedSectorIdentifier' => 'my-client.example.com',
'dynamicallyRegistered' => false,
}
))
unless res.client.nil?
# handle response
end| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
service_id |
::String | ✔️ | A service ID. | |
client_id |
::String | ✔️ | A client ID. | |
client |
T.nilable(Models::Components::ClientInput) | ➖ | N/A | { "number": 1140735077, "serviceNumber": 715948317, "clientName": "My Test Client", "clientId": "1140735077", "clientSecret": "gXz97ISgLs4HuXwOZWch8GEmgL4YMvUJwu3er_kDVVGcA0UOhA9avLPbEmoeZdagi9yC_-tEiT2BdRyH9dbrQQ", "clientType": "PUBLIC", "redirectUris": [ "https://example.com/callback" ], "responseTypes": [ "CODE" ], "grantTypes": [ "AUTHORIZATION_CODE" ] } |
T.nilable(Models::Operations::ClientUpdateApiResponse)
| 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 a client.
require 'authlete_ruby_sdk'
Models = ::Authlete::Models
s = ::Authlete::Client.new(
bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.clients.update_form(service_id: '<id>', client_id: '<id>', request_body: {
'clientId' => '1140735077',
'clientName' => 'My Test Client',
'clientSecret' => 'gXz97ISgLs4HuXwOZWch8GEmgL4YMvUJwu3er_kDVVGcA0UOhA9avLPbEmoeZdagi9yC_-tEiT2BdRyH9dbrQQ',
'clientType' => 'PUBLIC',
'grantTypes' => [
'AUTHORIZATION_CODE',
],
'number' => 1_140_735_077,
'redirectUris' => [
'https://example.com/callback',
],
'responseTypes' => [
'CODE',
],
'serviceNumber' => 715_948_317,
})
unless res.client.nil?
# handle response
end| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
service_id |
::String | ✔️ | A service ID. | |
client_id |
::String | ✔️ | A client ID. | |
request_body |
T::Hash[Symbol, ::Object] | ➖ | N/A | { "number": 1140735077, "serviceNumber": 715948317, "clientName": "My Test Client", "clientId": "1140735077", "clientSecret": "gXz97ISgLs4HuXwOZWch8GEmgL4YMvUJwu3er_kDVVGcA0UOhA9avLPbEmoeZdagi9yC_-tEiT2BdRyH9dbrQQ", "clientType": "PUBLIC", "redirectUris": [ "https://example.com/callback" ], "responseTypes": [ "CODE" ], "grantTypes": [ "AUTHORIZATION_CODE" ] } |
T.nilable(Models::Operations::ClientUpdateApiFormResponse)
| Error Type | Status Code | Content Type |
|---|---|---|
| Models::Errors::ResultError | 400, 401, 403 | application/json |
| Models::Errors::ResultError | 500 | application/json |
| Errors::APIError | 4XX, 5XX | */* |
Delete a client.
require 'authlete_ruby_sdk'
Models = ::Authlete::Models
s = ::Authlete::Client.new(
bearer: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.clients.destroy(service_id: '<id>', client_id: '<id>')
if res.status_code == 200
# handle response
end| Parameter | Type | Required | Description |
|---|---|---|---|
service_id |
::String | ✔️ | A service ID. |
client_id |
::String | ✔️ | The client ID. |
T.nilable(Models::Operations::ClientDeleteApiResponse)
| Error Type | Status Code | Content Type |
|---|---|---|
| Models::Errors::ResultError | 400, 401, 403 | application/json |
| Models::Errors::ResultError | 500 | application/json |
| Errors::APIError | 4XX, 5XX | */* |