Chapter 33. Group Service
33.1. Group Service
33.1.1. BatchUpdate
POST /v1/groupsbatch
33.1.1.1. Description
33.1.1.2. Parameters
33.1.1.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
33.1.1.3. Return Type
Object
33.1.1.4. Content Type
- application/json
33.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
33.1.1.6. Samples
33.1.2. CreateGroup
POST /v1/groups
33.1.2.1. Description
33.1.2.2. Parameters
33.1.2.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | Group is a GroupProperties : Role mapping. StorageGroup | X |
33.1.2.3. Return Type
Object
33.1.2.4. Content Type
- application/json
33.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
33.1.2.6. Samples
33.1.3. DeleteGroup
DELETE /v1/groups
33.1.3.1. Description
33.1.3.2. Parameters
33.1.3.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| authProviderId | We copy over parameters from storage.GroupProperties for seamless HTTP API migration. | - | null | |
| key | - | null | ||
| value | - | null | ||
| id | - | null | ||
| force | - | null |
33.1.3.3. Return Type
Object
33.1.3.4. Content Type
- application/json
33.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
33.1.3.6. Samples
33.1.4. GetGroup
GET /v1/group
33.1.4.1. Description
33.1.4.2. Parameters
33.1.4.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | Unique identifier for group properties and respectively the group. | - | null | |
| traits.mutabilityMode | - | ALLOW_MUTATE | ||
| traits.visibility | - | VISIBLE | ||
| traits.origin | - | IMPERATIVE | ||
| traits.expiresAt | expires_at specifies when this object should be considered expired and eligible for pruning. This field is optional. Objects without an expires_at value are never pruned based on expiry. Currently used for dynamically created RBAC objects (roles, permission sets, access scopes) that are generated by the internal token API for sensors. | - | null | |
| authProviderId | - | null | ||
| key | - | null | ||
| value | - | null |
33.1.4.3. Return Type
33.1.4.4. Content Type
- application/json
33.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
33.1.4.6. Samples
33.1.5. GetGroups
GET /v1/groups
33.1.5.1. Description
33.1.5.2. Parameters
33.1.5.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| authProviderId | - | null | ||
| key | - | null | ||
| value | - | null | ||
| id | - | null |
33.1.5.3. Return Type
33.1.5.4. Content Type
- application/json
33.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
33.1.5.6. Samples
33.1.6. UpdateGroup
PUT /v1/groups
33.1.6.1. Description
33.1.6.2. Parameters
33.1.6.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| group | X |
33.1.6.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| force | - | null |
33.1.6.3. Return Type
Object
33.1.6.4. Content Type
- application/json
33.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}