Skip to main content

policies_bindings_list

GET 
/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​

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

    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.

  • ]

Loading...