AirCourse logo
Documentation Powered by Redocly

AirCourse API (1.3.0)

AirCourseのAPI仕様を記載したドキュメントです。

APIの利用ガイドについてはこちらを参照してください。

共通仕様

リクエスト回数制限

同一IPからのアクセスは1分間で60回までの制限がかかります。

リクエストヘッダ

アクセストークンの取得方法はこちらを参照してください。

ヘッダ名 内容
Authorization Bearer アクセストークン
Accept application/json のみ対応しています

レスポンスヘッダ

レスポンスヘッダにてリクエスト回数制限に関する情報を取得することが可能です。

ヘッダ名 内容
X-RateLimit-Limit 1分間に許容されるリクエスト数
X-RateLimit-Remaining 1分間の残りのリクエスト回数

HTTP レスポンスステータスコード

以下のレスポンスステータスコードを使用します。

コード 内容
200 正常に処理が行われました
204 正常に処理が行われましたが、レスポンス内容がありません
400 リクエストパラメータが不正です
401 認証エラーが発生しました
403 権限エラーが発生しました
404 指定したリソースが見つかりません
405 サポートされていないHTTPリクエストメソッドです
422 リクエスト内容が不正です
429 リクエスト数の制限を超えています
500 予期せぬエラーが発生しました
503 システムメンテナンス中です
504 タイムアウトエラーが発生しました

エラーメッセージについて

クエリパラメータにてカンマ区切りで複数の値を指定する場合、およびJSON形式にて配列の値を指定する際のエラーについてはパラメータ名またはJSONのキー名に数字がついてエラーメッセージが表示される場合がありますが、数字は何番目の値がエラーになっているかを示しています。数字は0から始まる番号になっているため、2番目の値がエラーになっている場合は数字は1になります。

以下のメッセージは、adminUserIds の 2番目の値が正しくないことを示しています。

{
    "message": "adminUserIds.1には、usr_で始まる値を指定してください。",
    "errors": {
        "adminUserIds.1": [
            "adminUserIds.1には、usr_で始まる値を指定してください。"
        ]
    }
}

アクセストークン

アクセストークンの発行

アクセストークンを発行します。 アクセストークンの発行に必要なクライアントID、クライアントシークレットの取得方法についてはこちらを参照してください。 アクセストークンの有効期限は60分です。

Request Body schema: application/x-www-form-urlencoded
grant_type
required
string

client_credentials を指定してください。

client_id
required
string <uuid>

設定画面にて取得したクライアントIDを指定してください。

client_secret
required
string

設定画面にて取得したクライアントシークレットを指定してください。

scope
Array of strings (スコープ)
Default: ["read","write"]
Items Enum: "read" "write"

使用するscopeを指定してください。 複数指定する場合は , を区切り文字とします。

  • read - 読み取り権限
  • write - 登録・更新権限

Responses

Response samples

Content type
application/json
{
  • "token_type": "Bearer",
  • "expires_in": 3600,
  • "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5NWUwOTM2Zi0yNjM1LTQ0YzUtOWM5OC1jN2I4NWQ2NTA3OTUiLCJqdGkiOiIzYTI3OTJiODYzN2E0ZDIwYWE1OWM1NDc4M2JmMDhiZGI4Mzc0Y2E5MTMyM2UyYTUzZDA5NmQwNzY5N2JhOTNjNmUyMmYxNTIzODY4ZDI4OSIsImlhdCI6MTY0ODU0Mzk4OS45NjMzMTMsIm5iZiI6MTY0ODU0Mzk4OS45NjMzMTUsImV4cCI6MTY0ODU0NzU4OS44MTkxMTYsInN1YiI6IiIsInNjb3BlcyI6WyIqIl19.GaKHmWKTplQCGBimHV5V1IdfrDSWuAHy_R6yelAroP8iy0Cl1XLB4BylHn8CtF_vJlw66hEgGvCYcR5o1Yf_aNSSlnXbYJcL-w8tf_t1FPDtng3kifhSeztqqdKcHPtmiTa7Yv844X8N0TCd5WpEa2Ts4M5diS80myLKhD5lg3kIVifGRhGpKM4WgxWt5PeQ6NCWfU71eZtfI7EreBEGib5F_caBkg6n9DIzUZ3fVaaN6XW83qPbvjyNntUDdFygH1gVi_5wdKfMUlMm_n5tQB9FcTzlElKIzkJYZB1hpqsb4UNrehdZBxFQ1_1_TePYW0LqLEyv77gp6lk4ZOKadH5Fgjchb99UEKpNn5UmiIL7rU86eQYos3abAdfyIvfK-oNPUFcR8csGc37xn65XbuF1vPVe8BkHaVoW1RhYSzuY_DZ_gNXRO3Q4e_YmF_akluRbFepMlcup7vOyJOdR98X6aFcoFmYkRBr9D8ztw93lnuME_0_aTyl7lJQ8yS4przy9wK7J-WySMEmOVzNI1G2ZDyRFfImWagH8dhtAQcGk4AEhM5ScnKkygqK8b5jJoeWLSxPXxrvgcoFc0K6TSxiUGURZjwrjPpsmzHFmpBewLqXSUppHs8w-FApbV7CYaSTaT3uM4QNiY2iFQfahE_9KRR6CtzscilfRDCc2b6Q"
}

