グループ追加

    グループを追加します。

    API 種類

    サーバー API

    Request URL

    • サービス: https://apis.worksmobile.com/r/{API ID}/organization/v3/domains/{domainId}/groups/{externalKey}
    • テスト: https://sandbox-apis.worksmobile.com/r/{API ID}/organization/v3/domains/{domainId}/groups/{externalKey}

    HTTP Method

    POST (Content-Type: application/json; charset=UTF-8)

    Path parameters

    パラメーター タイプ 上限 必須 説明
    domainId Integer Y ドメイン ID
    externalKey String 100字 Y 追加するグループの External Key
    ● テナント内で一意になること
    ● 入力値の制限については 入力文字列制限 参照

    Request Body

    パラメーター タイプ 上限 必須 説明
    name String 100字 Y グループ名
    ● ドメイン内で一意になること
    description String 300字 N 説明
    display Boolean Y グループ公開有無
    ● 管理者/グループメンバー以外のメンバーによる検索の結果に表示するかどうか
    serviceAlarm Boolean Y サービス通知の送信有無
    serviceManageEnable Boolean Y グループマスターによる利用する機能の変更可否
    managers List Y グループマスターのリスト
    ● 当該メンバーがグループの機能(トーク/ノート/予定/フォルダ)を利用するにはグループメンバーにも含まれなければなりません。
    managers[].domainId Integer Y グループマスターのドメイン ID
    managers[].externalKey String 100字 Y グループマスターの External Key
    members List Y グループメンバーリスト
    members[].domainId Integer Y グループメンバーのドメイン ID
    members[].kind String Y グループメンバーのタイプ
    ● DOMAIN_USER: メンバー
    ● DOMAIN_ORGUNIT: 組織
    ● DOMAIN_GROUPS: グループ
    members[].externalKey String 100字 Y グループメンバーのメンバー/組織/グループ External Key
    messageUse Boolean Y グループトークの利用有無
    noteUse Boolean Y ノートの利用有無
    ● グループトーク利用時に利用可
    calendarUse Boolean Y グループカレンダーの利用有無
    ● グループトーク利用時に利用可
    folderUse Boolean Y グループフォルダの利用有無
    ● グループトーク利用時に利用可
    mailUse Boolean Y メーリングリストの利用有無
    ● ベーシック/プレミアムプランのみ
    ● この値が true の場合は email も必須項目
    email String 90字 N メーリングリストのアドレス (メーリングリスト利用時)
    ● localpart@domain 形式
    ● localpart は 2~64 字の英小文字、数字、ドット(.)、ハイフン(-)、アンダーバー(_)、エクスクラメーションマーク(!)のみ使用可。
    ● localpart の最初の文字は英数字、またはエクスクラメーションマーク(!)のみ可。
    ● ドット(.)は localpart の最初と最後および連続使用(..)不可。
    aliasEmails List 5個 N グループのサブメールアドレスリスト (メーリングリスト利用時)
    ● 最大 90 文字
    ● localpart@domain 形式で、入力規則は email と同様
    receiveExternalMail Boolean N 外部メール受信可否 (メーリングリスト利用時)
    externalEmails List 500個 N メーリングリストに含む外部メールアドレスのリスト
    ● 社内メールのドメインは使用不可
    membersToReceiveFrom List N このメーリングリストにメールを送信可能なメンバーのリスト (メーリングリスト利用時)
    ● 指定されたメンバーのメールのみ受信
    membersToReceiveFrom[].domainId Integer Y メンバーのドメイン ID
    membersToReceiveFrom[].externalKey String 100字 Y 当該メンバーの External Key
    membersToSendout List N 送信アドレスとして使用可能なメンバーのリスト (メーリングリスト利用時)
    ● グループマスター/グループメンバーのみ指定可 (それ以外はリストから除外)
    membersToSendout[].domainId Integer Y メンバーのドメイン ID
    membersToSendout[].externalKey String 100字 Y メンバーの External Key

    Request Example

    POST https://apis.worksmobile.com/r/apiid/organization/v3/domains/123/groups/EX123
    
    {
        "name": "Groups Name",
        "description": "Description",
        "display": true,
        "serviceAlarm": true,
        "serviceManageEnable": true,
        "managers": [{
            "domainId": 1,
            "externalKey": "USER001"
        }],
        "members": [
            {
                "domainId": 1,
                "externalKey": "USER001",
                "kind": "DOMAIN_USER"
            },
            {
                "domainId": 1,
                "externalKey": "ORGUNIT001",
                "kind": "DOMAIN_ORGUNIT"
            },
            {
                "domainId": 1,
                "externalKey": "GROUPS002",
                "kind": "DOMAIN_GROUPS"
            }
        ],
        "messageUse": true,
        "noteUse": true,
        "calendarUse": false,
        "folderUse": false,
        "mailUse": true,
        "email": "groups_email@example.com",
        "aliasEmails": [
            "groups_alias@example.com"
        ],
        "receiveExternalMail": true,
        "externalEmails": [
            "external@external.com"
        ],
        "membersToReceiveFrom": [{
            "domainId": 1,
            "externalKey": "USER001"
        }],
        "membersToSendout": [{
            "domainId": 1,
            "externalKey": "USER001"
        }]
    }
    

    Response

    呼び出しに成功すると HTTP 200 コードを返します。

    Error Code

    呼び出しに失敗するとエラーコードとエラーメッセージを返します。
    エラーコードは組織連携REST API エラーコードを参照してください。