PATCH
/
templates
/
{template}
/
acl
curl --request PATCH \
  --url https://cloud.local.wirtual.dev/api/v2/templates/{template}/acl \
  --header 'Content-Type: application/json' \
  --header 'Wirtual-Session-Token: <api-key>' \
  --data '{
  "group_perms": {
    "8bd26b20-f3e8-48be-a903-46bb920cf671": "use",
    "<user_id>>": "admin"
  },
  "user_perms": {
    "4df59e74-c027-470b-ab4d-cbba8963a5e9": "use",
    "<group_id>": "admin"
  }
}'
{
  "detail": "<string>",
  "message": "<string>",
  "validations": [
    {
      "detail": "<string>",
      "field": "<string>"
    }
  ]
}

Authorizations

​
Wirtual-Session-Token
string
header
required

Path Parameters

​
template
string
required

Template ID

Body

application/json
Update template request
​
group_perms
object

GroupPerms should be a mapping of group id to role.

Example:
{
  "8bd26b20-f3e8-48be-a903-46bb920cf671": "use",
  "<user_id>>": "admin"
}
​
user_perms
object

UserPerms should be a mapping of user id to role. The user id must be the uuid of the user, not a username or email address.

Example:
{
  "4df59e74-c027-470b-ab4d-cbba8963a5e9": "use",
  "<group_id>": "admin"
}

Response

200 - application/json
OK
​
detail
string

Detail is a debug message that provides further insight into why the action failed. This information can be technical and a regular golang err.Error() text.

  • "database: too many open connections"
  • "stat: too many open files"
​
message
string

Message is an actionable message that depicts actions the request took. These messages should be fully formed sentences with proper punctuation. Examples:

  • "A user has been created."
  • "Failed to create a user."
​
validations
object[]

Validations are form field-specific friendly error messages. They will be shown on a form field in the UI. These can also be used to add additional context if there is a set of errors in the primary 'Message'.