Qiita Teamでチーム別のアクセストークンを発行でき、SSOのみでのログイン設定をしているチームでもAPIが利用できるようになりました。

こんにちは、Qiita Team開発チームのWakameSunです。
今回、Qiita APIに関して大きな仕様変更を行うためご報告をさせていただきます。特にQiita TeamでAPIを利用されている方、Qiita Teamでシングルサインオン(SSO)を導入しているチームの方は一読していただけると幸いです。

変更点

  • Qiita Teamでチーム別のアクセストークンを発行できるようになりました。
  • 現在利用されているアクセストークンは、将来Qiita Teamで利用できなくなります。(Qiitaでは今後も問題なく利用可能です。)
  • チーム別アクセストークンは発行したチームでのみ利用可能です。

この変更に伴い、チーム別のアクセストークンであれば、SSOを導入しているチームでもQiita APIをQiita Teamでご利用できるようになります。

設定・発行方法はこちらをご覧下さい。

まとめ

今回の仕様変更により、SSOを利用しているチームにもAPIをご利用いただけるようになりました。
何かご意見ご要望がありましたらこちらのURLからいつでもお寄せください。
また、Qiita Teamのアップデートやイベント参加などに関する情報は、こちらのツイッターアカウントでも発信しています。
今後ともQiita、Qiita Team、およびQiita Jobsをよろしくお願いします。

APIを利用するためのチーム別アクセストークンの設定

チーム別アクセストークンについて

従来Qiita及びQiita Teamでは共通のアクセストークンでAPIを利用可能でしたが、Qiita Teamではセキュリティの観点からシングルサインオン(SSO)のチームでAPIが使えない仕様になっており、ご不便をおかけしていました。
そこでこの度Qiita Team専用かつ、特定のチームでしか使えないアクセストークンを発行できるようにし、SSOを導入しているチームでもAPIをご利用できるようになりました。
また、チーム別アクセストークンはチームごとにAPIの発行権限を設けることで、チームのオーナーが管理できるようになっています。

※従来のアクセストークンに関しましては、Qiitaで使う際はそのままで問題ありませんが、Qiita Teamで使われる場合は今後、利用制限を加える予定のため、チーム別アクセストークンへの移行を強くお勧め致します。

チーム別アクセストークンの発行権限の設定

チームのオーナーの方はこちらのページから ユーザーのロール(メンバーか管理者か)によって、チーム別アクセストークンの発行を制限することができます。

この画像には alt 属性が指定されておらず、ファイル名は 514b9182-df1b-c51b-c297-e2b3fc7ac040.png です

デフォルトはオーナーのみになっています。チームの状況に合わせて適切な権限を設定してください。

また権限を厳しくした場合、設定された権限以下のメンバーのチーム別アクセストークンは利用できなくなるため、ご注意ください。例えば全員利用可能からオーナーと管理者のみに変更すると、一般メンバー(オーナーでも管理者でもないメンバー)のチーム別アクセストークンは利用できなくなります。

チーム別アクセストークンの発行方法

アクセストークンを発行したいチームのホストであれば、従来のアクセストークン同様OAuthを利用した認可フローか、各メンバーの管理画面から発行できます。
Oauthを利用した認可フローはこちらの認証認可の項目とチーム別アクセストークンの項目をご覧ください。Oauthを利用した認可フローを扱う場合は、チームのオーナーがOauth認証を利用したチーム別アクセストークンの発行許可設定を許可するにする必要があります。

ユーザーの設定画面から発行したい場合は、(チーム名)向けアプリケーションのページ から、先述の設定された発行権限以上のユーザーは発行を行うことができます。

一般メンバーの発行申請フロー

先述の発行権限を一般メンバーは許可が必要に設定された場合、オーナーの許可を得ることによって一般メンバーもアクセストークンを管理画面経由で発行することができます。

一般メンバーからの申請

先述の発行権限を一般メンバーは許可が必要に設定された時、一般メンバーの(チーム名)向けアプリケーションのページ では、下記の画像のように(チーム名)向けアプリケーションの申請という項目があると思います。そちらの新しくトークン発行の申請するから一般メンバーはトークン発行の申請を行うことができます。

その申請はオーナーが通知とメールで申請を受け取ることができます。

オーナーの許諾

スクリーンショット 2020-05-29 10.53.50.png

オーナーは通知とメールに付随したリンクもしくは(チーム名)向けアプリケーションのページ(チーム名)向けアプリケーションの申請から、申請に関する詳細を確認することができます。


許可を行っていただくと、発行したメンバーは(チーム名)向けアプリケーションのページで一度のみトークンを確認することができます。
却下された場合、再度申請を編集して申請の再提出を行うことができます。

記事の共有と公開をする方法

Qiita Team では投稿した記事毎に公開設定ができ、特定のユーザーとの共有や不特定多数のユーザー向けに共有するために記事ををチーム外にも公開ができます。

記事の共有リンクの作成による共有以外はIP制限が適用されます。

