policies_bindings_list

GET 
/api/v3//policies/bindings/

PolicyBinding Viewset

Request

Query Parameters

enabled boolean
order integer
ordering string

Which field to use when ordering the results.

page integer

A page number within the paginated result set.

page_size integer

Number of results to return per page.

policy uuid
policy__isnull boolean
search string

A search term.

target uuid
target_in uuid[]
timeout integer

Responses

200

application/json

Schema

Schema

pagination objectrequired
nextnumberrequired
previousnumberrequired
countnumberrequired
currentnumberrequired
total_pagesnumberrequired
start_indexnumberrequired
end_indexnumberrequired
results object[]required
Array [
pkuuidrequired
policyuuidnullable
groupuuidnullable
userintegernullable
policy_obj object
Policy Serializer
pkuuidrequired
namestringrequired
execution_loggingboolean
When this option is enabled, all executions of this policy will be logged. By default, only execution errors are logged.
componentstringrequired
Get object component so that we know how to edit the object
verbose_namestringrequired
Return object's verbose_name
verbose_name_pluralstringrequired
Return object's plural verbose_name
meta_model_namestringrequired
Return internal model name
bound_tointegerrequired
Return objects policy is bound to
group_obj object
Group Serializer
pkuuidrequired
num_pkintegerrequired
namestringrequired
is_superuserboolean
Users added to this group will be superusers.
parentuuidnullable
parent_namestringnullablerequired
usersinteger[]
users_obj object[]nullablerequired
Array [
pkID (integer)required
usernamestringrequired
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
Possible values: <= 150 characters, Value must match regular expression ^[\w.@+-]+$
namestringrequired
User's display name.
is_activeActive (boolean)
Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_logindate-timenullable
emailemail
Possible values: <= 254 characters
attributes object
property name*any
uidstringrequired
]
attributes object
property name*any
rolesuuid[]
roles_obj object[]required
Array [
pkuuidrequired
namestringrequired
Possible values: <= 150 characters
]
user_obj object
User Serializer
pkID (integer)required
usernamestringrequired
Possible values: <= 150 characters
namestringrequired
User's display name.
is_activeActive (boolean)
Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_logindate-timenullable
is_superuserbooleanrequired
groupsuuid[]
groups_obj object[]nullablerequired
Array [
pkuuidrequired
num_pkintegerrequired
Get a numerical, int32 ID for the group
namestringrequired
is_superuserboolean
Users added to this group will be superusers.
parentuuidnullable
parent_namestringnullablerequired
attributes object
property name*any
]
emailemail
Possible values: <= 254 characters
avatarstringrequired
User's avatar, either a http/https URL or a data URI
attributes object
property name*any
uidstringrequired
pathstring
typeUserTypeEnum (string)
Possible values: [internal, external, service_account, internal_service_account]
uuiduuidrequired
password_change_datedate-timerequired
targetuuidrequired
negateboolean
Negates the outcome of the policy. Messages are unaffected.
enabledboolean
orderintegerrequired
Possible values: >= -2147483648 and <= 2147483647
timeoutinteger
Timeout after which Policy execution is terminated.
Possible values: <= 2147483647
failure_resultboolean
Result if the Policy execution fails.
]

Example (auto)

{
  "pagination": {
    "next": 0,
    "previous": 0,
    "count": 0,
    "current": 0,
    "total_pages": 0,
    "start_index": 0,
    "end_index": 0
  },
  "results": [
    {
      "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "policy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "user": 0,
      "policy_obj": {
        "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "execution_logging": true,
        "component": "string",
        "verbose_name": "string",
        "verbose_name_plural": "string",
        "meta_model_name": "string",
        "bound_to": 0
      },
      "group_obj": {
        "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "num_pk": 0,
        "name": "string",
        "is_superuser": true,
        "parent": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "parent_name": "string",
        "users": [
          0
        ],
        "users_obj": [
          {
            "pk": 0,
            "username": "string",
            "name": "string",
            "is_active": true,
            "last_login": "2024-07-29T15:51:28.071Z",
            "email": "user@example.com",
            "attributes": {},
            "uid": "string"
          }
        ],
        "attributes": {},
        "roles": [
          "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        ],
        "roles_obj": [
          {
            "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string"
          }
        ]
      },
      "user_obj": {
        "pk": 0,
        "username": "string",
        "name": "string",
        "is_active": true,
        "last_login": "2024-07-29T15:51:28.071Z",
        "is_superuser": true,
        "groups": [
          "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        ],
        "groups_obj": [
          {
            "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "num_pk": 0,
            "name": "string",
            "is_superuser": true,
            "parent": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "parent_name": "string",
            "attributes": {}
          }
        ],
        "email": "user@example.com",
        "avatar": "string",
        "attributes": {},
        "uid": "string",
        "path": "string",
        "type": "internal",
        "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "password_change_date": "2024-07-29T15:51:28.071Z"
      },
      "target": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "negate": true,
      "enabled": true,
      "order": 0,
      "timeout": 0,
      "failure_result": true
    }
  ]
}

400

application/json

Schema

Schema

non_field_errorsstring[]

codestring

property name*any

Validation Error

Example (auto)

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

403

application/json

Schema

Schema

detailstringrequired
codestring

Example (auto)

{
  "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.Get, "/api/v3/policies/bindings/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
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

enabled — query

---truefalse

order — query

ordering — query

page — query

page_size — query

policy — query

policy__isnull — query

---truefalse

search — query

target — query

target_in — query

timeout — query