naftiko: 1.0.0-alpha2 info: label: NetBox REST API — users description: 'NetBox REST API — users. 56 operations. Lead operation: users. Self-contained Naftiko capability covering one Netbox business surface.' tags: - Netbox - users created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: NETBOX_API_KEY: NETBOX_API_KEY capability: consumes: - type: http namespace: netbox-users baseUri: '' description: NetBox REST API — users business capability. Self-contained, no shared references. resources: - name: api-users-config path: /api/users/config/ operations: - name: usersconfigretrieve method: GET description: An API endpoint via which a user can update his or her own UserConfig data (but no one else's). outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-users-groups path: /api/users/groups/ operations: - name: usersgroupslist method: GET description: Get a list of group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: notification_group_id in: query type: array description: Notification group (ID) - name: notification_group_id__n in: query type: array description: Notification group (ID) - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: permission_id in: query type: array description: Permission (ID) - name: permission_id__n in: query type: array description: Permission (ID) - name: q in: query type: string description: Search - name: user_id in: query type: array description: User (ID) - name: user_id__n in: query type: array description: User (ID) - name: usersgroupscreate method: POST description: Post a list of group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: usersgroupsbulkupdate method: PUT description: Put a list of group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: usersgroupsbulkpartialupdate method: PATCH description: Patch a list of group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: usersgroupsbulkdestroy method: DELETE description: Delete a list of group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-users-groups-id path: /api/users/groups/{id}/ operations: - name: usersgroupsretrieve method: GET description: Get a group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this group. required: true - name: usersgroupsupdate method: PUT description: Put a group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this group. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: usersgroupspartialupdate method: PATCH description: Patch a group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this group. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: usersgroupsdestroy method: DELETE description: Delete a group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this group. required: true - name: api-users-owner-groups path: /api/users/owner-groups/ operations: - name: usersownergroupslist method: GET description: Get a list of owner group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: q in: query type: string description: Search - name: usersownergroupscreate method: POST description: Post a list of owner group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: usersownergroupsbulkupdate method: PUT description: Put a list of owner group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: usersownergroupsbulkpartialupdate method: PATCH description: Patch a list of owner group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: usersownergroupsbulkdestroy method: DELETE description: Delete a list of owner group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-users-owner-groups-id path: /api/users/owner-groups/{id}/ operations: - name: usersownergroupsretrieve method: GET description: Get a owner group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this owner group. required: true - name: usersownergroupsupdate method: PUT description: Put a owner group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this owner group. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: usersownergroupspartialupdate method: PATCH description: Patch a owner group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this owner group. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: usersownergroupsdestroy method: DELETE description: Delete a owner group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this owner group. required: true - name: api-users-owners path: /api/users/owners/ operations: - name: usersownerslist method: GET description: Get a list of owner objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: group in: query type: array description: Group (name) - name: group__n in: query type: array description: Group (name) - name: group_id in: query type: array description: Group (ID) - name: group_id__n in: query type: array description: Group (ID) - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: q in: query type: string description: Search - name: user in: query type: array description: User (username) - name: user__n in: query type: array description: User (username) - name: user_group in: query type: array description: User group (name) - name: user_group__n in: query type: array description: User group (name) - name: user_group_id in: query type: array description: User group (ID) - name: user_group_id__n in: query type: array description: User group (ID) - name: user_id in: query type: array description: User (ID) - name: user_id__n in: query type: array description: User (ID) - name: usersownerscreate method: POST description: Post a list of owner objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: usersownersbulkupdate method: PUT description: Put a list of owner objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: usersownersbulkpartialupdate method: PATCH description: Patch a list of owner objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: usersownersbulkdestroy method: DELETE description: Delete a list of owner objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-users-owners-id path: /api/users/owners/{id}/ operations: - name: usersownersretrieve method: GET description: Get a owner object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this owner. required: true - name: usersownersupdate method: PUT description: Put a owner object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this owner. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: usersownerspartialupdate method: PATCH description: Patch a owner object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this owner. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: usersownersdestroy method: DELETE description: Delete a owner object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this owner. required: true - name: api-users-permissions path: /api/users/permissions/ operations: - name: userspermissionslist method: GET description: Get a list of permission objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: can_add in: query type: boolean - name: can_change in: query type: boolean - name: can_delete in: query type: boolean - name: can_view in: query type: boolean - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: enabled in: query type: boolean - name: group in: query type: array description: Group (name) - name: group__n in: query type: array description: Group (name) - name: group_id in: query type: array description: Group - name: group_id__n in: query type: array description: Group - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: object_type in: query type: array - name: object_type__ic in: query type: array - name: object_type__ie in: query type: array - name: object_type__iew in: query type: array - name: object_type__iregex in: query type: array - name: object_type__isw in: query type: array - name: object_type__n in: query type: array - name: object_type__nic in: query type: array - name: object_type__nie in: query type: array - name: object_type__niew in: query type: array - name: object_type__nisw in: query type: array - name: object_type__regex in: query type: array - name: object_type_id in: query type: array - name: object_type_id__n in: query type: array - name: object_types in: query type: array - name: object_types__n in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: q in: query type: string description: Search - name: user in: query type: array description: User (name) - name: user__n in: query type: array description: User (name) - name: user_id in: query type: array description: User - name: user_id__n in: query type: array description: User - name: userspermissionscreate method: POST description: Post a list of permission objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: userspermissionsbulkupdate method: PUT description: Put a list of permission objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: userspermissionsbulkpartialupdate method: PATCH description: Patch a list of permission objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: userspermissionsbulkdestroy method: DELETE description: Delete a list of permission objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-users-permissions-id path: /api/users/permissions/{id}/ operations: - name: userspermissionsretrieve method: GET description: Get a permission object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this permission. required: true - name: userspermissionsupdate method: PUT description: Put a permission object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this permission. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: userspermissionspartialupdate method: PATCH description: Patch a permission object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this permission. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: userspermissionsdestroy method: DELETE description: Delete a permission object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this permission. required: true - name: api-users-tokens path: /api/users/tokens/ operations: - name: userstokenslist method: GET description: Get a list of token objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: created in: query type: string - name: created__gte in: query type: string - name: created__lte in: query type: string - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: enabled in: query type: boolean - name: expires in: query type: string - name: expires__gte in: query type: string - name: expires__lte in: query type: string - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: key in: query type: array - name: key__empty in: query type: boolean - name: key__ic in: query type: array - name: key__ie in: query type: array - name: key__iew in: query type: array - name: key__iregex in: query type: array - name: key__isw in: query type: array - name: key__n in: query type: array - name: key__nic in: query type: array - name: key__nie in: query type: array - name: key__niew in: query type: array - name: key__nisw in: query type: array - name: key__regex in: query type: array - name: last_used in: query type: string - name: last_used__gte in: query type: string - name: last_used__lte in: query type: string - name: limit in: query type: integer description: Number of results to return per page. - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: pepper_id in: query type: array - name: pepper_id__empty in: query type: boolean - name: pepper_id__gt in: query type: array - name: pepper_id__gte in: query type: array - name: pepper_id__lt in: query type: array - name: pepper_id__lte in: query type: array - name: pepper_id__n in: query type: array - name: q in: query type: string description: Search - name: user in: query type: array description: User (name) - name: user__n in: query type: array description: User (name) - name: user_id in: query type: array description: User - name: user_id__n in: query type: array description: User - name: version in: query type: integer description: '* `1` - v1' - name: version__ic in: query type: array - name: version__ie in: query type: array - name: version__iew in: query type: array - name: version__iregex in: query type: array - name: version__isw in: query type: array - name: version__n in: query type: integer description: '* `1` - v1' - name: version__nic in: query type: array - name: version__nie in: query type: array - name: version__niew in: query type: array - name: version__nisw in: query type: array - name: version__regex in: query type: array - name: write_enabled in: query type: boolean - name: userstokenscreate method: POST description: Post a list of token objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: userstokensbulkupdate method: PUT description: Put a list of token objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: userstokensbulkpartialupdate method: PATCH description: Patch a list of token objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: userstokensbulkdestroy method: DELETE description: Delete a list of token objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-users-tokens-provision path: /api/users/tokens/provision/ operations: - name: userstokensprovisioncreate method: POST description: Non-authenticated REST API endpoint via which a user may create a Token. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-users-tokens-id path: /api/users/tokens/{id}/ operations: - name: userstokensretrieve method: GET description: Get a token object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this token. required: true - name: userstokensupdate method: PUT description: Put a token object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this token. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: userstokenspartialupdate method: PATCH description: Patch a token object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this token. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: userstokensdestroy method: DELETE description: Delete a token object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this token. required: true - name: api-users-users path: /api/users/users/ operations: - name: usersuserslist method: GET description: Get a list of user objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: date_joined in: query type: array - name: date_joined__empty in: query type: boolean - name: date_joined__gt in: query type: array - name: date_joined__gte in: query type: array - name: date_joined__lt in: query type: array - name: date_joined__lte in: query type: array - name: date_joined__n in: query type: array - name: email in: query type: array - name: email__empty in: query type: boolean - name: email__ic in: query type: array - name: email__ie in: query type: array - name: email__iew in: query type: array - name: email__iregex in: query type: array - name: email__isw in: query type: array - name: email__n in: query type: array - name: email__nic in: query type: array - name: email__nie in: query type: array - name: email__niew in: query type: array - name: email__nisw in: query type: array - name: email__regex in: query type: array - name: first_name in: query type: array - name: first_name__empty in: query type: boolean - name: first_name__ic in: query type: array - name: first_name__ie in: query type: array - name: first_name__iew in: query type: array - name: first_name__iregex in: query type: array - name: first_name__isw in: query type: array - name: first_name__n in: query type: array - name: first_name__nic in: query type: array - name: first_name__nie in: query type: array - name: first_name__niew in: query type: array - name: first_name__nisw in: query type: array - name: first_name__regex in: query type: array - name: group in: query type: array description: Group (name) - name: group__n in: query type: array description: Group (name) - name: group_id in: query type: array description: Group - name: group_id__n in: query type: array description: Group - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: is_active in: query type: boolean - name: is_superuser in: query type: boolean - name: last_login in: query type: array - name: last_login__empty in: query type: boolean - name: last_login__gt in: query type: array - name: last_login__gte in: query type: array - name: last_login__lt in: query type: array - name: last_login__lte in: query type: array - name: last_login__n in: query type: array - name: last_name in: query type: array - name: last_name__empty in: query type: boolean - name: last_name__ic in: query type: array - name: last_name__ie in: query type: array - name: last_name__iew in: query type: array - name: last_name__iregex in: query type: array - name: last_name__isw in: query type: array - name: last_name__n in: query type: array - name: last_name__nic in: query type: array - name: last_name__nie in: query type: array - name: last_name__niew in: query type: array - name: last_name__nisw in: query type: array - name: last_name__regex in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: notification_group_id in: query type: array description: Notification group (ID) - name: notification_group_id__n in: query type: array description: Notification group (ID) - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: permission_id in: query type: array description: Permission (ID) - name: permission_id__n in: query type: array description: Permission (ID) - name: q in: query type: string description: Search - name: username in: query type: array - name: username__empty in: query type: boolean - name: username__ic in: query type: array - name: username__ie in: query type: array - name: username__iew in: query type: array - name: username__iregex in: query type: array - name: username__isw in: query type: array - name: username__n in: query type: array - name: username__nic in: query type: array - name: username__nie in: query type: array - name: username__niew in: query type: array - name: username__nisw in: query type: array - name: username__regex in: query type: array - name: usersuserscreate method: POST description: Post a list of user objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: usersusersbulkupdate method: PUT description: Put a list of user objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: usersusersbulkpartialupdate method: PATCH description: Patch a list of user objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: usersusersbulkdestroy method: DELETE description: Delete a list of user objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-users-users-id path: /api/users/users/{id}/ operations: - name: usersusersretrieve method: GET description: Get a user object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this user. required: true - name: usersusersupdate method: PUT description: Put a user object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this user. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: usersuserspartialupdate method: PATCH description: Patch a user object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this user. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: usersusersdestroy method: DELETE description: Delete a user object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this user. required: true authentication: type: apikey key: sessionid value: '{{env.NETBOX_API_KEY}}' placement: cookie exposes: - type: rest namespace: netbox-users-rest port: 8080 description: REST adapter for NetBox REST API — users. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/api/users/config name: api-users-config description: REST surface for api-users-config. operations: - method: GET name: usersconfigretrieve description: An API endpoint via which a user can update his or her own UserConfig data (but no one else's). call: netbox-users.usersconfigretrieve outputParameters: - type: object mapping: $. - path: /v1/api/users/groups name: api-users-groups description: REST surface for api-users-groups. operations: - method: GET name: usersgroupslist description: Get a list of group objects. call: netbox-users.usersgroupslist with: description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n limit: rest.limit name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex notification_group_id: rest.notification_group_id notification_group_id__n: rest.notification_group_id__n offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n permission_id: rest.permission_id permission_id__n: rest.permission_id__n q: rest.q user_id: rest.user_id user_id__n: rest.user_id__n outputParameters: - type: object mapping: $. - method: POST name: usersgroupscreate description: Post a list of group objects. call: netbox-users.usersgroupscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: usersgroupsbulkupdate description: Put a list of group objects. call: netbox-users.usersgroupsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: usersgroupsbulkpartialupdate description: Patch a list of group objects. call: netbox-users.usersgroupsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: usersgroupsbulkdestroy description: Delete a list of group objects. call: netbox-users.usersgroupsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/users/groups/{id} name: api-users-groups-id description: REST surface for api-users-groups-id. operations: - method: GET name: usersgroupsretrieve description: Get a group object. call: netbox-users.usersgroupsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: usersgroupsupdate description: Put a group object. call: netbox-users.usersgroupsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: usersgroupspartialupdate description: Patch a group object. call: netbox-users.usersgroupspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: usersgroupsdestroy description: Delete a group object. call: netbox-users.usersgroupsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/users/owner-groups name: api-users-owner-groups description: REST surface for api-users-owner-groups. operations: - method: GET name: usersownergroupslist description: Get a list of owner group objects. call: netbox-users.usersownergroupslist with: description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n limit: rest.limit name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering q: rest.q outputParameters: - type: object mapping: $. - method: POST name: usersownergroupscreate description: Post a list of owner group objects. call: netbox-users.usersownergroupscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: usersownergroupsbulkupdate description: Put a list of owner group objects. call: netbox-users.usersownergroupsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: usersownergroupsbulkpartialupdate description: Patch a list of owner group objects. call: netbox-users.usersownergroupsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: usersownergroupsbulkdestroy description: Delete a list of owner group objects. call: netbox-users.usersownergroupsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/users/owner-groups/{id} name: api-users-owner-groups-id description: REST surface for api-users-owner-groups-id. operations: - method: GET name: usersownergroupsretrieve description: Get a owner group object. call: netbox-users.usersownergroupsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: usersownergroupsupdate description: Put a owner group object. call: netbox-users.usersownergroupsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: usersownergroupspartialupdate description: Patch a owner group object. call: netbox-users.usersownergroupspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: usersownergroupsdestroy description: Delete a owner group object. call: netbox-users.usersownergroupsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/users/owners name: api-users-owners description: REST surface for api-users-owners. operations: - method: GET name: usersownerslist description: Get a list of owner objects. call: netbox-users.usersownerslist with: description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex group: rest.group group__n: rest.group__n group_id: rest.group_id group_id__n: rest.group_id__n id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n limit: rest.limit name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering q: rest.q user: rest.user user__n: rest.user__n user_group: rest.user_group user_group__n: rest.user_group__n user_group_id: rest.user_group_id user_group_id__n: rest.user_group_id__n user_id: rest.user_id user_id__n: rest.user_id__n outputParameters: - type: object mapping: $. - method: POST name: usersownerscreate description: Post a list of owner objects. call: netbox-users.usersownerscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: usersownersbulkupdate description: Put a list of owner objects. call: netbox-users.usersownersbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: usersownersbulkpartialupdate description: Patch a list of owner objects. call: netbox-users.usersownersbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: usersownersbulkdestroy description: Delete a list of owner objects. call: netbox-users.usersownersbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/users/owners/{id} name: api-users-owners-id description: REST surface for api-users-owners-id. operations: - method: GET name: usersownersretrieve description: Get a owner object. call: netbox-users.usersownersretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: usersownersupdate description: Put a owner object. call: netbox-users.usersownersupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: usersownerspartialupdate description: Patch a owner object. call: netbox-users.usersownerspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: usersownersdestroy description: Delete a owner object. call: netbox-users.usersownersdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/users/permissions name: api-users-permissions description: REST surface for api-users-permissions. operations: - method: GET name: userspermissionslist description: Get a list of permission objects. call: netbox-users.userspermissionslist with: can_add: rest.can_add can_change: rest.can_change can_delete: rest.can_delete can_view: rest.can_view description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex enabled: rest.enabled group: rest.group group__n: rest.group__n group_id: rest.group_id group_id__n: rest.group_id__n id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n limit: rest.limit name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex object_type: rest.object_type object_type__ic: rest.object_type__ic object_type__ie: rest.object_type__ie object_type__iew: rest.object_type__iew object_type__iregex: rest.object_type__iregex object_type__isw: rest.object_type__isw object_type__n: rest.object_type__n object_type__nic: rest.object_type__nic object_type__nie: rest.object_type__nie object_type__niew: rest.object_type__niew object_type__nisw: rest.object_type__nisw object_type__regex: rest.object_type__regex object_type_id: rest.object_type_id object_type_id__n: rest.object_type_id__n object_types: rest.object_types object_types__n: rest.object_types__n offset: rest.offset ordering: rest.ordering q: rest.q user: rest.user user__n: rest.user__n user_id: rest.user_id user_id__n: rest.user_id__n outputParameters: - type: object mapping: $. - method: POST name: userspermissionscreate description: Post a list of permission objects. call: netbox-users.userspermissionscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: userspermissionsbulkupdate description: Put a list of permission objects. call: netbox-users.userspermissionsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: userspermissionsbulkpartialupdate description: Patch a list of permission objects. call: netbox-users.userspermissionsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: userspermissionsbulkdestroy description: Delete a list of permission objects. call: netbox-users.userspermissionsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/users/permissions/{id} name: api-users-permissions-id description: REST surface for api-users-permissions-id. operations: - method: GET name: userspermissionsretrieve description: Get a permission object. call: netbox-users.userspermissionsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: userspermissionsupdate description: Put a permission object. call: netbox-users.userspermissionsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: userspermissionspartialupdate description: Patch a permission object. call: netbox-users.userspermissionspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: userspermissionsdestroy description: Delete a permission object. call: netbox-users.userspermissionsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/users/tokens name: api-users-tokens description: REST surface for api-users-tokens. operations: - method: GET name: userstokenslist description: Get a list of token objects. call: netbox-users.userstokenslist with: created: rest.created created__gte: rest.created__gte created__lte: rest.created__lte description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex enabled: rest.enabled expires: rest.expires expires__gte: rest.expires__gte expires__lte: rest.expires__lte id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n key: rest.key key__empty: rest.key__empty key__ic: rest.key__ic key__ie: rest.key__ie key__iew: rest.key__iew key__iregex: rest.key__iregex key__isw: rest.key__isw key__n: rest.key__n key__nic: rest.key__nic key__nie: rest.key__nie key__niew: rest.key__niew key__nisw: rest.key__nisw key__regex: rest.key__regex last_used: rest.last_used last_used__gte: rest.last_used__gte last_used__lte: rest.last_used__lte limit: rest.limit offset: rest.offset ordering: rest.ordering pepper_id: rest.pepper_id pepper_id__empty: rest.pepper_id__empty pepper_id__gt: rest.pepper_id__gt pepper_id__gte: rest.pepper_id__gte pepper_id__lt: rest.pepper_id__lt pepper_id__lte: rest.pepper_id__lte pepper_id__n: rest.pepper_id__n q: rest.q user: rest.user user__n: rest.user__n user_id: rest.user_id user_id__n: rest.user_id__n version: rest.version version__ic: rest.version__ic version__ie: rest.version__ie version__iew: rest.version__iew version__iregex: rest.version__iregex version__isw: rest.version__isw version__n: rest.version__n version__nic: rest.version__nic version__nie: rest.version__nie version__niew: rest.version__niew version__nisw: rest.version__nisw version__regex: rest.version__regex write_enabled: rest.write_enabled outputParameters: - type: object mapping: $. - method: POST name: userstokenscreate description: Post a list of token objects. call: netbox-users.userstokenscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: userstokensbulkupdate description: Put a list of token objects. call: netbox-users.userstokensbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: userstokensbulkpartialupdate description: Patch a list of token objects. call: netbox-users.userstokensbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: userstokensbulkdestroy description: Delete a list of token objects. call: netbox-users.userstokensbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/users/tokens/provision name: api-users-tokens-provision description: REST surface for api-users-tokens-provision. operations: - method: POST name: userstokensprovisioncreate description: Non-authenticated REST API endpoint via which a user may create a Token. call: netbox-users.userstokensprovisioncreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/users/tokens/{id} name: api-users-tokens-id description: REST surface for api-users-tokens-id. operations: - method: GET name: userstokensretrieve description: Get a token object. call: netbox-users.userstokensretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: userstokensupdate description: Put a token object. call: netbox-users.userstokensupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: userstokenspartialupdate description: Patch a token object. call: netbox-users.userstokenspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: userstokensdestroy description: Delete a token object. call: netbox-users.userstokensdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/users/users name: api-users-users description: REST surface for api-users-users. operations: - method: GET name: usersuserslist description: Get a list of user objects. call: netbox-users.usersuserslist with: date_joined: rest.date_joined date_joined__empty: rest.date_joined__empty date_joined__gt: rest.date_joined__gt date_joined__gte: rest.date_joined__gte date_joined__lt: rest.date_joined__lt date_joined__lte: rest.date_joined__lte date_joined__n: rest.date_joined__n email: rest.email email__empty: rest.email__empty email__ic: rest.email__ic email__ie: rest.email__ie email__iew: rest.email__iew email__iregex: rest.email__iregex email__isw: rest.email__isw email__n: rest.email__n email__nic: rest.email__nic email__nie: rest.email__nie email__niew: rest.email__niew email__nisw: rest.email__nisw email__regex: rest.email__regex first_name: rest.first_name first_name__empty: rest.first_name__empty first_name__ic: rest.first_name__ic first_name__ie: rest.first_name__ie first_name__iew: rest.first_name__iew first_name__iregex: rest.first_name__iregex first_name__isw: rest.first_name__isw first_name__n: rest.first_name__n first_name__nic: rest.first_name__nic first_name__nie: rest.first_name__nie first_name__niew: rest.first_name__niew first_name__nisw: rest.first_name__nisw first_name__regex: rest.first_name__regex group: rest.group group__n: rest.group__n group_id: rest.group_id group_id__n: rest.group_id__n id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n is_active: rest.is_active is_superuser: rest.is_superuser last_login: rest.last_login last_login__empty: rest.last_login__empty last_login__gt: rest.last_login__gt last_login__gte: rest.last_login__gte last_login__lt: rest.last_login__lt last_login__lte: rest.last_login__lte last_login__n: rest.last_login__n last_name: rest.last_name last_name__empty: rest.last_name__empty last_name__ic: rest.last_name__ic last_name__ie: rest.last_name__ie last_name__iew: rest.last_name__iew last_name__iregex: rest.last_name__iregex last_name__isw: rest.last_name__isw last_name__n: rest.last_name__n last_name__nic: rest.last_name__nic last_name__nie: rest.last_name__nie last_name__niew: rest.last_name__niew last_name__nisw: rest.last_name__nisw last_name__regex: rest.last_name__regex limit: rest.limit notification_group_id: rest.notification_group_id notification_group_id__n: rest.notification_group_id__n offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n permission_id: rest.permission_id permission_id__n: rest.permission_id__n q: rest.q username: rest.username username__empty: rest.username__empty username__ic: rest.username__ic username__ie: rest.username__ie username__iew: rest.username__iew username__iregex: rest.username__iregex username__isw: rest.username__isw username__n: rest.username__n username__nic: rest.username__nic username__nie: rest.username__nie username__niew: rest.username__niew username__nisw: rest.username__nisw username__regex: rest.username__regex outputParameters: - type: object mapping: $. - method: POST name: usersuserscreate description: Post a list of user objects. call: netbox-users.usersuserscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: usersusersbulkupdate description: Put a list of user objects. call: netbox-users.usersusersbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: usersusersbulkpartialupdate description: Patch a list of user objects. call: netbox-users.usersusersbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: usersusersbulkdestroy description: Delete a list of user objects. call: netbox-users.usersusersbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/users/users/{id} name: api-users-users-id description: REST surface for api-users-users-id. operations: - method: GET name: usersusersretrieve description: Get a user object. call: netbox-users.usersusersretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: usersusersupdate description: Put a user object. call: netbox-users.usersusersupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: usersuserspartialupdate description: Patch a user object. call: netbox-users.usersuserspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: usersusersdestroy description: Delete a user object. call: netbox-users.usersusersdestroy with: id: rest.id outputParameters: - type: object mapping: $. - type: mcp namespace: netbox-users-mcp port: 9090 transport: http description: MCP adapter for NetBox REST API — users. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: api-endpoint-which-user-can description: An API endpoint via which a user can update his or her own UserConfig data (but no one else's). hints: readOnly: true destructive: false idempotent: true call: netbox-users.usersconfigretrieve outputParameters: - type: object mapping: $. - name: get-list-group-objects description: Get a list of group objects. hints: readOnly: true destructive: false idempotent: true call: netbox-users.usersgroupslist with: description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n limit: tools.limit name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex notification_group_id: tools.notification_group_id notification_group_id__n: tools.notification_group_id__n offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n permission_id: tools.permission_id permission_id__n: tools.permission_id__n q: tools.q user_id: tools.user_id user_id__n: tools.user_id__n outputParameters: - type: object mapping: $. - name: post-list-group-objects description: Post a list of group objects. hints: readOnly: true destructive: false idempotent: false call: netbox-users.usersgroupscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-group-objects description: Put a list of group objects. hints: readOnly: false destructive: false idempotent: true call: netbox-users.usersgroupsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-group-objects description: Patch a list of group objects. hints: readOnly: false destructive: false idempotent: true call: netbox-users.usersgroupsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-group-objects description: Delete a list of group objects. hints: readOnly: false destructive: true idempotent: true call: netbox-users.usersgroupsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-group-object description: Get a group object. hints: readOnly: true destructive: false idempotent: true call: netbox-users.usersgroupsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-group-object description: Put a group object. hints: readOnly: false destructive: false idempotent: true call: netbox-users.usersgroupsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-group-object description: Patch a group object. hints: readOnly: false destructive: false idempotent: true call: netbox-users.usersgroupspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-group-object description: Delete a group object. hints: readOnly: false destructive: true idempotent: true call: netbox-users.usersgroupsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-owner-group-objects description: Get a list of owner group objects. hints: readOnly: true destructive: false idempotent: true call: netbox-users.usersownergroupslist with: description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n limit: tools.limit name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering q: tools.q outputParameters: - type: object mapping: $. - name: post-list-owner-group-objects description: Post a list of owner group objects. hints: readOnly: true destructive: false idempotent: false call: netbox-users.usersownergroupscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-owner-group-objects description: Put a list of owner group objects. hints: readOnly: false destructive: false idempotent: true call: netbox-users.usersownergroupsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-owner-group-objects description: Patch a list of owner group objects. hints: readOnly: false destructive: false idempotent: true call: netbox-users.usersownergroupsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-owner-group-objects description: Delete a list of owner group objects. hints: readOnly: false destructive: true idempotent: true call: netbox-users.usersownergroupsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-owner-group-object description: Get a owner group object. hints: readOnly: true destructive: false idempotent: true call: netbox-users.usersownergroupsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-owner-group-object description: Put a owner group object. hints: readOnly: false destructive: false idempotent: true call: netbox-users.usersownergroupsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-owner-group-object description: Patch a owner group object. hints: readOnly: false destructive: false idempotent: true call: netbox-users.usersownergroupspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-owner-group-object description: Delete a owner group object. hints: readOnly: false destructive: true idempotent: true call: netbox-users.usersownergroupsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-owner-objects description: Get a list of owner objects. hints: readOnly: true destructive: false idempotent: true call: netbox-users.usersownerslist with: description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex group: tools.group group__n: tools.group__n group_id: tools.group_id group_id__n: tools.group_id__n id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n limit: tools.limit name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering q: tools.q user: tools.user user__n: tools.user__n user_group: tools.user_group user_group__n: tools.user_group__n user_group_id: tools.user_group_id user_group_id__n: tools.user_group_id__n user_id: tools.user_id user_id__n: tools.user_id__n outputParameters: - type: object mapping: $. - name: post-list-owner-objects description: Post a list of owner objects. hints: readOnly: true destructive: false idempotent: false call: netbox-users.usersownerscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-owner-objects description: Put a list of owner objects. hints: readOnly: false destructive: false idempotent: true call: netbox-users.usersownersbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-owner-objects description: Patch a list of owner objects. hints: readOnly: false destructive: false idempotent: true call: netbox-users.usersownersbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-owner-objects description: Delete a list of owner objects. hints: readOnly: false destructive: true idempotent: true call: netbox-users.usersownersbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-owner-object description: Get a owner object. hints: readOnly: true destructive: false idempotent: true call: netbox-users.usersownersretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-owner-object description: Put a owner object. hints: readOnly: false destructive: false idempotent: true call: netbox-users.usersownersupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-owner-object description: Patch a owner object. hints: readOnly: false destructive: false idempotent: true call: netbox-users.usersownerspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-owner-object description: Delete a owner object. hints: readOnly: false destructive: true idempotent: true call: netbox-users.usersownersdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-permission-objects description: Get a list of permission objects. hints: readOnly: true destructive: false idempotent: true call: netbox-users.userspermissionslist with: can_add: tools.can_add can_change: tools.can_change can_delete: tools.can_delete can_view: tools.can_view description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex enabled: tools.enabled group: tools.group group__n: tools.group__n group_id: tools.group_id group_id__n: tools.group_id__n id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n limit: tools.limit name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex object_type: tools.object_type object_type__ic: tools.object_type__ic object_type__ie: tools.object_type__ie object_type__iew: tools.object_type__iew object_type__iregex: tools.object_type__iregex object_type__isw: tools.object_type__isw object_type__n: tools.object_type__n object_type__nic: tools.object_type__nic object_type__nie: tools.object_type__nie object_type__niew: tools.object_type__niew object_type__nisw: tools.object_type__nisw object_type__regex: tools.object_type__regex object_type_id: tools.object_type_id object_type_id__n: tools.object_type_id__n object_types: tools.object_types object_types__n: tools.object_types__n offset: tools.offset ordering: tools.ordering q: tools.q user: tools.user user__n: tools.user__n user_id: tools.user_id user_id__n: tools.user_id__n outputParameters: - type: object mapping: $. - name: post-list-permission-objects description: Post a list of permission objects. hints: readOnly: true destructive: false idempotent: false call: netbox-users.userspermissionscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-permission-objects description: Put a list of permission objects. hints: readOnly: false destructive: false idempotent: true call: netbox-users.userspermissionsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-permission-objects description: Patch a list of permission objects. hints: readOnly: false destructive: false idempotent: true call: netbox-users.userspermissionsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-permission-objects description: Delete a list of permission objects. hints: readOnly: false destructive: true idempotent: true call: netbox-users.userspermissionsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-permission-object description: Get a permission object. hints: readOnly: true destructive: false idempotent: true call: netbox-users.userspermissionsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-permission-object description: Put a permission object. hints: readOnly: false destructive: false idempotent: true call: netbox-users.userspermissionsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-permission-object description: Patch a permission object. hints: readOnly: false destructive: false idempotent: true call: netbox-users.userspermissionspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-permission-object description: Delete a permission object. hints: readOnly: false destructive: true idempotent: true call: netbox-users.userspermissionsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-token-objects description: Get a list of token objects. hints: readOnly: true destructive: false idempotent: true call: netbox-users.userstokenslist with: created: tools.created created__gte: tools.created__gte created__lte: tools.created__lte description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex enabled: tools.enabled expires: tools.expires expires__gte: tools.expires__gte expires__lte: tools.expires__lte id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n key: tools.key key__empty: tools.key__empty key__ic: tools.key__ic key__ie: tools.key__ie key__iew: tools.key__iew key__iregex: tools.key__iregex key__isw: tools.key__isw key__n: tools.key__n key__nic: tools.key__nic key__nie: tools.key__nie key__niew: tools.key__niew key__nisw: tools.key__nisw key__regex: tools.key__regex last_used: tools.last_used last_used__gte: tools.last_used__gte last_used__lte: tools.last_used__lte limit: tools.limit offset: tools.offset ordering: tools.ordering pepper_id: tools.pepper_id pepper_id__empty: tools.pepper_id__empty pepper_id__gt: tools.pepper_id__gt pepper_id__gte: tools.pepper_id__gte pepper_id__lt: tools.pepper_id__lt pepper_id__lte: tools.pepper_id__lte pepper_id__n: tools.pepper_id__n q: tools.q user: tools.user user__n: tools.user__n user_id: tools.user_id user_id__n: tools.user_id__n version: tools.version version__ic: tools.version__ic version__ie: tools.version__ie version__iew: tools.version__iew version__iregex: tools.version__iregex version__isw: tools.version__isw version__n: tools.version__n version__nic: tools.version__nic version__nie: tools.version__nie version__niew: tools.version__niew version__nisw: tools.version__nisw version__regex: tools.version__regex write_enabled: tools.write_enabled outputParameters: - type: object mapping: $. - name: post-list-token-objects description: Post a list of token objects. hints: readOnly: true destructive: false idempotent: false call: netbox-users.userstokenscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-token-objects description: Put a list of token objects. hints: readOnly: false destructive: false idempotent: true call: netbox-users.userstokensbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-token-objects description: Patch a list of token objects. hints: readOnly: false destructive: false idempotent: true call: netbox-users.userstokensbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-token-objects description: Delete a list of token objects. hints: readOnly: false destructive: true idempotent: true call: netbox-users.userstokensbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: non-authenticated-rest-api-endpoint description: Non-authenticated REST API endpoint via which a user may create a Token. hints: readOnly: false destructive: false idempotent: false call: netbox-users.userstokensprovisioncreate with: body: tools.body outputParameters: - type: object mapping: $. - name: get-token-object description: Get a token object. hints: readOnly: true destructive: false idempotent: true call: netbox-users.userstokensretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-token-object description: Put a token object. hints: readOnly: false destructive: false idempotent: true call: netbox-users.userstokensupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-token-object description: Patch a token object. hints: readOnly: false destructive: false idempotent: true call: netbox-users.userstokenspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-token-object description: Delete a token object. hints: readOnly: false destructive: true idempotent: true call: netbox-users.userstokensdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-user-objects description: Get a list of user objects. hints: readOnly: true destructive: false idempotent: true call: netbox-users.usersuserslist with: date_joined: tools.date_joined date_joined__empty: tools.date_joined__empty date_joined__gt: tools.date_joined__gt date_joined__gte: tools.date_joined__gte date_joined__lt: tools.date_joined__lt date_joined__lte: tools.date_joined__lte date_joined__n: tools.date_joined__n email: tools.email email__empty: tools.email__empty email__ic: tools.email__ic email__ie: tools.email__ie email__iew: tools.email__iew email__iregex: tools.email__iregex email__isw: tools.email__isw email__n: tools.email__n email__nic: tools.email__nic email__nie: tools.email__nie email__niew: tools.email__niew email__nisw: tools.email__nisw email__regex: tools.email__regex first_name: tools.first_name first_name__empty: tools.first_name__empty first_name__ic: tools.first_name__ic first_name__ie: tools.first_name__ie first_name__iew: tools.first_name__iew first_name__iregex: tools.first_name__iregex first_name__isw: tools.first_name__isw first_name__n: tools.first_name__n first_name__nic: tools.first_name__nic first_name__nie: tools.first_name__nie first_name__niew: tools.first_name__niew first_name__nisw: tools.first_name__nisw first_name__regex: tools.first_name__regex group: tools.group group__n: tools.group__n group_id: tools.group_id group_id__n: tools.group_id__n id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n is_active: tools.is_active is_superuser: tools.is_superuser last_login: tools.last_login last_login__empty: tools.last_login__empty last_login__gt: tools.last_login__gt last_login__gte: tools.last_login__gte last_login__lt: tools.last_login__lt last_login__lte: tools.last_login__lte last_login__n: tools.last_login__n last_name: tools.last_name last_name__empty: tools.last_name__empty last_name__ic: tools.last_name__ic last_name__ie: tools.last_name__ie last_name__iew: tools.last_name__iew last_name__iregex: tools.last_name__iregex last_name__isw: tools.last_name__isw last_name__n: tools.last_name__n last_name__nic: tools.last_name__nic last_name__nie: tools.last_name__nie last_name__niew: tools.last_name__niew last_name__nisw: tools.last_name__nisw last_name__regex: tools.last_name__regex limit: tools.limit notification_group_id: tools.notification_group_id notification_group_id__n: tools.notification_group_id__n offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n permission_id: tools.permission_id permission_id__n: tools.permission_id__n q: tools.q username: tools.username username__empty: tools.username__empty username__ic: tools.username__ic username__ie: tools.username__ie username__iew: tools.username__iew username__iregex: tools.username__iregex username__isw: tools.username__isw username__n: tools.username__n username__nic: tools.username__nic username__nie: tools.username__nie username__niew: tools.username__niew username__nisw: tools.username__nisw username__regex: tools.username__regex outputParameters: - type: object mapping: $. - name: post-list-user-objects description: Post a list of user objects. hints: readOnly: true destructive: false idempotent: false call: netbox-users.usersuserscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-user-objects description: Put a list of user objects. hints: readOnly: false destructive: false idempotent: true call: netbox-users.usersusersbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-user-objects description: Patch a list of user objects. hints: readOnly: false destructive: false idempotent: true call: netbox-users.usersusersbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-user-objects description: Delete a list of user objects. hints: readOnly: false destructive: true idempotent: true call: netbox-users.usersusersbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-user-object description: Get a user object. hints: readOnly: true destructive: false idempotent: true call: netbox-users.usersusersretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-user-object description: Put a user object. hints: readOnly: false destructive: false idempotent: true call: netbox-users.usersusersupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-user-object description: Patch a user object. hints: readOnly: false destructive: false idempotent: true call: netbox-users.usersuserspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-user-object description: Delete a user object. hints: readOnly: false destructive: true idempotent: true call: netbox-users.usersusersdestroy with: id: tools.id outputParameters: - type: object mapping: $.