組織のグループを取得

指定した組織に割り当てられているグループを一覧表示します。

GET https://{tenantDomain}/api/v2/organizations/{organization_id}/groups

組織に割り当てられているグループを一覧表示する。

cURL

curl --request GET \
  --url https://{tenantDomain}/api/v2/organizations/{organization_id}/groups \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/organizations/{organization_id}/groups"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenantDomain}/api/v2/organizations/{organization_id}/groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/organizations/{organization_id}/groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/organizations/{organization_id}/groups"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/organizations/{organization_id}/groups")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/organizations/{organization_id}/groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "groups": [
    {
      "connection_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "external_id": "<string>",
      "id": "<string>",
      "name": "<string>",
      "tenant_name": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next": "<string>"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

パスパラメータ

organization_id · string · 必須

組織のID

クエリパラメータ

from · string

選択を開始する起点となる省略可能な Id。

take · integer

1 ページあたりの結果数。デフォルトは 50 です。

必須範囲: x >= 1

レスポンス

200

application/json

組織グループを正常に取得しました。

groups · object[] · 必須

Show child attributes

next · string

結果の次ページで "from" クエリパラメーターとして使用するカーソルです。