policies_bindings_partial_update

PATCH 
/api/v3//policies/bindings/:policy_binding_uuid/

PolicyBinding Viewset

Request

Path Parameters

policy_binding_uuid uuidrequired

A UUID string identifying this Policy Binding.

application/json

Body

policy uuidnullable
group uuidnullable
user integernullable
target uuid
negate boolean

Negates the outcome of the policy. Messages are unaffected.

enabled boolean
order integer

Possible values: >= -2147483648 and <= 2147483647

timeout integer

Timeout after which Policy execution is terminated.

Possible values: <= 2147483647

failure_result boolean

Result if the Policy execution fails.

Responses

200

application/json

Schema

Schema

pk uuidrequired
policy uuidnullable
group uuidnullable
user integernullable

policy_obj

object

required

Policy Serializer

pk uuidrequired

name stringrequired

execution_logging boolean

When this option is enabled, all executions of this policy will be logged. By default, only execution errors are logged.

component stringrequired

Get object component so that we know how to edit the object

verbose_name stringrequired

Return object's verbose_name

verbose_name_plural stringrequired

Return object's plural verbose_name

meta_model_name stringrequired

Return internal model name

bound_to integerrequired

Return objects policy is bound to

group_obj

object

required

Group Serializer

pk uuidrequired

num_pk integerrequired

name stringrequired

is_superuser boolean

Users added to this group will be superusers.

parent uuidnullable

parent_name stringnullablerequired

users integer[]

users_obj

object[]

nullable

required

Array [

pk ID (integer)required

username stringrequired

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Possible values: <= 150 characters, Value must match regular expression ^[\w.@+-]+$

name stringrequired

User's display name.

is_active Active (boolean)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

last_login date-timenullable

email email

Possible values: <= 254 characters

attributes object

uid stringrequired

]

attributes object

roles uuid[]

roles_obj

object[]

required

Array [

pk uuidrequired

name stringrequired

Possible values: <= 150 characters

]

user_obj

object

required

User Serializer

pk ID (integer)required

username stringrequired

Possible values: <= 150 characters

name stringrequired

User's display name.

is_active Active (boolean)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

last_login date-timenullable

is_superuser booleanrequired

groups uuid[]

groups_obj

object[]

nullable

required

Array [

pk uuidrequired

num_pk integerrequired

Get a numerical, int32 ID for the group

name stringrequired

is_superuser boolean

Users added to this group will be superusers.

parent uuidnullable

parent_name stringnullablerequired

attributes object

]

email email

Possible values: <= 254 characters

avatar stringrequired

User's avatar, either a http/https URL or a data URI

attributes object

uid stringrequired

path string

type UserTypeEnum (string)

Possible values: [internal, external, service_account, internal_service_account]

uuid uuidrequired
target uuidrequired
negate boolean

Negates the outcome of the policy. Messages are unaffected.

enabled boolean
order integerrequired

Possible values: >= -2147483648 and <= 2147483647

timeout integer

Timeout after which Policy execution is terminated.

Possible values: <= 2147483647

failure_result boolean

Result if the Policy execution fails.

Example (from schema)

{
  "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "policy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "user": 0,
  "target": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "negate": true,
  "enabled": true,
  "order": 0,
  "timeout": 0,
  "failure_result": true
}

400

application/json

Schema

Schema

non_field_errors string[]
code string
property name* any

Validation Error

Example (from schema)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

{
  "detail": "string",
  "code": "string"
}

Authorization: http

name: authentiktype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "/api/v3/policies/bindings/:policy_binding_uuid/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <TOKEN>");
var content = new StringContent("{\n  \"policy\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"group\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"user\": 0,\n  \"target\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"negate\": true,\n  \"enabled\": true,\n  \"order\": 0,\n  \"timeout\": 0,\n  \"failure_result\": true\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

policy_binding_uuid — pathrequired

Body

{
  "policy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "user": 0,
  "target": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "negate": true,
  "enabled": true,
  "order": 0,
  "timeout": 0,
  "failure_result": true
}