ユーザ

ユーザに関する処理

ユーザ一覧取得

企業内に登録されているユーザの一覧を取得します

Authorizations:
OAuth2
query Parameters
status
integer (ユーザステータス)
Enum: 1 2 3
Example: status=1,2

指定したステータスと一致するデータのみ取得します。 複数指定する場合は , を区切り文字とします。

  • 1 - 使用中
  • 2 - 利用停止
  • 3 - 招待中
license
string (ライセンス)
Enum: "free" "basic" "contents"
Example: license=free,basic

指定したライセンスと一致するデータのみ取得します。 複数指定する場合は , を区切り文字とします。

  • free - フリー
  • basic - ベーシック
  • contents - コンテンツプラス
hasAiKnowledgeLicense
integer (AIナレッジライセンスの割当て状況)
Enum: 0 1
  • 0 - なし
  • 1 - 割当済み
name
string

ユーザ名で一致するデータのみ取得します。（部分一致）

mail
string

メールアドレスで一致するデータのみ取得します。（完全一致）

loginId
string

ログインIDで一致するデータのみ取得します。（完全一致）

role
string (全体権限)
Enum: "read" "user" "manager" "admin"
Example: role=read,user,manager

指定した全体権限と一致するデータのみ取得します。 複数指定する場合は , を区切り文字とします。

  • read - 参照ユーザ
  • user - 一般ユーザ
  • manager - マネージャ
  • admin - 全体管理者
limit
integer <int32> [ 1 .. 1000 ]
Default: 100

1ページの件数

page
integer <int32> >= 1
Default: 1

何ページ目を取得するか

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

ユーザ登録

ユーザを登録します

  • 使用できないライセンスが指定された場合、フリーとして設定されます。
  • AIナレッジライセンスが未指定の場合、またはAIナレッジライセンスが不足している状況で「割当済み」が指定された場合、「なし」として設定されます。
Authorizations:
OAuth2
Request Body schema: application/json

登録するユーザのデータ

name
required
string <= 40 characters

ユーザ名

userNumber
string <= 40 characters

ユーザNo.

mail
string <email> <= 100 characters

メールアドレス、ログインIDとどちらかが必須

loginId
string <= 100 characters

ログインID、メールアドレスとどちらかが必須

password
string <= 100 characters

パスワード

slackMemberId
string <= 15 characters

SlackメンバーID

license
required
string (ライセンス)
Enum: "free" "basic" "contents"
  • free - フリー
  • basic - ベーシック
  • contents - コンテンツプラス
hasAiKnowledgeLicense
integer (AIナレッジライセンスの割当て状況)
Enum: 0 1
  • 0 - なし
  • 1 - 割当済み
role
required
string (全体権限)
Enum: "read" "user" "manager" "admin"
  • read - 参照ユーザ
  • user - 一般ユーザ
  • manager - マネージャ
  • admin - 全体管理者
memberOrganizationIds
Array of strings

組織メンバーとして所属させる組織IDの配列。 未指定の場合、ルート組織に所属します。

adminOrganizationIds
Array of strings

組織管理者として所属させる組織IDの配列。

department
string <= 100 characters

部署

position
string <= 100 characters

役職

gender
integer or null (性別)
Enum: 0 1
  • 0 - 男性
  • 1 - 女性
