Update an action's permissions
PATCH/v1/actions/:action_identifier/permissions
This route allows you to update the permissions of a self-service action.
To learn more about action RBAC, check out the documentation.
Request
Path Parameters
Possible values: non-empty
The identifier of the action you want to update permissions for.
- application/json
Body
Array [
- Number rule
- Date rule
- String rule
- Empty rule
- Relation rule
- Property rule
- Date range
- Date preset
- string
- number
- boolean
- array
- date-time
Array [
]
- string
- number
- boolean
]
Array [
- Number rule
- Date rule
- String rule
- Empty rule
- Relation rule
- Property rule
- object
- Date range
- Date preset
- string
- number
- boolean
- array
- date-time
Array [
]
- string
- number
- boolean
]
execute
object
An object used to define who can execute the action.
The email addresses of the users who can execute the action.
The roles that can execute the action.
The names of the teams whose members can execute the action.
Relevant only for DAY-2/DELETE actions. If true, any member of the team that the entity belongs to can execute the action.
policy
object
An optional custom policy the determines if action execution is allowed.
See instructions and examples here.
queries
object
required
One or more queries to fetch data from your software catalog.
property name*
object
Possible values: [and, or]
rules
object[]
required
anyOf
Possible values: [>, >=, <, <=]
Possible values: [between, notBetween, =]
value
object
required
oneOf
Possible values: [today, tomorrow, yesterday, lastWeek, last2Weeks, lastMonth, last3Months, last6Months, last12Months]
Possible values: [=, !=, containsAny, contains, doesNotContain, beginsWith, doesNotBeginWith, endsWith, doesNotEndWith, in, notIn]
value
object
required
anyOf
string
number
boolean
string
string
Possible values: [isEmpty, isNotEmpty]
Possible values: [relatedTo]
Possible values: [upstream, downstream]
propertySchema
object
required
Possible values: [=, !=]
value
object
anyOf
string
number
boolean
Possible values: >= 1
JQ expressions that run against the provided queries, and resolve to a boolean value (true = allowed to execute).
approve
object
An object used to define who can approve the action.
The email addresses of the users who can approve the action.
The roles that can approve the action.
The names of the teams whose members can approve the action.
policy
object
An optional custom policy the determines who can approve the action.
See instructions and examples here.
queries
object
required
One or more queries to fetch data from your software catalog.
property name*
object
Possible values: [and, or]
rules
object[]
required
anyOf
Possible values: [>, >=, <, <=]
Possible values: [between, notBetween, =]
value
object
required
oneOf
Possible values: [today, tomorrow, yesterday, lastWeek, last2Weeks, lastMonth, last3Months, last6Months, last12Months]
Possible values: [=, !=, containsAny, contains, doesNotContain, beginsWith, doesNotBeginWith, endsWith, doesNotEndWith, in, notIn]
value
object
required
anyOf
string
number
boolean
string
string
Possible values: [isEmpty, isNotEmpty]
Possible values: [relatedTo]
Possible values: [upstream, downstream]
propertySchema
object
required
Possible values: [=, !=]
value
object
anyOf
string
number
boolean
Possible values: >= 1
JQ expressions that run against the provided queries, and resolve to an array of strings (email addresses of users who can approve the action).
Responses
- 200
- 404
- 422
- 500
Success
One of the following errors occurred:
| Error | Description |
|---|---|
not_found | The action with the provided identifier was not found |
One of the following errors occurred:
| Error | Description |
|---|---|
invalid_request | The data provided does not match the route schema |
One of the following errors occurred:
| Error | Description |
|---|---|
internal_error | An internal error occurred |