> For the complete documentation index, see [llms.txt](https://docs.hotwax.co/documents/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hotwax.co/documents/integrate-with-hotwax/components/admin/user-groups.md).

# User Groups

Manage native Moqui user groups (moqui.security.UserGroup)

## GET /userGroups

> list UserGroup

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"userGroups","description":"Manage native Moqui user groups (moqui.security.UserGroup)"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"userGroups":{"title":"User Group","type":"object","properties":{"_entity":{"type":"string","default":"userGroups"},"userGroupId":{"type":"string"},"description":{"type":"string"},"groupTypeEnumId":{"type":"string","enum":["UgtMoquiAdmin","UgtRemoteSystems","UgtServiceJob","UgtUserAccess"]},"ipAllowed":{"type":"string"},"requireAuthcFactor":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/userGroups":{"get":{"tags":["userGroups"],"summary":"list UserGroup","description":null,"parameters":[{"schema":{"type":"number","format":"int32"},"name":"pageIndex","in":"query","required":false,"description":"Page number to return, starting with zero"},{"schema":{"type":"number","format":"int32"},"name":"pageSize","in":"query","required":false,"description":"Number of records per page (default 100)"},{"schema":{"type":"string"},"name":"orderByField","in":"query","required":false,"description":"Field name to order by (or comma separated names)"},{"schema":{"type":"string"},"name":"pageNoLimit","in":"query","required":false,"description":"If true don't limit page size (no pagination)"},{"schema":{"type":"number","format":"int32"},"name":"dependentLevels","in":"query","required":false,"description":"Levels of dependent child records to include"},{"schema":{"type":"string","format":""},"name":"userGroupId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"description","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"groupTypeEnumId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"ipAllowed","in":"query","required":false,"description":"See UserAccout.ipAllowed"},{"schema":{"type":"string","format":""},"name":"requireAuthcFactor","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"lastUpdatedStamp","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"createdStamp","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/userGroups"}}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## POST /userGroups

> create UserGroup

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"userGroups","description":"Manage native Moqui user groups (moqui.security.UserGroup)"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"userGroups.PK":{"title":"User Group","type":"object","properties":{"_entity":{"type":"string","default":"userGroups.PK"},"userGroupId":{"type":"string"}}},"userGroups":{"title":"User Group","type":"object","properties":{"_entity":{"type":"string","default":"userGroups"},"userGroupId":{"type":"string"},"description":{"type":"string"},"groupTypeEnumId":{"type":"string","enum":["UgtMoquiAdmin","UgtRemoteSystems","UgtServiceJob","UgtUserAccess"]},"ipAllowed":{"type":"string"},"requireAuthcFactor":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/userGroups":{"post":{"tags":["userGroups"],"summary":"create UserGroup","description":null,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userGroups.PK"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/userGroups"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/userGroups"}}},"required":false}}}}}
```

## GET /userGroups/{userGroupId}

> one UserGroup

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"userGroups","description":"Manage native Moqui user groups (moqui.security.UserGroup)"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"userGroups":{"title":"User Group","type":"object","properties":{"_entity":{"type":"string","default":"userGroups"},"userGroupId":{"type":"string"},"description":{"type":"string"},"groupTypeEnumId":{"type":"string","enum":["UgtMoquiAdmin","UgtRemoteSystems","UgtServiceJob","UgtUserAccess"]},"ipAllowed":{"type":"string"},"requireAuthcFactor":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/userGroups/{userGroupId}":{"get":{"tags":["userGroups"],"summary":"one UserGroup","description":null,"parameters":[{"schema":{"type":"string"},"name":"userGroupId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userGroups"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## PUT /userGroups/{userGroupId}

> update UserGroup

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"userGroups","description":"Manage native Moqui user groups (moqui.security.UserGroup)"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"userGroups.PK":{"title":"User Group","type":"object","properties":{"_entity":{"type":"string","default":"userGroups.PK"},"userGroupId":{"type":"string"}}},"userGroups":{"title":"User Group","type":"object","properties":{"_entity":{"type":"string","default":"userGroups"},"userGroupId":{"type":"string"},"description":{"type":"string"},"groupTypeEnumId":{"type":"string","enum":["UgtMoquiAdmin","UgtRemoteSystems","UgtServiceJob","UgtUserAccess"]},"ipAllowed":{"type":"string"},"requireAuthcFactor":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/userGroups/{userGroupId}":{"put":{"tags":["userGroups"],"summary":"update UserGroup","description":null,"parameters":[{"schema":{"type":"string"},"name":"userGroupId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userGroups.PK"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/userGroups"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/userGroups"}}},"required":false}}}}}
```

## DELETE /userGroups/{userGroupId}

