OAuth2 / OpenID Connect Client Registration #
This document outlines the information required for OAuth2, OpenID Connect client registration with Nature’s OAuth2, OpenID Connect provider.
OAuth2, OpenID Connect client registration is limited to corporate users only. If you wish to register a client, please contact us through our Nature Business page.
Client Configuration #
Nature provides a standard OpenID Connect configuration at:
https://api.nature.global/.well-known/openid-configuration
This endpoint follows the OpenID Connect Discovery 1.0 specification (OpenID Foundation).
Required Client Information #
To register your OAuth2, OpenID Connect client, please provide the following information:
Application Details #
- Application Name: The name of your application
- Application Description (English): Brief description shown to users in English
- Application Description (Japanese): Brief description shown to users in Japanese (日本語での説明)
These descriptions will be displayed on home.nature.global where users can view scopes of authorized applications and revoke access.
Technical Configuration #
- Redirect URIs: Complete list of allowed redirect URIs for your application
- Must be valid HTTPS URLs (except for localhost during development)
- Should include all URLs where your application expects to receive authorization codes.
- Scopes: Select the OAuth2 scopes your application requires
Available Scopes #
| Scope | Description (EN) | Description (JA) |
|---|---|---|
openid |
Get Nature user ID (not including E-mail) | Nature ユーザー ID(E-Mail を含まない)の取得 |
basic |
Read and write your profile (not including E-mail) and home appliances | プロフィール(E-Mail を含まない)、Nature Remo、家電の取得および編集。センサーデータの取得。 |
basic.read |
Read only access to your profile (not including E-mail), Nature Remo, home appliances and signals | プロフィール(E-Mail を含まない)、Nature Remo、家電、信号の取得。センサーデータの取得。 |
home |
Read and write user’s home information | 家の情報の取得および編集 |
home.read |
Read only access to user’s home information | 家の情報の取得 |
detectappliance |
Detect air conditioner model from infrared signals | 赤外線信号からエアコンのモデルを認識 |
sendir |
Send IR signals and control home appliances | リモコン信号の送信と家電の操作 |
sendrawir |
Send raw IR signals directly to your home appliances | 任意の赤外線信号を家電に送信して操作 |
elapi |
Use ECHONET Lite API | ECHONET Lite API の使用 |
echonetlite |
Use ECHONET Lite to monitor and control home appliances | ECHONET Lite を使用して家電の状態の取得と操作 |
Note: Scopes separated with a . present hierarchy. eg: basic includes basic.read.
User Consent Interface #
Application descriptions will be displayed on home.nature.global, allowing users to:
- View applications, descriptions, and scopes that have access to their account
- Revoke access tokens
Example consent screen for home.nature.global:
Example list of access tokens:
