OAuth 1.0a
OAuth 2.0 Bearer Token
POST oauth/request_token
consumer アプリケーションが OAuth Request Token を取得してユーザー認可を要求できるようにします。このメソッドは OAuth 1.0 認証フロー の Section 6.1 を満たします。 すべての OAuth 認可ステップで HTTPS の使用が必須です。 使用上の注意:oauth_nonce には ASCII 値のみが受け付けられます。
リソース URL
https://api.x.com/oauth/request_token
リソース情報
パラメーター
コールバック URL の承認方法については こちらのページ を参照してください。
注意事項 - developer.x.com で X アカウントにログインしている場合、X app dashboard から既存の X アプリ を確認・編集できます。
リクエスト例
リクエスト URL:
POST https://api.x.com/oauth/request_token
リクエスト POST 本文: N/A
Authorization ヘッダー: OAuth oauth_nonce="K7ny27JTpKVsTgdyLdDfmQQWVLERj2zAK5BslRsqyw", oauth_callback="http%3A%2F%2Fmyapp.com%3A3005%2Ftwitter%2Fprocess_callback", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1300228849", oauth_consumer_key="OqEqJeafRSF11jBMStrZz", oauth_signature="Pc%2BMLdv028fxCErFyi8KXFM%2BddU%3D", oauth_version="1.0"
レスポンス: oauth_token=Z6eEdO8MOmk394WozF5oKyuAv855l4Mlqo7hhlSLik&oauth_token_secret=Kd75W4OQfb2oJTV0vzGzeXftVAwgMnEK9MumzYcM&oauth_callback_confirmed=true
GET oauth/authorize
consumer アプリケーションが OAuth Request Token を使ってユーザー認可を要求できるようにします。このメソッドは OAuth 1.0 認証フロー の Section 6.2 を満たします。デスクトップアプリケーションはこのメソッドを使用する必要があります (GET oauth / authenticate は使用できません)。 使用上の注意:oauth_callback はこのメソッドに送信しないでください。代わりに POST oauth / request_token に渡してください。
リソース URL
https://api.x.com/oauth/authorize
リソース情報
パラメーター
リクエスト例
oauth_token パラメーターを含めて、Web ブラウザーでユーザーを
oauth/authorize のステップに送ります:
https://api.x.com/oauth/authorize?oauth_token=Z6eEdO8MOmk394WozF5oKyuAv855l4Mlqo7hhlSLik
GET oauth/authenticate
consumer アプリケーションが OAuthrequest_token を使ってユーザー認可を要求できるようにします。
このメソッドは、コールバック認証フローを使用するアプリケーションのために、OAuth 1.0 認証フロー の Section 6.2 を置き換えるものです。force_login パラメーターが true に設定されていない限り、このメソッドは現在ログイン中のユーザーをアクセス認可の対象アカウントとして使用します。
このメソッドが GET oauth / authorize と異なる点は、ユーザーがすでにアプリケーションに権限を付与している場合、ユーザーが再度アプリケーションを承認する必要なくリダイレクトが発生することです。この挙動を実現するには、application record で Use Sign in with X 設定を有効にする必要があります。
リソース URL
https://api.x.com/oauth/authenticate
リソース情報
パラメーター
リクエスト例
oauth_token パラメーターを含めて、Web ブラウザーでユーザーを
oauth/authenticate のステップに送ります:
https://api.x.com/oauth/authenticate?oauth_token=Z6eEdO8MOmk394WozF5oKyuAv855l4Mlqo7hhlSLik
POST oauth/access_token
consumer アプリケーションが OAuth Request Token を OAuth Access Token に交換できるようにします。このメソッドは OAuth 1.0 認証フロー の Section 6.3 を満たします。 リソース URLhttps://api.x.com/oauth/access_token
リソース情報
パラメーター
リクエスト例
POST https://api.x.com/oauth/access_token?oauth_token=qLBVyoAAAAAAx72QAAATZxQWU6P&oauth_verifier=ghLM8lYmAxDbaqL912RZSRjCCEXKDIzx
PIN ベースから POST https://api.x.com/oauth/access_token?oauth_token=9Npq8AAAAAAAx72QBRABZ4DAfY9&oauth_verifier=4868795
レスポンス例
oauth_token=6253282-eWudHldSbIaelX7swmsiHImEL4KinwaGloHANdrY&oauth_token_secret=2EEfA6BG5ly3sR3XjE0IBSnlQu4ZrUzPiYTmrkVU&user_id=6253282&screen_name=xapi
POST oauth/invalidate_token
登録済みアプリケーションが、クライアント認証情報を提示することで発行済みの OAuth access_token を取り消せるようにします。access_token が無効化されると、新たに作成しようとしても異なる Access Token が発行され、無効化されたトークンの使用は許可されなくなります。 リソース URLhttps://api.x.com/1.1/oauth/invalidate_token
リソース情報
リクエスト例
POST oauth2/token
登録済みアプリケーションが、ユーザーコンテキストなしにアプリケーション自身に代わって API リクエストを行うために使用できる OAuth 2 Bearer Token を取得できるようにします。これは Application-only 認証 と呼ばれます。 Bearer Token は oauth2/invalidate_token を使用して無効化できます。Bearer Token が無効化されると、新たに作成しようとしても異なる Bearer Token が発行され、以前のトークンの使用は許可されなくなります。 アプリケーションに対して有効な bearer token は 1 つのみ存在でき、このメソッドを繰り返し呼び出しても、無効化されるまで同じ既存トークンが返されます。 成功時のレスポンスには、付与された Bearer Token を記述する JSON 構造が含まれます。 このメソッドで受け取ったトークンはキャッシュしておくべきです。あまりに頻繁に試行すると、リクエストは HTTP 403 (コード 99) で拒否されます。 リソース URLhttps://api.x.com/oauth2/token
リソース情報
パラメーター
リクエスト例
POST oauth2/invalidate_token
登録済みアプリケーションが、クライアント認証情報を提示することで発行済みの oAuth 2.0 Bearer Token を取り消せるようにします。Bearer Token が無効化されると、新たに作成しようとしても異なる Bearer Token が発行され、無効化されたトークンの使用は許可されなくなります。 成功時のレスポンスには、取り消された Bearer Token を記述する JSON 構造が含まれます。 リソース URLhttps://api.x.com/oauth2/invalidate_token
リソース情報
パラメーター
リクエスト例