> delete UserGroup

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"userGroups","description":"Manage native Moqui user groups (moqui.security.UserGroup)"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}}},"paths":{"/userGroups/{userGroupId}":{"delete":{"tags":["userGroups"],"summary":"delete UserGroup","description":null,"parameters":[{"schema":{"type":"string"},"name":"userGroupId","in":"path","required":true,"description":null}],"responses":{"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## find UserGroupPermissions

> Replaces GET /admin/userGroups/{userGroupId}/permissions

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"userGroups","description":"Manage native Moqui user groups (moqui.security.UserGroup)"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.security.SecurityServices.findUserGroupPermissions.Out":{"type":"object","properties":{"userGroupPermissionList":{"type":"array"},"userGroupPermissionListCount":{"type":"integer","format":"int32"}}}}},"paths":{"/userGroups/{userGroupId}/permissions":{"get":{"tags":["userGroups"],"summary":"find UserGroupPermissions","description":"Replaces GET /admin/userGroups/{userGroupId}/permissions","parameters":[{"schema":{"type":"string"},"name":"userGroupId","in":"path","required":true,"description":null},{"schema":{"type":"string","format":""},"name":"userPermissionId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"orderByField","in":"query","required":false,"description":null},{"schema":{"type":"integer","format":"int32"},"name":"pageIndex","in":"query","required":false,"description":null},{"schema":{"type":"integer","format":"int32"},"name":"pageSize","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.security.SecurityServices.findUserGroupPermissions.Out"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## create UserGroupPermission

> Replaces POST /admin/userGroups/{userGroupId}/permissions

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"userGroups","description":"Manage native Moqui user groups (moqui.security.UserGroup)"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.security.SecurityServices.createUserGroupPermission.Out":{"type":"object","properties":{"userGroupId":{"type":"string"},"userPermissionId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"}}},"co.hotwax.security.SecurityServices.createUserGroupPermission.In":{"type":"object","properties":{"userGroupId":{"type":"string"},"userPermissionId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"},"thruDate":{"type":"string","format":"date-time"}},"required":["userGroupId","userPermissionId"]}}},"paths":{"/userGroups/{userGroupId}/permissions":{"post":{"tags":["userGroups"],"summary":"create UserGroupPermission","description":"Replaces POST /admin/userGroups/{userGroupId}/permissions","parameters":[{"schema":{"type":"string"},"name":"userGroupId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.security.SecurityServices.createUserGroupPermission.Out"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.security.SecurityServices.createUserGroupPermission.In"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/co.hotwax.security.SecurityServices.createUserGroupPermission.In"}}},"required":true}}}}}
```

## update UserGroupPermission

> Replaces PUT /admin/userGroups/{userGroupId}/permissions (soft-expire via thruDate)

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"userGroups","description":"Manage native Moqui user groups (moqui.security.UserGroup)"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.security.SecurityServices.updateUserGroupPermission.In":{"type":"object","properties":{"userGroupId":{"type":"string"},"userPermissionId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"},"thruDate":{"type":"string","format":"date-time"}},"required":["userGroupId","userPermissionId","fromDate"]}}},"paths":{"/userGroups/{userGroupId}/permissions":{"put":{"tags":["userGroups"],"summary":"update UserGroupPermission","description":"Replaces PUT /admin/userGroups/{userGroupId}/permissions (soft-expire via thruDate)","parameters":[{"schema":{"type":"string"},"name":"userGroupId","in":"path","required":true,"description":null}],"responses":{"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.security.SecurityServices.updateUserGroupPermission.In"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/co.hotwax.security.SecurityServices.updateUserGroupPermission.In"}}},"required":true}}}}}
```

## find UserGroupUsers

> Get the users currently in a group

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"userGroups","description":"Manage native Moqui user groups (moqui.security.UserGroup)"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.security.SecurityServices.findUserGroupUsers.Out":{"type":"object","properties":{"userList":{"type":"array"}}}}},"paths":{"/userGroups/{userGroupId}/users":{"get":{"tags":["userGroups"],"summary":"find UserGroupUsers","description":"Get the users currently in a group","parameters":[{"schema":{"type":"string"},"name":"userGroupId","in":"path","required":true,"description":null},{"schema":{"type":"integer","format":"int32"},"name":"pageIndex","in":"query","required":false,"description":null},{"schema":{"type":"integer","format":"int32"},"name":"pageSize","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.security.SecurityServices.findUserGroupUsers.Out"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## find ArtifactAuthzs

> Replaces GET /admin/userGroups/{userGroupId}/artifactAuthorizations

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"userGroups","description":"Manage native Moqui user groups (moqui.security.UserGroup)"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.security.SecurityServices.findArtifactAuthzs.Out":{"type":"object","properties":{"artifactAuthzList":{"type":"array"},"artifactAuthzListCount":{"type":"integer","format":"int32"}}}}},"paths":{"/userGroups/{userGroupId}/artifactAuthorizations":{"get":{"tags":["userGroups"],"summary":"find ArtifactAuthzs","description":"Replaces GET /admin/userGroups/{userGroupId}/artifactAuthorizations","parameters":[{"schema":{"type":"string"},"name":"userGroupId","in":"path","required":true,"description":null},{"schema":{"type":"string","format":""},"name":"artifactGroupId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"orderByField","in":"query","required":false,"description":null},{"schema":{"type":"integer","format":"int32"},"name":"pageIndex","in":"query","required":false,"description":null},{"schema":{"type":"integer","format":"int32"},"name":"pageSize","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.security.SecurityServices.findArtifactAuthzs.Out"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## create ArtifactAuthz

> Replaces POST /admin/userGroups/{userGroupId}/artifactAuthorizations

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"userGroups","description":"Manage native Moqui user groups (moqui.security.UserGroup)"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.security.SecurityServices.createArtifactAuthz.Out":{"type":"object","properties":{"artifactAuthzId":{"type":"string"}}},"co.hotwax.security.SecurityServices.createArtifactAuthz.In":{"type":"object","properties":{"artifactAuthzId":{"type":"string"},"userGroupId":{"type":"string"},"artifactGroupId":{"type":"string"},"authzTypeEnumId":{"type":"string","enum":["AUTHZT_ALLOW","AUTHZT_ALWAYS","AUTHZT_DENY"]},"authzActionEnumId":{"type":"string","enum":["AUTHZA_ALL","AUTHZA_CREATE","AUTHZA_DELETE","AUTHZA_UPDATE","AUTHZA_VIEW"]},"authzServiceName":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}},"required":["userGroupId","artifactGroupId"]}}},"paths":{"/userGroups/{userGroupId}/artifactAuthorizations":{"post":{"tags":["userGroups"],"summary":"create ArtifactAuthz","description":"Replaces POST /admin/userGroups/{userGroupId}/artifactAuthorizations","parameters":[{"schema":{"type":"string"},"name":"userGroupId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.security.SecurityServices.createArtifactAuthz.Out"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.security.SecurityServices.createArtifactAuthz.In"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/co.hotwax.security.SecurityServices.createArtifactAuthz.In"}}},"required":true}}}}}
```

## get ArtifactAuthz

> Replaces GET /admin/userGroups/{userGroupId}/artifactAuthorizations/{artifactAuthzId}

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"userGroups","description":"Manage native Moqui user groups (moqui.security.UserGroup)"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.security.SecurityServices.getArtifactAuthz.Out":{"type":"object","properties":{"artifactAuthz":{"type":"object"}}}}},"paths":{"/userGroups/{userGroupId}/artifactAuthorizations/{artifactAuthzId}":{"get":{"tags":["userGroups"],"summary":"get ArtifactAuthz","description":"Replaces GET /admin/userGroups/{userGroupId}/artifactAuthorizations/{artifactAuthzId}","parameters":[{"schema":{"type":"string"},"name":"userGroupId","in":"path","required":true,"description":null},{"schema":{"type":"string"},"name":"artifactAuthzId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.security.SecurityServices.getArtifactAuthz.Out"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## update ArtifactAuthz

> Replaces PUT /admin/userGroups/{userGroupId}/artifactAuthorizations/{artifactAuthzId}

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"userGroups","description":"Manage native Moqui user groups (moqui.security.UserGroup)"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.security.SecurityServices.updateArtifactAuthz.In":{"type":"object","properties":{"artifactAuthzId":{"type":"string"},"userGroupId":{"type":"string"},"artifactGroupId":{"type":"string"},"authzTypeEnumId":{"type":"string","enum":["AUTHZT_ALLOW","AUTHZT_ALWAYS","AUTHZT_DENY"]},"authzActionEnumId":{"type":"string","enum":["AUTHZA_ALL","AUTHZA_CREATE","AUTHZA_DELETE","AUTHZA_UPDATE","AUTHZA_VIEW"]},"authzServiceName":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}},"required":["artifactAuthzId"]}}},"paths":{"/userGroups/{userGroupId}/artifactAuthorizations/{artifactAuthzId}":{"put":{"tags":["userGroups"],"summary":"update ArtifactAuthz","description":"Replaces PUT /admin/userGroups/{userGroupId}/artifactAuthorizations/{artifactAuthzId}","parameters":[{"schema":{"type":"string"},"name":"userGroupId","in":"path","required":true,"description":null},{"schema":{"type":"string"},"name":"artifactAuthzId","in":"path","required":true,"description":null}],"responses":{"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.security.SecurityServices.updateArtifactAuthz.In"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/co.hotwax.security.SecurityServices.updateArtifactAuthz.In"}}},"required":true}}}}}
```

## delete ArtifactAuthz

> Replaces DELETE /admin/userGroups/{userGroupId}/artifactAuthorizations/{artifactAuthzId}

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"userGroups","description":"Manage native Moqui user groups (moqui.security.UserGroup)"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}}},"paths":{"/userGroups/{userGroupId}/artifactAuthorizations/{artifactAuthzId}":{"delete":{"tags":["userGroups"],"summary":"delete ArtifactAuthz","description":"Replaces DELETE /admin/userGroups/{userGroupId}/artifactAuthorizations/{artifactAuthzId}","parameters":[{"schema":{"type":"string"},"name":"userGroupId","in":"path","required":true,"description":null},{"schema":{"type":"string"},"name":"artifactAuthzId","in":"path","required":true,"description":null}],"responses":{"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.hotwax.co/documents/integrate-with-hotwax/components/admin/user-groups.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