記事をウェブに公開する

チームの情報を公開した状態で Qiita アカウントを持っていないユーザーに対して共有したい場合に使用します。
機能を有効にするには管理者が設定を変更する必要があります。

設定方法

チーム設定から共有の設定を変更します。

設定をオンにした場合

  • Qiita Team のメンバー以外でも、URLを知る人は記事の閲覧が可能になります。
  • 公開した記事はメンバー以外でも、公開中の記事一覧から閲覧が可能になります。
  • リンクがウェブ上に共有された場合には、Google等の検索ツールの結果にも表示されます。
  • 記事内容に加え、記事を記載したユーザー、該当するTeamに関する情報も閲覧可能になります。

上記の共有される範囲をご認識のうえ、一般公開設定の記事内の秘密情報や個人情報の取扱いにもご留意下さい。

設定をオフにした場合

ウェブ上に公開した全ての記事で一般公開が解除されます。

公開方法

公開したい記事ページのメニューの地球儀アイコンから公開をします。
閲覧中の記事のURLにアクセスすると、チームのメンバーでなくとも閲覧可能になります。
また、公開中の記事一覧のページから誰でも閲覧できるようになります。

公開中の記事一覧


記事の共有リンクを作成する

チームの情報を秘匿した状態で Qiita アカウントを持っていないユーザーに対して共有したい場合に使用します。
従来の「外部共有」の機能と同じ機能です。
機能を有効にするには管理者が設定を変更する必要があります。

設定方法

チーム設定から共有の設定を変更します。

設定をオンにした場合

  • Qiita Team のメンバー以外でも、URLを知る人は記事の閲覧が可能になります。
  • Google等の検索ツールにはインデックスされません。
  • 記事を記載したユーザー、該当するTeamに関する情報は秘匿されます。

上記の共有される範囲をご認識のうえ、共有する記事内の秘密情報や個人情報の取扱いにもご留意下さい。

設定をオフにした場合

全ての記事で発行したリンクは無効になり、閲覧できなくなります。

共有方法

共有したい記事ページのメニューのリンクアイコンから共有リンクを作成します。
共有リンクが発行されるため、リンクをコピーして記事を共有してください。

Qiitaユーザーと共有

  • プライベートグループに所属していない特定のチームメンバー
  • チームに所属していない Qiita ユーザー

に対して記事を共有したい場合に使用します。

機能を有効にするには管理者が設定を変更する必要があります。

設定方法

チーム設定から共有の設定を変更します。

共有先ユーザーの制限

チーム内でプライベートグループの記事を特定のメンバーに共有する目的のみの場合、共有先のユーザーをチームメンバーのみに指定できます。
チーム外のメンバーと共有する際は制限をチームメンバーのみにせず、全てのQiitaユーザー にしてください。

設定をオンにした場合

共有されたユーザーは下記のアクションができます。

  • 閲覧
  • 編集リクエスト
  • コメント
  • リアクション

記事内容に加え、記事を記載したユーザー、該当するTeamに関する情報も閲覧可能になります。

上記の共有される範囲をご認識のうえ、共有する記事内の秘密情報や個人情報の取扱いにもご留意下さい。

設定をオフにした場合

設定をオフにした場合、相手に共有した全ての記事における共有が解除されます。

共有方法

共有したい記事ページのメニューのリンクアイコンからユーザと共有をします。
Qiita ID または メールアドレスを入力し、共有するをクリックすると共有相手にメールが送信されます。
共有を解除する場合は、ユーザ名の右にあるゴミ箱アイコンをクリックしてください。

Microsoft Teamsと連携を行えるようになりました

こんにちは、Qiita Team開発チームのWakameSunです。
今回はMicrosoft Teamsへ、連携をすることで通知を流すことが可能になったのでお知らせさせていただきます。
( ※この操作は管理者とオーナーのみ行えます )

連携を行う方法

連携にはMicrosoft Teams側の設定と、Qiita Team側の設定が必要です。

Microsoft Teams側の設定

Microsoft Teamsのアプリの検索フォームから、Incoming Webhooksを追加します。
通知を流したいチャネルを選択後、コネクタの名前とイメージを設定し「作成」を押すとURLが生成されます。
イメージに関してQiita Teamの画像を使いたい場合はこちらのリンク からご利用ください。

Qiita Team側の設定

サービス連携 」から「追加」で「Microsoft Teams」を選択します。


先ほど生成したWebhook URLを入力し、通知するイベントとグループを選択したら「保存」を押下します。

まとめ

今回の改善により、皆様にQiita Teamが便利になったと感じていただけたら幸いです。今後もQiita Teamでは機能改善をより大幅に行っていく予定なので、そちらもご期待ください。
何かご意見ご要望がありましたらこちらのURLからいつでもお寄せください。
また、Qiita Teamのアップデートやイベント参加などに関する情報は、こちらのツイッターアカウントでも発信しています。
今後ともQiita、Qiita Team、およびQiita Jobsをよろしくお願いします。