List groups (GET /v3/groups{?domain_id,name })
Lists groups.
Request headers
Content-type
Indicates the format of content defined in the MIME specification.
Specify application/json. (required)
| Data type | Cardinality |
|---|---|
| xsd:string | 1..1 |
Accept
Indicates the accept format defined in the MIME specification.
Specify application/json. (optional)
| Data type | Cardinality |
|---|---|
| xsd:string | 1..1 |
X-Auth-Token
Valid authentication token
| Data type | Cardinality |
|---|---|
| xsd:string | 1..1 |
Request parameters
domain_id
Domain ID (required)
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:string | 1..1 | None | None |
name
Group name
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:string | 0..1 | None | None |
Response headers
HTTP status code
Returns the HTTP status code of the request.
One of the following values will be returned.
- 200:
- Normal completion
- 400:
- Invalid access (invalid parameter, etc.)
- 401:
- Authentication error
- 403:
- Cannot access (no privileges)
- 404:
- No applicable resources
- 409:
- Data conflict occurred
- 500:
- Unexpected error
- 501:
- Has not been implemented
- 503:
- Cannot use service
| Data type | Cardinality |
|---|---|
| int | 1..1 |
Vary
By setting or changing the following header, notification is given that expressions can be requested in a different file format.
X-Auth-Token
| Data type | Cardinality |
|---|---|
| xsd:string | 1..1 |
Content-Type
Indicates the format of content defined in the MIME specification.
application/json
| Data type | Cardinality |
|---|---|
| xsd:string | 1..1 |
Content-Length
Indicates the length of an entity in bytes.
| Data type | Cardinality |
|---|---|
| int | 1..1 |
Date
Indicates the date when the request was created.
| Data type | Cardinality |
|---|---|
| date | 1..1 |
Response elements
groups
groups object
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Element | 1..1 | None | (group) |
(group)
group object (object name is not displayed)
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Element | 1..n | groups | description domain_id id links name |
description
Description of group
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:string | 1..1 | (group) | None |
domain_id
Domain ID
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:string | 1..1 | (group) | None |
id
ID of the group
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:string | 1..1 | (group) | None |
links
Link information of group
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Element | 1..1 | (group) | self |
name
Group name
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:string | 1..1 | (group) | None |
links
API link information
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Element | 1..1 | None | 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
}
}