birthday
string <date>

生年月日（YYYY-MM-DD）

profile
string <= 1000 characters

プロフィール

isEnabledPasswordLogin
boolean

SAML認証の設定に応じて、パスワード認証を有効にする。
「SAML認証を有効にする」が有効かつ、「特定のユーザのみパスワード認証を使用可能にする」が有効の場合は必須。

Responses

Request samples

Content type
application/json
{
  • "name": "山田太郎",
  • "userNumber": "000123",
  • "mail": "sample@example.com",
  • "loginId": "user000123",
  • "password": "password000123",
  • "slackMemberId": "UDX00XXXX",
  • "license": "free",
  • "hasAiKnowledgeLicense": 0,
  • "role": "read",
  • "memberOrganizationIds": [
    ],
  • "adminOrganizationIds": [
    ],
  • "department": "営業部",
  • "position": "部長",
  • "gender": 0,
  • "birthday": "1981-01-01",
  • "profile": "会社に入ったばかりですが\nよろしくお願いします。\n",
  • "isEnabledPasswordLogin": false
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "password": "R6wtkHfX"
}

ユーザ情報取得

指定したユーザIDのユーザ情報を取得します

Authorizations:
OAuth2
path Parameters
userId
required
string/^usr_/

取得したいユーザのユーザID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

ユーザ更新

ユーザを更新します

  • genderを未設定にする場合は、空文字""を設定してください。
  • 使用できないライセンスが指定された場合、フリーとして設定されます。
  • AIナレッジライセンスが不足している状況で「割当済み」が指定された場合、「なし」として設定されます。
Authorizations:
OAuth2
path Parameters
userId
required
string/^usr_/

更新したいユーザのユーザID

Request Body schema: application/json

更新するユーザのデータ、指定されていない項目は、データが更新されません。

name
string <= 40 characters

ユーザ名

userNumber
string <= 40 characters

ユーザNo.

mail
string <email> <= 100 characters

メールアドレス、ログインIDのどちらかが必須

loginId
string <= 100 characters

ログインID、メールアドレスのどちらかが必須

password
string <= 100 characters

パスワード

notification
Array of strings (ユーザ通知)
Items Enum: "mail" "slack"
  • mail - メール
  • slack - SLACK
slackMemberId
string <= 15 characters

SlackメンバーID

isSuspended
boolean

利用停止状態

isAccountLocked
boolean

アカウントロック状態

  • アカウントロック状態を解除する（false）のみ対応
license
string (ライセンス)
Enum: "free" "basic" "contents"
  • free - フリー
  • basic - ベーシック
  • contents - コンテンツプラス
hasAiKnowledgeLicense
integer (AIナレッジライセンスの割当て状況)
Enum: 0 1
  • 0 - なし
  • 1 - 割当済み
role
string (全体権限)
Enum: "read" "user" "manager" "admin"
  • read - 参照ユーザ
  • user - 一般ユーザ
  • manager - マネージャ
  • admin - 全体管理者
memberOrganizationIds
Array of strings

組織メンバーとして所属させる組織IDの配列。 差分ではなく、所属させる組織のIDをすべて指定します。

adminOrganizationIds
Array of strings

組織管理者として所属させる組織IDの配列。 差分ではなく、所属させる組織のIDをすべて指定します。

department
string <= 100 characters

部署

position
string <= 100 characters

役職

gender
integer or null (性別)
Enum: 0 1
  • 0 - 男性
  • 1 - 女性
birthday
string <date>

生年月日（YYYY-MM-DD）

profile
string <= 1000 characters

プロフィール

isEnabledPasswordLogin
boolean

SAML認証の設定に応じて、パスワード認証を有効にする

Responses

Request samples

