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

object

required

next numberrequired

previous numberrequired

count numberrequired

current numberrequired

total_pages numberrequired

start_index numberrequired

end_index numberrequired

results

object[]

required

Array [

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

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

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

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

Possible values: <= 2147483647

Timeout after which Policy execution is terminated.

failure_result boolean

Result if the Policy execution fails.

]

Example (from schema)

{
  "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"
      },
      "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"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '/api/v3/policies/bindings/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

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