ヘルプで見つからない情報は、サポートにお問い合わせください。お問い合わせ

開発者向け機能:API機能:グループ操作:グループ作成

APIを使用して新規にグループを作成することができます。

■事前準備
APIの操作を行う前にAPIキーの作成を実施してください。
また、この機能はテナント管理者でないと行えないため、ユーザ管理からテナント管理者の設定を行ってください。

■リクエスト 
下記のリクエスト形式で、jsonデータを送信します。

<設定項目>

設定項目
HTTPメソッド POST
Content-Type application/json
文字コード UTF-8
URL https://ks01.shelterdb.net/api/groups/create
Body 以下のjsonデータを参考のこと

 

<jsonデータ>

{
    "ApiVersion": 1.1,
    "ApiKey": "345yuAjA6789dA09d8uj6...",
    "GroupName": "[登録するグループの名前]",
    "Body": "APIによるグループ作成サンプルです。",
    "GroupMembers": [
        "User,1,True",
        "Dept,1,False"
    ]
}


GroupMembersについて
カンマ区切りにてグループメンバーに追加するユーザ、組織の情報を配列で指定します。

カラム 設定内容
1カラム目 ユーザを登録する場合は'User'、組織を登録する場合は'Dept'を指定します
2カラム目 ユーザ・組織のIDを指定します
3カラム目 管理者権限を付与する場合Trueを設定、付与しない場合はFalseを設定します

 

■レスポンス
下記の形式のjsonデータが返却されます。

{
    "Id": 12345,
    "StatusCode": 200,
    "Message": "\"登録するグループの名前\" を作成しました。"
}

 

  • はじめてご利用になる方へ
Powered by Zendesk