List users (GET /v3/users{?domain_id,name,enabled })
Lists users.
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
User name
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:string | 0..1 | None | None |
enabled
Enabled setting
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:boolean | 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
users
users object
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Element | 1..1 | None | (user) |
(user)
user object (object name is not displayed)
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Element | 1..n | users | default_project_id description domain_id enabled id name locale links |
default_project_id
Default project ID
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:string | 1..1 | (user) | None |
description
Description of user
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:string | 1..1 | (user) | None |
domain_id
Domain ID
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:string | 1..1 | (user) | None |
enabled
Enabled setting
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:boolean | 1..1 | (user) | None |
id
User ID
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:string | 1..1 | (user) | None |
name
User name
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:string | 1..1 | (user) | None |
locale
Email notification language
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:string | 1..1 | (user) | None |
links
Link information of user
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Element | 1..1 | (user) | self |
links
API link information
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Element | 1..1 | None | self previous next |
Example of request
GET /v3/users?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: 443
Date: Tue, 02 Sep 2014 09:32:58 GMT
{
"users": [
{
"default_project_id": "--project-id--",
"description": "admin user",
"domain_id": "--domain-id--",
"enabled": true,
"id": "--user-id--",
"links": {
"self": "http://identity.jp-east-1.cloud.global.fujitsu.com/v3/users/--user-id--"
},
"locale": "ja",
"name": "admin"
},
{
"default_project_id": "--project-id--",
"description": "another user",
"domain_id": "--domain-id--",
"enabled": true,
"id": "--user-id--",
"links": {
"self": "http://identity.jp-east-1.cloud.global.fujitsu.com/v3/users/--user-id--"
},
"locale": "ja",
"name": "someone"
}
],
"links": {
"self": "http://identity.jp-east-1.cloud.global.fujitsu.com/v3/users",
"previous": null,
"next": null
}
}