グループ照会

    クライアントが管理する External Key でグループを照会します。

    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

    GET

    Path parameters

    パラメーター タイプ 必須 説明
    domainId Integer Y ドメイン ID
    externalKey String Y クライアントが管理するグループの External Key

    Request Example

    GET https://apis.worksmobile.com/r/apiid/organization/v3/domains/123/groups/EX123
    

    Response

    HTTP Status コードが 200 の場合、HTTP Body にグループの詳細情報を返します。

    パラメーター タイプ 説明
    name String グループ名
    ● ドメイン内で一意になること
    description String 説明
    display Boolean グループ公開有無
    ● 管理者/グループメンバー以外のメンバーによる検索の結果に表示するかどうか
    serviceAlarm Boolean サービス通知の送信有無
    serviceManageEnable Boolean グループマスターによる利用する機能の変更可否
    managers List グループマスターのリスト
    managers[].domainId Integer グループマスターのドメイン ID
    managers[].externalKey String グループマスターの External Key
    members List グループメンバーリスト
    members[].domainId Integer グループメンバーのドメイン ID
    members[].kind String グループメンバーのタイプ
    ● DOMAIN_USER: メンバー
    ● DOMAIN_ORGUNIT: 組織
    ● DOMAIN_GROUPS: グループ
    members[].externalKey String グループメンバーのメンバー/組織/グループ External Key
    messageUse Boolean グループトークの利用有無
    noteUse Boolean グループノートの利用有無
    calendarUse Boolean グループカレンダーの利用有無
    folderUse Boolean グループフォルダの利用有無
    mailUse Boolean メーリングリストの利用有無
    email String メーリングリストのアドレス (メーリングリスト利用時)
    aliasEmails List グループのサブメールアドレスリスト (メーリングリスト利用時)
    receiveExternalMail Boolean 外部メール受信可否 (メーリングリスト利用時)
    externalEmails List メーリングリストに含む外部メールアドレスのリスト
    membersToReceiveFrom List このメーリングリストにメールを送信可能なメンバーのリスト (メーリングリスト利用時)
    ● 指定されたメンバーのメールのみ受信
    membersToReceiveFrom[].domainId Integer 当該メンバーのドメイン ID
    membersToReceiveFrom[].externalKey String 当該メンバーの External Key
    membersToSendout List メーリングリストを送信アドレスとして使用可能なメンバーのリスト (メーリングリスト利用時)
    membersToSendout[].domainId Integer 当該メンバーのドメイン ID
    membersToSendout[].externalKey String 当該メンバーの External Key

    Response Example

    {
        "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"
        }]
    }
    

    Error Code

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