Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 32. Group Service

32.1. Group Service

32.1.1. BatchUpdate

POST /v1/groupsbatch

32.1.1.1. Description

32.1.1.2. Parameters

32.1.1.2.1. Body Parameter
NameDescriptionRequiredDefaultPattern

body

V1GroupBatchUpdateRequest

X

  

32.1.1.3. Return Type

Object

32.1.1.4. Content Type

  • application/json

32.1.1.5. Responses

Table 32.1. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

Object

0

An unexpected error response.

GooglerpcStatus

32.1.1.6. Samples

32.1.2. CreateGroup

POST /v1/groups

32.1.2.1. Description

32.1.2.2. Parameters

32.1.2.2.1. Body Parameter
NameDescriptionRequiredDefaultPattern

body

Group is a GroupProperties : Role mapping. StorageGroup

X

  

32.1.2.3. Return Type

Object

32.1.2.4. Content Type

  • application/json

32.1.2.5. Responses

Table 32.2. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

Object

0

An unexpected error response.

GooglerpcStatus

32.1.2.6. Samples

32.1.3. DeleteGroup

DELETE /v1/groups

32.1.3.1. Description

32.1.3.2. Parameters

32.1.3.2.1. Query Parameters
NameDescriptionRequiredDefaultPattern

authProviderId

We copy over parameters from storage.GroupProperties for seamless HTTP API migration.

-

null

 

key

 

-

null

 

value

 

-

null

 

id

 

-

null

 

force

 

-

null

 

32.1.3.3. Return Type

Object

32.1.3.4. Content Type

  • application/json

32.1.3.5. Responses

Table 32.3. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

Object

0

An unexpected error response.

GooglerpcStatus

32.1.3.6. Samples

32.1.4. GetGroup

GET /v1/group

32.1.4.1. Description

32.1.4.2. Parameters

32.1.4.2.1. Query Parameters
NameDescriptionRequiredDefaultPattern

id

Unique identifier for group properties and respectively the group.

-

null

 

traits.mutabilityMode

 

-

ALLOW_MUTATE

 

traits.visibility

 

-

VISIBLE

 

traits.origin

 

-

IMPERATIVE

 

authProviderId

 

-

null

 

key

 

-

null

 

value

 

-

null

 

32.1.4.3. Return Type

StorageGroup

32.1.4.4. Content Type

  • application/json

32.1.4.5. Responses

Table 32.4. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

StorageGroup

0

An unexpected error response.

GooglerpcStatus

32.1.4.6. Samples

32.1.5. GetGroups

GET /v1/groups

32.1.5.1. Description

32.1.5.2. Parameters

32.1.5.2.1. Query Parameters
NameDescriptionRequiredDefaultPattern

authProviderId

 

-

null

 

key

 

-

null

 

value

 

-

null

 

id

 

-

null

 

32.1.5.3. Return Type

V1GetGroupsResponse

32.1.5.4. Content Type

  • application/json

32.1.5.5. Responses

Table 32.5. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1GetGroupsResponse

0

An unexpected error response.

GooglerpcStatus

32.1.5.6. Samples

32.1.6. UpdateGroup

PUT /v1/groups

32.1.6.1. Description

32.1.6.2. Parameters

32.1.6.2.1. Body Parameter
NameDescriptionRequiredDefaultPattern

group

StorageGroup

X

  
32.1.6.2.2. Query Parameters
NameDescriptionRequiredDefaultPattern

force

 

-

null

 

32.1.6.3. Return Type

Object

32.1.6.4. Content Type

  • application/json

32.1.6.5. Responses

Table 32.6. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

Object

0

An unexpected error response.

GooglerpcStatus

32.1.6.6. Samples

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat