グループの参照(一覧) (GET /v3/groups{?domain_id,name })
グループの一覧を表示する。
Request Headers
Content-type
MIME仕様で定義されているコンテントの形式を示す。
application/jsonを指定する。(必須項目)
Data Type | Cardinality |
---|---|
xsd:string | 1..1 |
Accept
MIME仕様で定義されているアクセプトの形式を示す。
application/jsonを指定する。(省略可)
Data Type | Cardinality |
---|---|
xsd:string | 1..1 |
X-Auth-Token
有効な認証トークン
Data Type | Cardinality |
---|---|
xsd:string | 1..1 |
Request Parameter
domain_id
ドメインID(必須項目)
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | なし | None |
name
グループ名
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 0..1 | なし | None |
Response Headers
HTTPステータスコード
リクエストのHTTPステータスコードを返却する。
以下の値を返却する。
- 200:
- 正常終了
- 400:
- 不正なアクセス(パラメーター不正等)
- 401:
- 認証エラー
- 403:
- アクセス不可(権限がない)
- 404:
- 該当資源なし
- 409:
- データ競合が発生
- 500:
- 予期せぬエラー
- 501:
- 実装されていない
- 503:
- サービス利用不可
Data Type | Cardinality |
---|---|
int | 1..1 |
Vary
以下のヘッダーを設定または変更することで、別のファイル形式で表現を要求できることを通知する。
X-Auth-Token
Data Type | Cardinality |
---|---|
xsd:string | 1..1 |
Content-Type
MIME仕様で定義されているコンテントの形式を示す。
application/json
Data Type | Cardinality |
---|---|
xsd:string | 1..1 |
Content-Length
エンティティの長さをバイトで示す。
Data Type | Cardinality |
---|---|
int | 1..1 |
Date
作成された日付を示す。
Data Type | Cardinality |
---|---|
date | 1..1 |
Response Elements
groups
groupsオブジェクト
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Element | 1..1 | なし | (group) |
(group)
groupオブジェクト(無名オブジェクト)
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Element | 1..n | groups | description
domain_id id links name |
description
グループの説明
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | (group) | None |
domain_id
ドメインID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | (group) | None |
id
グループID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | (group) | None |
links
グループのリンク情報
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Element | 1..1 | (group) | self |
name
グループ名
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | (group) | None |
links
APIのリンク情報
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Element | 1..1 | なし | self
previous next |
Example of Request
GET /v3/groups?domain_id=--domain-id--
X-Auth-Token: MIIIHgYJKoZIhvcNAQcCoIIIDzCCCAsCAQExC(省略)
Example of Response
HTTP/1.1 200 OK
Vary: X-Auth-Token
Content-Type: application/json
Content-Length: 3514
Date: Wed, 03 Sep 2014 02:56:28 GM
{
"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
}
}