Content type
application/json
{
  • "name": "山田太郎",
  • "userNumber": "000123",
  • "mail": "sample@example.com",
  • "loginId": "user000123",
  • "password": "password000123",
  • "notification": [
    ],
  • "slackMemberId": "UDX00XXXX",
  • "isSuspended": false,
  • "isAccountLocked": false,
  • "license": "free",
  • "hasAiKnowledgeLicense": 0,
  • "role": "read",
  • "memberOrganizationIds": [
    ],
  • "adminOrganizationIds": [
    ],
  • "department": "営業部",
  • "position": "部長",
  • "gender": 0,
  • "birthday": "1981-01-01",
  • "profile": "会社に入ったばかりですが\nよろしくお願いします。\n",
  • "isEnabledPasswordLogin": false
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

ユーザ削除

ユーザを削除します

Authorizations:
OAuth2
path Parameters
userId
required
string/^usr_/

削除したいユーザのユーザID

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

組織

組織に関する処理

組織一覧取得

企業内に登録されている組織の一覧を取得します

Authorizations:
OAuth2
query Parameters
name
string

組織名で一致するデータのみ取得します。（部分一致）

code
string

組織コードで一致するデータのみ取得します。（完全一致）

isPublic
boolean

指定した公開/非公開と一致するデータのみ取得します。 未指定の場合は全て取得します。

  • 0 - 非公開
  • 1 - 公開
period
boolean

指定した公開期間と一致するデータのみ取得します。 未指定の場合は全て取得します。

  • 0 - 期間外
  • 1 - 期間内
limit
integer <int32> [ 1 .. 1000 ]
Default: 100

1ページの件数

page
integer <int32> >= 1
Default: 1

何ページ目を取得するか

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

組織登録

組織を登録します

Authorizations:
OAuth2
Request Body schema: application/json

登録する組織のデータ

name
required
string <= 40 characters

組織名

code
string <= 10 characters

組織コード

parentId
required
string

組織を所属させる組織（親組織）の組織ID

adminUserIds
required
Array of strings

組織管理者として所属させるユーザIDの配列。

isPublic
required
boolean

公開するかどうか

startDate
string <date>

公開開始日

  • 未指定の場合、親組織に公開開始日が設定されていた場合は親組織の公開開始日が設定されます。
endDate
string <date>

公開終了日

  • 未指定の場合、親組織に公開終了日が設定されていた場合は親組織の公開終了日が設定されます。
isEnableKnowledge
boolean
Deprecated

ディスカッション（旧ナレッジ共有）を有効にするかどうか

  • 本項目は削除予定のため、isEnableDiscussionを使用するようにしてください。
  • 本項目を使用しない場合、isEnableDiscussionは必須項目になります。
  • isEnableDiscussionを使用した場合、本項目は無視されます。
isEnableDiscussion
boolean

ディスカッションを有効にするかどうか

  • 本項目を使用しない場合、isEnableKnowledgeは必須項目になります。
  • 本項目を使用した場合、isEnableKnowledgeは無視されます。
description
string <= 1000 characters

組織の説明

Responses

Request samples

Content type
application/json
{
  • "name": "システム統括部",
  • "code": "system",
  • "parentId": "org_XXXXXXXXXXXXXXXX",
  • "adminUserIds": [
    ],
  • "isPublic": true,
  • "startDate": "2022-04-01",
  • "endDate": "2023-04-01",
  • "isEnableKnowledge": true,
  • "isEnableDiscussion": true,
  • "description": "システム統括部のメンバーが所属する組織"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

組織情報取得

指定した組織IDの組織情報を取得します

Authorizations:
OAuth2
path Parameters
organizationId
required
string/^org_/

取得したい組織の組織ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

組織更新

組織を更新します

  • startDate endDate を未設定にする場合は、空文字""を設定してください。ただし、親組織に公開開始日、公開終了日が設定されていた場合は親組織の公開開始日、公開終了日が設定されます。
Authorizations:
OAuth2
path Parameters
organizationId
required
string/^org_/

更新したい組織の組織ID

Request Body schema: application/json

更新する組織のデータ、指定されていない項目は、データが更新されません。 ルート組織の場合、以下の項目は変更できません。

  • 親組織
  • 公開設定
  • 公開開始日
  • 公開終了日
  • ディスカッションの設定
name
string <= 40 characters

組織名

code
string <= 10 characters

組織コード

parentId
string

組織を所属させる組織（親組織）の組織ID

isPublic
boolean

公開するかどうか

startDate
string <date>

公開開始日

endDate
string <date>

公開終了日

isEnableKnowledge
boolean
Deprecated

ディスカッション（旧ナレッジ共有）を有効にするかどうか

  • 本項目は削除予定のため、isEnableDiscussionを使用するようにしてください。
  • isEnableDiscussionを使用した場合、本項目は無視されます。
isEnableDiscussion
boolean

ディスカッションを有効にするかどうか

  • 本項目を使用した場合、isEnableKnowledgeは無視されます。
description
string <= 1000 characters

組織の説明

Responses

Request samples

Content type
application/json
{
  • "name": "システム統括部",
  • "code": "system",
  • "parentId": "org_XXXXXXXXXXXXXXXX",
  • "isPublic": true,
  • "startDate": "2022-04-01",
  • "endDate": "2023-04-01",
  • "isEnableKnowledge": true,
  • "isEnableDiscussion": true,
  • "description": "システム統括部のメンバーが所属する組織"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

組織削除

組織を削除します

  • 指定した組織の下の階層の組織も削除されます。
  • 削除される組織に所属しているユーザやコースなどは上の階層の組織に移動します。
  • 削除される組織が非公開、開始前、終了後の組織でもユーザやコースは上の階層の組織に移動します。
Authorizations:
OAuth2
path Parameters
organizationId
required
string/^org_/

削除したい組織の組織ID

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

組織ユーザ

組織のユーザに関する処理

組織ユーザ一覧取得

組織に登録されているユーザの一覧を取得します

Authorizations:
OAuth2
query Parameters
role
string

指定した組織権限と一致するデータのみ取得します。 未指定の場合は全て取得します。

  • member - 組織メンバー
  • admin - 組織管理者
limit
integer <int32> [ 1 .. 1000 ]
Default: 100

1ページの件数

page
integer <int32> >= 1
Default: 1

何ページ目を取得するか

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

組織ユーザ追加

組織に指定したユーザを追加します

Authorizations:
OAuth2
path Parameters
organizationId
required
string/^org_/

ユーザを追加したい組織の組織ID

Request Body schema: application/json

追加するユーザのデータ

userId
required
string

ユーザID

role
required
string (組織権限)
Enum: "member" "admin"
  • member - 組織メンバー
  • admin - 組織管理者

Responses

Request samples

Content type
application/json
{
  • "userId": "usr_XXXXXXXXXXXXXXXX",
  • "role": "member"
}

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

組織ユーザ更新

組織メンバーの情報を更新します

Authorizations:
OAuth2
path Parameters
organizationId
required
string/^org_/

更新したい組織メンバーが所属している組織の組織ID

Request Body schema: application/json

更新する組織メンバーのデータ

userId
required
string

ユーザID

role
required
string (組織権限)
Enum: "member" "admin"
  • member - 組織メンバー
  • admin - 組織管理者

Responses

Request samples

Content type
application/json
{
  • "userId": "usr_XXXXXXXXXXXXXXXX",
  • "role": "member"
}

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

組織ユーザ削除

組織に所属しているユーザを組織から削除します

Authorizations:
OAuth2
path Parameters
organizationId
required
string/^org_/

削除したい組織メンバーが所属している組織の組織ID

Request Body schema: application/json

削除する組織メンバーのデータ

userId
required
string

ユーザID

Responses

Request samples

Content type
application/json
{
  • "userId": "usr_XXXXXXXXXXXXXXXX"
}

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

グループ

グループに関する処理

グループ一覧取得

企業内に登録されているグループの一覧を取得します

Authorizations:
OAuth2
query Parameters
name
string

グループ名で一致するデータのみ取得します。（部分一致）

code
string

グループコードで一致するデータのみ取得します。（完全一致）

limit
integer <int32> [ 1 .. 1000 ]
Default: 100

1ページの件数

page
integer <int32> >= 1
Default: 1

何ページ目を取得するか

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

グループ登録

グループを登録します

Authorizations:
OAuth2
Request Body schema: application/json

登録するグループのデータ

name
required
string <= 40 characters

グループ名

code
string <= 10 characters

グループコード

organizationId
required
string

グループを所属させる組織の組織ID

isEnableKnowledge
boolean
Deprecated

ディスカッション（旧ナレッジ共有）を有効にするかどうか

  • 本項目は削除予定のため、isEnableDiscussionを使用するようにしてください。
  • 本項目を使用しない場合、isEnableDiscussionは必須項目になります。
  • isEnableDiscussionを使用した場合、本項目は無視されます。
isEnableDiscussion
boolean

ディスカッションを有効にするかどうか

  • 本項目を使用しない場合、isEnableKnowledgeは必須項目になります。
  • 本項目を使用した場合、isEnableKnowledgeは無視されます。
isViewableMember
required
boolean

他グループメンバーを参照できるかどうか

description
string <= 1000 characters

グループの説明

Responses

Request samples

Content type
application/json
{
  • "name": "LMS導入推進グループ",
  • "code": "security",
  • "organizationId": "org_XXXXXXXXXXXXXXXX",
  • "isViewableMember": true,
  • "isEnableDiscussion": true,
  • "description": "LMSの導入を推進していくメンバーのグループ"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

グループ情報取得

指定したグループIDのグループ情報を取得します

Authorizations:
OAuth2
path Parameters
groupId
required
string/^grp_/

取得したいグループのグループID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

グループ更新

グループを更新します

Authorizations:
OAuth2
path Parameters
groupId
required
string/^grp_/

更新したいグループのグループID

Request Body schema: application/json

更新するグループのデータ、指定されていない項目は、データが更新されません。 全員グループの場合、以下の項目は変更できません

  • グループ名
  • グループコード
  • グループを所属させる組織
  • ディスカッションの設定
  • グループの説明
name
string <= 40 characters

グループ名

code
string <= 10 characters

グループコード

organizationId
string

グループを所属させる組織の組織ID

isEnableKnowledge
boolean
Deprecated

ディスカッション（旧ナレッジ共有）を有効にするかどうか

  • 本項目は削除予定のため、isEnableDiscussionを使用するようにしてください。
  • isEnableDiscussionを使用した場合、本項目は無視されます。
isEnableDiscussion
boolean

ディスカッションを有効にするかどうか

  • 本項目を使用した場合、isEnableKnowledgeは無視されます。
isViewableMember
boolean

他グループメンバーを参照できるかどうか

description
string <= 1000 characters

グループの説明

Responses

Request samples

Content type
application/json
{
  • "name": "LMS導入推進グループ",
  • "code": "security",
  • "organizationId": "org_XXXXXXXXXXXXXXXX",
  • "isViewableMember": true,
  • "isEnableDiscussion": true,
  • "description": "LMSの導入を推進していくメンバーのグループ"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

グループ削除

グループを削除します

Authorizations:
OAuth2
path Parameters
groupId
required
string/^grp_/

削除したいグループのグループID

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

グループユーザ

グループのユーザに関する処理

グループユーザ一覧取得

グループに登録されているユーザの一覧を取得します

Authorizations:
OAuth2
query Parameters
role
string

指定したグループ権限と一致するデータのみ取得します。 未指定の場合は全て取得します。

  • member - グループメンバー
  • admin - グループ管理者
limit
integer <int32> [ 1 .. 1000 ]
Default: 100

1ページの件数

page
integer <int32> >= 1
Default: 1

何ページ目を取得するか

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

グループユーザ追加

グループに指定したユーザを追加します

Authorizations:
OAuth2
path Parameters
groupId
required
string/^grp_/

ユーザを追加したいグループのグループID

Request Body schema: application/json

追加するユーザのデータ

userId
required
string

ユーザID

role
required
string (グループ権限)
Enum: "member" "admin"
  • member - グループメンバー
  • admin - グループ管理者

Responses

Request samples

Content type
application/json
{
  • "userId": "usr_XXXXXXXXXXXXXXXX",
  • "role": "member"
}

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

グループユーザ更新

グループメンバーの情報を更新します

Authorizations:
OAuth2
path Parameters
groupId
required
string/^grp_/

更新したいグループメンバーが所属しているグループのグループID

Request Body schema: application/json

更新するグループメンバーのデータ

userId
required
string

ユーザID

role
required
string (グループ権限)
Enum: "member" "admin"
  • member - グループメンバー
  • admin - グループ管理者

Responses

Request samples

Content type
application/json
{
  • "userId": "usr_XXXXXXXXXXXXXXXX",
  • "role": "member"
}

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

グループユーザ削除

グループに所属しているユーザをグループから削除します

Authorizations:
OAuth2
path Parameters
groupId
required
string/^grp_/

削除したいグループメンバーが所属しているグループのグループID

Request Body schema: application/json

削除するグループメンバーのデータ

userId
required
string

ユーザID

Responses

Request samples

Content type
application/json
{
  • "userId": "usr_XXXXXXXXXXXXXXXX"
}

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}