OAuth
OAuthは、インターネット上の他のアプリケーションが、Neosパスワードを共有することなく、あなたのNeosアカウントの詳細にアクセスすることを可能にするオープンスタンダードです。OAuthは「同意に基づく」プロセスを提供し、データを交換する前に、ユーザーがアプリケーションにアクセスを許可することに同意していることを確認します。OAuthはインターネット上で一般的に使用されており、多くのアプリケーションでサポートされています。
OAuthをご存知ですか? クイックステップにジャンプして、URLを取得してください。
OAuthの状況
NeosのOAuthはまだ初期段階であり、利用するにはアプリケーションの登録が必要で、現在は手動で承認するしかありません。また、今はまだOAuthを使って多くのことができませんが、これは将来的に拡張される予定です。
よくある質問
OAuthは複雑な機能であり、そのため、どのように機能するかについてよくある質問があります。
OAuthによって他の人が私のデータにアクセスできますか?
OAuthは、あなたの同意なしにNeosアカウントにアクセスすることはできません。
Neosの内部でOAuthを使用することはできますか?
現在、OAuthをサポートするNeosコンポーネント、LogiXノード、その他のNeos内のエレメントはありません。また、OAuthは、リダイレクトURLが必要なため、LogiXを使用して手動で処理することができません。将来的に変更される可能性があります。
OAuthを使って、Google/Facebook/Dropboxなどにログイン/アクセスできますか?
いいえ、このページとNeosの機能におけるOAuthは、他のサービスがあなたのアカウントに接続できるように設計されており、その逆はありません。
例
ここでは、NeosとOAuthを使って将来可能になるかもしれないことの例をいくつか挙げています。これらのアプリケーションはどれも存在しません、これらはできるかもしれないことの例に過ぎません。
- イベント登録 - イベント登録システムの一部として、Neosアカウントとイベント登録システムをリンクするよう求められる可能性があります。これにより、お客を安全に識別し、特定のNeosユーザーであることを証明し、有料イベント、セッション、ワークショップなどにアクセスできるようになります。
- ユーティリティ/アプリケーション - サードパーティのアプリケーションを使用して、Neosの外部でフレンドやメッセージなどを管理できます。
- 管理 - Neosの外からNeosのプロフィールやインベントリーを編集することができます。
= OAuthの必要条件= OAuthを使用するには、以下のものが必要です。
- Neosに登録されたアプリケーション/クライアント
- 登録したアプリケーションの OAuth クライアント ID とクライアントシークレット。
- 使用したいスコープのリスト。
- ウェブサーバー - OAuthの認証処理を行うには、ウェブアプリケーション/サーバーが必要です。
アプリケーションの登録
アプリケーションを登録するには、hello@neos.com にメールを送る必要があります。メールには以下の内容を記載してください。
- 名前
- アクセスを要求する理由
- アプリケーションの名前
OAuthコールバック/リダイレクトURL - これは、OAuthプロセスの一部として、ユーザーをあなたのアプリケーションにリダイレクトするためにNeosが使用するURLです。通常、ウェブサーバー上で実行する必要があります。
一時的に新規登録の受付を停止しています。今後の更新をお待ちください。
OAuthフロー
以上の要件が揃えば、いよいよスタートです!
NeosはAuthorization Code OAuth Flowを使用しています。これは非常に複雑なので、使用する言語や環境のガイドに従うことをお勧めします。一般的なガイドは、一般的なガイドにあります。 以下は基本的な説明で、読み進める前に役に立つかもしれません。
- ユーザはあなたのアプリケーションで認証します。例: CoolApp.com.
- 認証されると, リンクかボタンがユーザに提示され, Neosアカウントにログイン/リンクするように要求されます.
- このリンクは、標準的な認証コードフローパラメータを使用して、https://auth.neos.com/connect/authorize にリダイレクトする必要があります。
- Neosは、ユーザーにNeosアカウントを使用してログインするように要求します。
- ユーザーがログインすると、アプリケーションのNeosアカウントへのアクセスを許可するよう求めるメッセージが表示されます。
- ユーザーが同意すると、登録されたアプリケーションのリダイレクトURLにリダイレクトされます。
- このリダイレクトURLには、あなたのサーバーでアクセストークンと交換するための認証コードが含まれています。トークンのURLは以下の通りです: https://cloudx-account.azurewebsites.net/.
アクセストークンの使用方法
現在、トークンを取得すると、限られた数のエンドポイントを呼び出すために使用することができます。これらのエンドポイントは将来的に増加する可能性があります。
プロファイル・エンドポイント
https://auth.neos.com/api/user/profiles
を呼び出す。ヘッダにあなたのトークンを指定します。Authorization: Bearer [token]
とすると、JSON形式の標準的なNeosユーザー・プロファイルが提供されます。
これを受け取るには、profile
スコープを確実にリクエストする必要があります。
さらに、いくつかのスコープを追加することで、いくつかの追加情報にアクセスすることができます。こちらを確認くださいScopes。
クイック解説
こんなことしたことある?このセクションはあなたのためのものです
- ネオスは認証コード/グラントフローを使用します。
- アプリケーションの登録が必要です。
- クライアントID、クライアントシークレットが必要です。
エンドポイント
- 認証を:
https://auth.neos.com/connect/authorize
- トークン:
https://auth.neos.com/connect/token
- ヘッダ:
Authorization: Bearer [token]
スコープ
スコープ名 | 解説 |
---|---|
profile | ユーザー名、プロフィール画像などのプロフィール情報を取得することができます。 |
Userのメールをprofile responseに表示できるようにする。 | |
patreon | ユーザーのPatreon情報をprofile responseで提供する。 |
外部リンク
- OAuthの仕様 - 76ページの技術情報です。
- OAuthの簡易解説 - OAuthの多くの部分の簡略化された説明です。一部のページでは有料サービスにリンクしていますが、OAuthを使用するためにこのサービスが必要なわけではないことに注意してください。
- Wikipedia - WikipediaのOAuthに関するページです。
- ProbablePrimeによるOAuthアプリケーションの例
This article or section is a Stub. You can help the Neos Wiki by expanding it.