List Groups#

グループを一覧表示します。

APIエンドポイント#

リージョン APIエンドポイント
西日本リージョン3の場合 https://identity.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合 https://identity.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

GET

/v3/groups

HTTPステータスコード#

正常時:200

エラー時:400, 401, 403, 404, 409, 500, 501, 503

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定
Description
domain_id query string 必須 ドメインID
name query string 任意 グループ名

レスポンスボディ(正常系)の説明#

名前 Type Description
groups array グループオブジェクトのリスト
description string グループの説明
domain_id string ドメインID
id string グループID
links object グループへのリンクURL
name string グループ名
links object APIへのリンクURL

レスポンス例#

{
    "groups": [
        {
            "description": "general projects",
            "domain_id": "--domain-id--",
            "id": "--group-id--",
            "links": {
                "self": "http://identity.jp-east-1.cloud.global.fujitsu.com/v3/groups/--group-id--"
            },
            "name": "Developers"
        },
        {
            "description": " secret projects",
            "domain_id": "--domain-id--",
            "id": "--group-id--",
            "links": {
                "self": "http://identity.jp-east-1.cloud.global.fujitsu.com/v3/groups/--group-id--"
            },
            "name": "Secure Developers"
        },
    ],
    "links": {
        "self": "http://identity.jp-east-1.cloud.global.fujitsu.com/v3/groups",
        "previous": null,
        "next": null
    }
}