Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Nudge Security Accounts User Groups API
description: The Nudge Security REST API enables programmatic access to retrieve data about apps, accounts, OAuth grants, security events, fields, users, user groups, labels, notifications, findings, playbooks, app-to-app integrations, app instances, AI sessions and prompts, and the browser extension. It supports integration with SIEM, SOAR, and ticketing systems and allows management of custom fields and classifications. The API is rate limited to 1200 requests per 5-minute period. API tokens auto-expire after 4 weeks of no use.
version: '1.0'
contact:
name: Nudge Security
url: https://help.nudgesecurity.com/
servers:
- url: https://api.nudgesecurity.io/api/1.0
description: Production
security:
- bearerAuth: []
tags:
- name: User Groups
description: Search and retrieve user groups and their members.
paths:
/user-groups:
get:
tags:
- User Groups
summary: Search user groups
parameters:
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/Search'
responses:
'200':
description: A paginated list of user groups.
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedList'
/user-groups/{group_id}/members:
get:
tags:
- User Groups
summary: List user group members
parameters:
- name: group_id
in: path
required: true
schema:
type: string
responses:
'200':
description: Members of the group.
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedList'
components:
parameters:
Page:
name: page
in: query
required: false
schema:
type: integer
minimum: 1
default: 1
Search:
name: search
in: query
required: false
schema:
type: string
PerPage:
name: per_page
in: query
required: false
schema:
type: integer
minimum: 1
maximum: 200
default: 50
schemas:
PaginatedList:
type: object
properties:
data:
type: array
items:
type: object
page:
type: integer
per_page:
type: integer
total:
type: integer
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: API Token
externalDocs:
description: Nudge Security API Reference
url: https://nudgesecurity.readme.io/reference