Groups
Group management operations
Lists groups
Authentication token obtained from the authentication service
Filter by domain ID
Filter by group name
Requests a page size of items
The ID of the last-seen item for pagination
A valid authentication token
Groups listed successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
GET /v3/groups HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Accept: */*
{
"groups": [
{
"id": "text",
"name": "text",
"description": "text",
"domain_id": "text",
"domain": {
"id": "text",
"name": "text",
"description": "text",
"enabled": true,
"links": {
"self": "text",
"previous": "text",
"next": "text"
},
"options": {}
},
"links": {
"self": "text",
"previous": "text",
"next": "text"
}
}
],
"links": {
"self": "text",
"previous": "text",
"next": "text"
}
}Creates a group
Authentication token obtained from the authentication service
A valid authentication token
Group created successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
This operation conflicted with another operation on this resource
POST /v3/groups HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"group": {
"name": "text",
"description": "text",
"domain_id": "text"
}
}{
"group": {
"id": "text",
"name": "text",
"description": "text",
"domain_id": "text",
"domain": {
"id": "text",
"name": "text",
"description": "text",
"enabled": true,
"links": {
"self": "text",
"previous": "text",
"next": "text"
},
"options": {}
},
"links": {
"self": "text",
"previous": "text",
"next": "text"
}
}
}Shows details for a group
Authentication token obtained from the authentication service
The group ID
A valid authentication token
Group details retrieved successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
GET /v3/groups/{group_id} HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Accept: */*
{
"group": {
"id": "text",
"name": "text",
"description": "text",
"domain_id": "text",
"domain": {
"id": "text",
"name": "text",
"description": "text",
"enabled": true,
"links": {
"self": "text",
"previous": "text",
"next": "text"
},
"options": {}
},
"links": {
"self": "text",
"previous": "text",
"next": "text"
}
}
}Deletes a group
Authentication token obtained from the authentication service
The group ID
A valid authentication token
Group deleted successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
DELETE /v3/groups/{group_id} HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Accept: */*
No content
Updates a group
Authentication token obtained from the authentication service
The group ID
A valid authentication token
Group updated successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
This operation conflicted with another operation on this resource
PATCH /v3/groups/{group_id} HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"group": {
"name": "text",
"description": "text",
"domain_id": "text"
}
}{
"group": {
"id": "text",
"name": "text",
"description": "text",
"domain_id": "text",
"domain": {
"id": "text",
"name": "text",
"description": "text",
"enabled": true,
"links": {
"self": "text",
"previous": "text",
"next": "text"
},
"options": {}
},
"links": {
"self": "text",
"previous": "text",
"next": "text"
}
}
}Lists users in a group
Authentication token obtained from the authentication service
The group ID
Filter by password expiration
Requests a page size of items
The ID of the last-seen item for pagination
A valid authentication token
Group users listed successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
GET /v3/groups/{group_id}/users HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Accept: */*
{
"users": [
{
"id": "text",
"name": "text",
"description": "text",
"enabled": true,
"domain_id": "text",
"domain": {
"id": "text",
"name": "text",
"description": "text",
"enabled": true,
"links": {
"self": "text",
"previous": "text",
"next": "text"
},
"options": {}
},
"default_project_id": "text",
"email": "text",
"password_expires_at": "2025-11-28T20:27:01.722Z",
"options": {},
"links": {
"self": "text",
"previous": "text",
"next": "text"
}
}
],
"links": {
"self": "text",
"previous": "text",
"next": "text"
}
}Adds a user to a group
Authentication token obtained from the authentication service
The group ID
The user ID
A valid authentication token
User added to group successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
PUT /v3/groups/{group_id}/users/{user_id} HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Accept: */*
No content
Removes a user from a group
Authentication token obtained from the authentication service
The group ID
The user ID
A valid authentication token
User removed from group successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
DELETE /v3/groups/{group_id}/users/{user_id} HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Accept: */*
No content
Validates that a user belongs to a group
Authentication token obtained from the authentication service
The group ID
The user ID
A valid authentication token
User is a member of the group
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
HEAD /v3/groups/{group_id}/users/{user_id} HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Accept: */*
No content
Last updated
Was this helpful?