Groups

Group management operations

List groups

get

Lists groups

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Query parameters

domain_idstringOptional

Filter by domain ID

namestringOptional

Filter by group name

limitinteger · min: 1Optional

Requests a page size of items

markerstringOptional

The ID of the last-seen item for pagination

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

200

Groups listed successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

get

/groups

HTTPcURLJavaScriptPython

GET /keystone/v3/groups HTTP/1.1
Host: example.platform9.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"
  }
}

Create group

post

Creates a group

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Body

application/json

Responses

201

Group created successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

409

This operation conflicted with another operation on this resource

application/json

post

/groups

HTTPcURLJavaScriptPython

POST /keystone/v3/groups HTTP/1.1
Host: example.platform9.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"
    }
  }
}

Show group details

get

Shows details for a group

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

group_idstringRequired

The group ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

200

Group details retrieved successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

get

/groups/{group_id}

HTTPcURLJavaScriptPython

GET /keystone/v3/groups/{group_id} HTTP/1.1
Host: example.platform9.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"
    }
  }
}

Delete group

delete

Deletes a group

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

group_idstringRequired

The group ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

204

Group deleted successfully

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

delete

/groups/{group_id}

HTTPcURLJavaScriptPython

DELETE /keystone/v3/groups/{group_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

No content

Update group

patch

Updates a group

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

group_idstringRequired

The group ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Body

application/json

Responses

200

Group updated successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

409

This operation conflicted with another operation on this resource

application/json

patch

/groups/{group_id}

HTTPcURLJavaScriptPython

PATCH /keystone/v3/groups/{group_id} HTTP/1.1
Host: example.platform9.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"
    }
  }
}

List group users

get

Lists users in a group

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

group_idstringRequired

The group ID

Query parameters

password_expires_atstringOptional

Filter by password expiration

limitinteger · min: 1Optional

Requests a page size of items

markerstringOptional

The ID of the last-seen item for pagination

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

200

Group users listed successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

get

/groups/{group_id}/users

HTTPcURLJavaScriptPython

GET /keystone/v3/groups/{group_id}/users HTTP/1.1
Host: example.platform9.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-12-19T16:19:13.717Z",
      "options": {},
      "links": {
        "self": "text",
        "previous": "text",
        "next": "text"
      }
    }
  ],
  "links": {
    "self": "text",
    "previous": "text",
    "next": "text"
  }
}

Add user to group

put

Adds a user to a group

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

group_idstringRequired

The group ID

user_idstringRequired

The user ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

204

User added to group successfully

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

put

/groups/{group_id}/users/{user_id}

HTTPcURLJavaScriptPython

PUT /keystone/v3/groups/{group_id}/users/{user_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

No content

Remove user from group

delete

Removes a user from a group

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

group_idstringRequired

The group ID

user_idstringRequired

The user ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

204

User removed from group successfully

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

delete

/groups/{group_id}/users/{user_id}

HTTPcURLJavaScriptPython

DELETE /keystone/v3/groups/{group_id}/users/{user_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

No content

Check user group membership

head

Validates that a user belongs to a group

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

group_idstringRequired

The group ID

user_idstringRequired

The user ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

204

User is a member of the group

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

head

/groups/{group_id}/users/{user_id}

HTTPcURLJavaScriptPython

HEAD /keystone/v3/groups/{group_id}/users/{user_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

No content