[Confluence Cloud]Confluence Cloudのみアクセス可能なユーザーをREST APIで作成する方法

[#1]

現状、Confluence Cloudで提供されているAPIでは、ユーザーを作成するAPIが提供されておらず、以下の機能リクエストが登録されております。

CONFCLOUD-54893 Provide a Confluence Rest API to create a user

リンク先にて Vote for this issue(この課題に投票) していただくと機能が実現する可能性が高くなります。よろしければご検討ください。また、Start watching this issue(この課題をウォッチ) で購読していただくと、進捗があった場合にお客様に通知が送信されるようになります。

本記事では、Jira Cloudで提供されている以下2つのAPIを利用して、Confluenceのみにアクセス権を持つユーザーを作成する方法をご紹介します。

• Create user - https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-rest-api-3-user-post
• Add user to group - https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/#api-rest-api-3-group-user-post

1. API: Create userで製品アクセスを持たないユーザーを作成
REST API例

POST https://<サイト名>.atlassian.net/rest/api/3/user 

Request body: 
{  
   "emailAddress": "<メールアドレス>",
   "products": []
}

上記の様に、"products": [] と指定することで製品アクセスがない状態でユーザーが招待されます。

Create user - Request body: products

Products the new user has access to. Valid products are: jira-core, jira-servicedesk, jira-product-discovery, jira-software. If left empty, the user will get default product access. To create a user without product access, set this field to be an empty array.

2. API: Add user to groupでConfluenceのアクセス権を付与
REST API例

POST https://<サイト名>.atlassian.net/rest/api/3/group/user?groupname=<グループ名> 

Request body: 
{
  "accountId": "<1.で追加したユーザーのaccountId>"
}

<グループ名>にはconfluence-users-<サイト名>などのアクセスグループ名を指定ください。　

上記1-2の手順で、Confluenceにのみアクセス権を持つユーザーを作成可能です。