get.users.users.yaml

# This action was auto generated from the NetBox API Swagger Spec
# NetBox API version: 4.0
description: "Get a list of user objects."
enabled: true
entry_point: run.py
name: get.users.users
parameters:
  endpoint_uri:
    default: "/users/users/"
    immutable: true
    type: string
  http_verb:
    default: get
    immutable: true
    type: string
  get_detail_route_eligible:
    default: true
    immutable: true
    type: boolean
  date_joined:
    required: false
    type: array
    description: "Date_joined"
  date_joined__empty:
    required: false
    type: boolean
    description: "Date_joined is empty/null (boolean)"
  date_joined__gt:
    required: false
    type: array
    description: "Date_joined greater than"
  date_joined__gte:
    required: false
    type: array
    description: "Date_joined greater than or equal to"
  date_joined__lt:
    required: false
    type: array
    description: "Date_joined less than"
  date_joined__lte:
    required: false
    type: array
    description: "Date_joined less than or equal to"
  date_joined__n:
    required: false
    type: array
    description: "Date_joined not equal to"
  email:
    required: false
    type: array
    description: "Email"
  email__empty:
    required: false
    type: boolean
    description: "Email is empty/null (boolean)"
  email__ic:
    required: false
    type: array
    description: "Email contains (case-insensitive)"
  email__ie:
    required: false
    type: array
    description: "Email exact match (case-insensitive)"
  email__iew:
    required: false
    type: array
    description: "Email ends with (case-insensitive)"
  email__isw:
    required: false
    type: array
    description: "Email starts with (case-sensitive)"
  email__n:
    required: false
    type: array
    description: "Email not equal to"
  email__nic:
    required: false
    type: array
    description: "Email does not contain (case-insensitive)"
  email__nie:
    required: false
    type: array
    description: "Email inverse exact match (case-insensitive)"
  email__niew:
    required: false
    type: array
    description: "Email does not end with (case-insensitive)"
  email__nisw:
    required: false
    type: array
    description: "Email does not start with (case-sensitive)"
  first_name:
    required: false
    type: array
    description: "First_name"
  first_name__empty:
    required: false
    type: boolean
    description: "First_name is empty/null (boolean)"
  first_name__ic:
    required: false
    type: array
    description: "First_name contains (case-insensitive)"
  first_name__ie:
    required: false
    type: array
    description: "First_name exact match (case-insensitive)"
  first_name__iew:
    required: false
    type: array
    description: "First_name ends with (case-insensitive)"
  first_name__isw:
    required: false
    type: array
    description: "First_name starts with (case-sensitive)"
  first_name__n:
    required: false
    type: array
    description: "First_name not equal to"
  first_name__nic:
    required: false
    type: array
    description: "First_name does not contain (case-insensitive)"
  first_name__nie:
    required: false
    type: array
    description: "First_name inverse exact match (case-insensitive)"
  first_name__niew:
    required: false
    type: array
    description: "First_name does not end with (case-insensitive)"
  first_name__nisw:
    required: false
    type: array
    description: "First_name does not start with (case-sensitive)"
  group:
    required: false
    type: array
    description: "Group (name)"
  group__n:
    required: false
    type: array
    description: "Group not equal to"
  group_id:
    required: false
    type: array
    description: "Group"
  group_id__n:
    required: false
    type: array
    description: "Group_id not equal to"
  id:
    required: false
    type: array
    description: "Id"
  id__empty:
    required: false
    type: boolean
    description: "Id is empty/null (boolean)"
  id__gt:
    required: false
    type: array
    description: "Id greater than"
  id__gte:
    required: false
    type: array
    description: "Id greater than or equal to"
  id__lt:
    required: false
    type: array
    description: "Id less than"
  id__lte:
    required: false
    type: array
    description: "Id less than or equal to"
  id__n:
    required: false
    type: array
    description: "Id not equal to"
  is_active:
    required: false
    type: boolean
    description: "Is_active"
  is_staff:
    required: false
    type: boolean
    description: "Is_staff"
  is_superuser:
    required: false
    type: boolean
    description: "Is_superuser"
  last_login:
    required: false
    type: array
    description: "Last_login"
  last_login__empty:
    required: false
    type: boolean
    description: "Last_login is empty/null (boolean)"
  last_login__gt:
    required: false
    type: array
    description: "Last_login greater than"
  last_login__gte:
    required: false
    type: array
    description: "Last_login greater than or equal to"
  last_login__lt:
    required: false
    type: array
    description: "Last_login less than"
  last_login__lte:
    required: false
    type: array
    description: "Last_login less than or equal to"
  last_login__n:
    required: false
    type: array
    description: "Last_login not equal to"
  last_name:
    required: false
    type: array
    description: "Last_name"
  last_name__empty:
    required: false
    type: boolean
    description: "Last_name is empty/null (boolean)"
  last_name__ic:
    required: false
    type: array
    description: "Last_name contains (case-insensitive)"
  last_name__ie:
    required: false
    type: array
    description: "Last_name exact match (case-insensitive)"
  last_name__iew:
    required: false
    type: array
    description: "Last_name ends with (case-insensitive)"
  last_name__isw:
    required: false
    type: array
    description: "Last_name starts with (case-sensitive)"
  last_name__n:
    required: false
    type: array
    description: "Last_name not equal to"
  last_name__nic:
    required: false
    type: array
    description: "Last_name does not contain (case-insensitive)"
  last_name__nie:
    required: false
    type: array
    description: "Last_name inverse exact match (case-insensitive)"
  last_name__niew:
    required: false
    type: array
    description: "Last_name does not end with (case-insensitive)"
  last_name__nisw:
    required: false
    type: array
    description: "Last_name does not start with (case-sensitive)"
  limit:
    required: false
    type: integer
    description: "Number of results to return per page."
  offset:
    required: false
    type: integer
    description: "The initial index from which to return the results."
  ordering:
    required: false
    type: string
    description: "Which field to use when ordering the results."
  permission_id:
    required: false
    type: array
    description: "Permission (ID)"
  permission_id__n:
    required: false
    type: array
    description: "Permission_id not equal to"
  q:
    required: false
    type: string
    description: "Search"
  username:
    required: false
    type: array
    description: "Username"
  username__empty:
    required: false
    type: boolean
    description: "Username is empty/null (boolean)"
  username__ic:
    required: false
    type: array
    description: "Username contains (case-insensitive)"
  username__ie:
    required: false
    type: array
    description: "Username exact match (case-insensitive)"
  username__iew:
    required: false
    type: array
    description: "Username ends with (case-insensitive)"
  username__isw:
    required: false
    type: array
    description: "Username starts with (case-sensitive)"
  username__n:
    required: false
    type: array
    description: "Username not equal to"
  username__nic:
    required: false
    type: array
    description: "Username does not contain (case-insensitive)"
  username__nie:
    required: false
    type: array
    description: "Username inverse exact match (case-insensitive)"
  username__niew:
    required: false
    type: array
    description: "Username does not end with (case-insensitive)"
  username__nisw:
    required: false
    type: array
    description: "Username does not start with (case-sensitive)"
  save_in_key_store:
    type: boolean
    default: false
    description: Save the result of the action as a json object in the st2 key store. Used when the expected result from Netbox is very large and the result will be piped to another action. You must also specify a save_in_key_store_keyname and an optional save_in_key_store_ttl.
  save_in_key_store_key_name:
    type: string
    description: Name of the key to store the json result value in the st2 key store. Must be used with save_in_key_store and optionally save_in_key_store_ttl.
  save_in_key_store_ttl:
    type: integer
    default: 60
    description: TTL (seconds) of the saved json result in the st2 key store. Defaults to 60 seconds. Must be used with save_in_key_store and save_in_key_store_key_name.
runner_type: python-script