Skip to content

Replace model-bound security grants for one entitlement model.

PUT
/api/workspace/admin/entitlement-operations/models/{modelId}/security
curl --request PUT \
--url https://example.com/api/workspace/admin/entitlement-operations/models/example/security \
--header 'Content-Type: application/json' \
--data '{ "Grants": [ { "RoleId": "example", "Capability": 0 } ] }'
  • None
modelId
required
string
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Security settings replacement request for one entitlement model.

object
Grants
required
Array<object>

Security grant submitted by the model security screen.

object
RoleId
required
string
Capability
integer format: int32
Allowed values: 0 1 2

OK

Media typeapplication/json
object
Data

Security settings for one entitlement model.

object
EntitlementModelId
string
nullable
Grants
Array<object>
nullable

Role grant materialized for one entitlement model security screen.

object
Id
string
nullable
EntitlementModelId
string
nullable
RoleId
string
nullable
RoleName
string
nullable
Capability
integer format: int32
Allowed values: 0 1 2
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Grants": [
{
"Capability": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Bad Request

Media typeapplication/json
object
Data

Security settings for one entitlement model.

object
EntitlementModelId
string
nullable
Grants
Array<object>
nullable

Role grant materialized for one entitlement model security screen.

object
Id
string
nullable
EntitlementModelId
string
nullable
RoleId
string
nullable
RoleName
string
nullable
Capability
integer format: int32
Allowed values: 0 1 2
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Grants": [
{
"Capability": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/json
object
Data

Security settings for one entitlement model.

object
EntitlementModelId
string
nullable
Grants
Array<object>
nullable

Role grant materialized for one entitlement model security screen.

object
Id
string
nullable
EntitlementModelId
string
nullable
RoleId
string
nullable
RoleName
string
nullable
Capability
integer format: int32
Allowed values: 0 1 2
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Grants": [
{
"Capability": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}