JumpCloud Scope Groups API
The Scope Groups API from JumpCloud — 1 operation(s) for scope groups.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/jumpcloud:jumpcloud-scope-groups-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
contact:
name: JumpCloud Support
url: https://jumpcloud.com/support/contact-jumpcloud-support
description: '# Overview
JumpCloud''s V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. > **Note:** See JumpCloud Data Centers: Login URLs and Service Endpoints to learn more. ## API Best Practices
Read the linked Help Article below for guidance on retrying failed requests to JumpCloud''s REST API, as well as best practices for structuring subsequent retry requests. Customizing retry mechanisms based on these recommendations will increase the reliability and dependability of your API calls. Covered topics include:
1. Important Considerations
2. Supported HTTP Request Methods
3. Response codes
4. API Key rotation
5. Paginating
6. Error handling
7. Retry rates
JumpCloud Help Center - API Best Practices
# Directory Objects
This API offers the ability to interact with some of our core features; otherwise known as Directory Objects. The Directory Objects are:
* Commands
* Policies
* Policy Groups
* Applications
* Systems
* Users
* User Groups
* System Groups
* Radius Servers
* Directories: Office 365, LDAP,G-Suite, Active Directory
* Duo accounts and applications. The Directory Object is an important concept to understand in order to successfully use JumpCloud API. ## JumpCloud Graph
We''ve also introduced the concept of the JumpCloud Graph along with Directory Objects. The Graph is a powerful aspect of our platform which will enable you to associate objects with each other, or establish membership for certain objects to become members of other objects. Specific `GET` endpoints will allow you to traverse the JumpCloud Graph to return all indirect and directly bound objects in your organization. | !alt text |
|:--:|
| **This diagram highlights our association and membership model as it relates to Directory Objects.** |
# API Key
## Access Your API Key
To locate your API Key:
1. Log into the JumpCloud Admin Console. 2. Go to the username drop down located in the top-right of the Console. 3. Retrieve your API key from API Settings. ## API Key Considerations
This API key is associated to the currently logged in administrator. Other admins will have different API keys. **WARNING** Please keep this API key secret, as it grants full access to any data accessible via your JumpCloud console account. You can also reset your API key in the same location in the JumpCloud Admin Console. ## Recycling or Resetting Your API Key
In order to revoke access with the current API key, simply reset your API key. This will render all calls using the previous API key inaccessible. Your API key will be passed in as a header with the header name "x-api-key". ```bash
curl -H "x-api-key: [YOUR_API_KEY_HERE]" "https://console.jumpcloud.com/api/v2/systemgroups"
```
# System Context
* Introduction
* Supported endpoints
* Response codes
* Authentication
* Additional examples
* Third party
## Introduction
JumpCloud System Context Authorization is an alternative way to authenticate with a subset of JumpCloud''s REST APIs. Using this method, a system can manage its information and resource associations, allowing modern auto provisioning environments to scale as needed. **Notes:**
* The following documentation applies to Linux Operating Systems only. * Systems that have been automatically enrolled using Apple''s Device Enrollment Program (DEP) or systems enrolled using the User Portal install are not eligible to use the System Context API to prevent unauthorized access to system groups and resources. If a script that utilizes the System Context API is invoked on a system enrolled in this way, it will display an error. ## Supported Endpoints
JumpCloud System Context Authorization can be used in conjunction with Systems endpoints found in the V1 API and certain System Group endpoints found in the v2 API.'
title: JumpCloud Scope Groups API
version: '2.0'
servers:
- url: https://console.jumpcloud.com/api/v2
description: United States (US)
x-jc-region: us
- url: https://console.eu.jumpcloud.com/api/v2
description: European Union (EU)
x-jc-region: eu
- url: https://console.in.jumpcloud.com/api/v2
description: India (IN)
x-jc-region: in
tags:
- name: Scope Groups
paths:
/scope-groups:
get:
summary: List Scope Groups
tags:
- Scope Groups
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
totalCount:
type: integer
description: Total count of scope groups matching the filter criteria
results:
type: array
items:
$ref: '#/components/schemas/ScopeGroup'
required:
- totalCount
- results
'400':
$ref: '#/components/responses/trait_standardErrors_400'
'401':
$ref: '#/components/responses/trait_standardErrors_401'
'403':
$ref: '#/components/responses/trait_standardErrors_403'
'404':
$ref: '#/components/responses/trait_standardErrors_404'
'500':
$ref: '#/components/responses/trait_standardErrors_500'
operationId: scopegroups_list
parameters:
- $ref: '#/components/parameters/trait_listCount_x-total-count'
- $ref: '#/components/parameters/trait_limit_limit'
- $ref: '#/components/parameters/trait_skip_skip'
- $ref: '#/components/parameters/trait_filter_filter'
- $ref: '#/components/parameters/trait_sort_sort'
- $ref: '#/components/parameters/trait_multiTenantRequestHeaders_x-org-id'
- $ref: '#/components/parameters/trait_multiTenantRequestHeaders_x-provider-id'
description: 'Retrieve scope groups for custom role creation.
Scope groups are global catalog resources.
Catalog visibility may depend on authenticated organization/provider context.
Direct/OU context can influence contextual catalog visibility.
Route availability is context-dependent: MSP provider-authoring requests
(authenticated MSP provider without organization context) require
SP-10009-custom-role-mtp. Organization contexts are always available.
When MSP Custom Roles is enabled, authenticated MSP provider context may
request the provider-authoring catalog without x-org-id.
By default, returns scope groups with displayToUsers: true. Supports
JumpCloud standard pagination, sorting, and basic filtering.
**Response Format**: Returns an object with `totalCount` and `results` array.
The total count is also provided in the `X-Total-Count` response header.
#### Core Features
- **Global Resource**: Same scope groups available to all organizations
- **Pagination**: Standard `limit` and `skip` parameters
- **Sorting**: Default sort by `groupName` (ascending), user-configurable
- **Filtering**: `displayToUsers:eq:true|false` (defaults to true)
#### Sample Requests
```
# Default - displayToUsers: true, sorted by groupName
curl https://console.jumpcloud.com/api/v2/scope-groups \
-H ''accept: application/json'' \
-H ''x-api-key: {API_KEY}''
# With pagination
curl ''https://console.jumpcloud.com/api/v2/scope-groups?limit=10&skip=20'' \
-H ''x-api-key: {API_KEY}''
# Custom sorting
curl ''https://console.jumpcloud.com/api/v2/scope-groups?sort[0][field]=groupName&sort[0][descending]=true'' \
-H ''x-api-key: {API_KEY}''
# Get internal scope groups (admin use)
curl ''https://console.jumpcloud.com/api/v2/scope-groups?filter=displayToUsers:eq:false'' \
-H ''x-api-key: {API_KEY}''
```'
security:
- x-api-key: []
x-scopes:
- roles
- roles.readonly
x-codeSamples:
- lang: Shell
source: "curl --request GET \\\n --url 'https://console.jumpcloud.com/api/v2/scope-groups?limit=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&filter=SOME_ARRAY_VALUE&sort=SOME_ARRAY_VALUE' \\\n --header 'x-api-key: REPLACE_KEY_VALUE' \\\n --header 'x-org-id: SOME_STRING_VALUE' \\\n --header 'x-provider-id: SOME_STRING_VALUE' \\\n --header 'x-total-count: SOME_INTEGER_VALUE'"
- lang: Python
source: "import requests\n\nurl = \"https://console.jumpcloud.com/api/v2/scope-groups\"\n\nquerystring = {\"limit\":\"SOME_INTEGER_VALUE\",\"skip\":\"SOME_INTEGER_VALUE\",\"filter\":\"SOME_ARRAY_VALUE\",\"sort\":\"SOME_ARRAY_VALUE\"}\n\nheaders = {\n \"x-total-count\": \"SOME_INTEGER_VALUE\",\n \"x-org-id\": \"SOME_STRING_VALUE\",\n \"x-provider-id\": \"SOME_STRING_VALUE\",\n \"x-api-key\": \"REPLACE_KEY_VALUE\"\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, params=querystring)\n\nprint(response.text)"
- lang: Powershell
source: '$headers=@{}
$headers.Add("x-total-count", "SOME_INTEGER_VALUE")
$headers.Add("x-org-id", "SOME_STRING_VALUE")
$headers.Add("x-provider-id", "SOME_STRING_VALUE")
$headers.Add("x-api-key", "REPLACE_KEY_VALUE")
$response = Invoke-RestMethod -Uri ''https://console.jumpcloud.com/api/v2/scope-groups?limit=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&filter=SOME_ARRAY_VALUE&sort=SOME_ARRAY_VALUE'' -Method GET -Headers $headers'
components:
responses:
trait_standardErrors_404:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
trait_standardErrors_401:
description: Unauthenticated
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
trait_standardErrors_400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
trait_standardErrors_500:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
trait_standardErrors_403:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
parameters:
trait_skip_skip:
description: The offset into the records to return.
in: query
name: skip
required: false
schema:
type: integer
minimum: 0
default: 0
trait_listCount_x-total-count:
in: header
name: x-total-count
schema:
type: integer
trait_sort_sort:
description: 'The comma separated fields used to sort the collection.
Default sort is ascending, prefix with `-` to sort descending.
'
in: query
name: sort
style: form
explode: false
schema:
type: array
items:
type: string
default: []
trait_multiTenantRequestHeaders_x-org-id:
description: Organization identifier that can be obtained from console settings.
in: header
name: x-org-id
schema:
type: string
trait_filter_filter:
description: 'A filter to apply to the query.
**Filter structure**: `<field>:<operator>:<value>`.
**field** = Populate with a valid field from an endpoint response.
**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in.
_Note: v1 operators differ from v2 operators._
**value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards.
**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group`'
in: query
name: filter
style: form
explode: false
schema:
type: array
items:
type: string
default: []
trait_multiTenantRequestHeaders_x-provider-id:
description: Multi-tenant Provider identifier that can be obtained from console settings.
in: header
name: x-provider-id
required: false
schema:
type: string
trait_limit_limit:
description: The number of records to return at once. Limited to 100.
in: query
name: limit
schema:
type: integer
default: 10
schemas:
Scope:
type: object
properties:
key:
type: string
description: Unique key for the scope
label:
type: string
description: Human-readable label for the scope
subgroupLabel:
type: string
description: A common label for a group of related scopes.
displayToUsers:
type: boolean
description: Whether this scope should be displayed to users
description:
type: string
description: Description of what this scope controls
permissionType:
type: string
description: The type of permission structure for UI rendering.
enum:
- granular
- access_level
- actions
allowsNoAccess:
type: boolean
description: Whether No Access option available for the scope. It would be applicable when permission_type:access_level
permissions:
type: array
description: Available permission levels for this scope
items:
type: object
properties:
key:
type: string
description: Permission level key (e.g. fullAccess, view, create, update, delete, allow)
values:
type: array
items:
type: string
description: Scope strings granted at this permission level
examples:
- key: systems
label: Systems
displayToUsers: true
description: Manage system resources and configurations
permissionType: access_level
permissions:
- key: fullAccess
values:
- systems
- key: view
values:
- systems.readonly
Error:
title: Error
type: object
x-examples: {}
description: ''
properties:
code:
format: int32
type: integer
description: HTTP status code
message:
type: string
description: Error message
status:
type: string
description: HTTP status description
ErrorDetails:
allOf:
- $ref: '#/components/schemas/Error'
- type: object
properties:
details:
description: 'Describes a list of objects with more detailed information of the given error. Each detail schema is according to one of the messages defined in Google''s API: https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto'
type: array
items:
type: object
additionalProperties: true
description: Object according to Google's API.
ScopeGroup:
type: object
properties:
id:
type: string
description: Unique identifier for the scope group
groupName:
type: string
description: Name of the scope group
groupKey:
type: string
description: A unique, URL-friendly key for the scope group.
fullAccessScopes:
type: array
items:
type: string
description: List of scopes that grant full access to the group.
displayToUsers:
type: boolean
description: Whether this scope group should be displayed to users
groupDescription:
type: string
description: Description of the scope group's purpose
scopes:
type: array
items:
$ref: '#/components/schemas/Scope'
description: List of scopes within this group
createdAt:
type: string
format: date-time
description: When the scope group was created
updatedAt:
type: string
format: date-time
description: When the scope group was last updated
examples:
- id: 507f1f77bcf86cd799439011
groupName: User Management
groupKey: user-management
displayToUsers: true
groupDescription: Manage users
scopes:
- key: users.unlock
label: Unlock user accounts
subgroupLabel: User Support
displayToUsers: true
description: Unlock user accounts.
permissionType: actions
permissions:
- key: allow
values:
- users.unlock
createdAt: 2023-07-23 12:00:00
updatedAt: 2023-07-23 12:00:00
securitySchemes:
x-api-key:
description: API key used to authenticate requests.
in: header
name: x-api-key
type: apiKey
x-tagGroups:
- name: API Reference
tags:
- Access Requests
- Access Risk Settings
- Active Directory
- Administrators
- Agent Groups
- Agents
- Aggregated Policy Stats
- App Catalog
- Apple MDM
- Applications
- Assets
- Authentication Policies
- Bulk Job Requests
- Commands
- Custom Emails
- Directories
- Directory Insights
- Duo
- Email Subscriptions
- FeatureTrials
- G Suite
- G Suite Import
- GCEP
- Google EMM
- Graph
- Groups
- IP Lists
- Identity Providers
- Identity Risk
- Image
- LDAP Servers
- Logos
- Managed Service Provider
- Microsoft MDM
- Monitoring and Alerting
- Notifications Channels
- Object Storage
- Office 365
- Office 365 Import
- Organization Feature Settings
- Organizations
- Password Manager
- Password Policy
- Password Vault
- PasswordManagerItem
- Policies
- Policy Group Associations
- Policy Group Members & Membership
- Policy Group Templates
- Policy Groups
- Policytemplates
- Privileged Access
- Providers
- Push Verification
- RADIUS Servers
- Reports
- Roles
- Rules
- SCIM Import
- SaaS App Management
- Samba Domains
- Sample Data
- Saved Views
- Scope Groups
- Service Accounts
- Slack Notifications
- Software Apps
- Subscriptions
- System Group Associations
- System Group Members & Membership
- System Groups
- System Insights
- Systems
- Systems Organization Settings
- Translation Rules
- User Group Associations
- User Group Members & Membership
- User Groups
- Users
- Webhook Notifications
- Webhook Notifications Channels
- Workday Import
- Workflows
- fde
- mdm
x-scopes:
- accessmanagement
- accessmanagement.readonly
- accessrequest
- accessrequest.readonly
- administratorLinks
- administrators
- administrators.readonly
- agents
- agents.create
- agents.credentials.delete
- agents.credentials.readonly
- agents.credentials.update
- agents.delete
- agents.readonly
- agents.state
- agents.state.activate
- agents.state.suspend
- agents.update
- anonymous
- applications
- applications.readonly
- applications.update
- assets
- assets.readonly
- associations
- associations.applications
- associations.applications.readonly
- associations.authn
- associations.authn.readonly
- associations.commands
- associations.commands.readonly
- associations.directories
- associations.directories.readonly
- associations.groups
- associations.groups.readonly
- associations.radius
- associations.radius.readonly
- associations.readonly
- associations.self
- associations.systems
- associations.systems.readonly
- associations.users
- associations.users.readonly
- authn
- authn.readonly
- billing
- commandrunner.legacy
- commands
- commands.readonly
- directories
- directories.readonly
- directoryinsights.readonly
- groups
- groups.readonly
- groups.self
- healthmonitoring.alerts
- healthmonitoring.alerts.readonly
- healthmonitoring.rules
- healthmonitoring.rules.readonly
- identityrisk
- identityrisk.readonly
- mdm
- mdm.readonly
- mfa
- mfa.readonly
- notifications.channels
- notifications.channels.readonly
- notifications.subscriptions
- notifications.subscriptions.readonly
- organizations
- organizations.billing
- organizations.readonly
- pam
- pam.backup
- pam.blocking-rules.create
- pam.blocking-rules.delete
- pam.blocking-rules.readonly
- pam.blocking-rules.update
- pam.jump-servers.create
- pam.jump-servers.delete
- pam.jump-servers.readonly
- pam.jump-servers.update
- pam.manage-all-privileged-resources
- pam.overview
- pam.privileged-credentials.create
- pam.privileged-credentials.delete
- pam.privileged-credentials.readonly
- pam.privileged-credentials.update
- pam.privileged-databases.create
- pam.privileged-databases.delete
- pam.privileged-databases.readonly
- pam.privileged-databases.update
- pam.privileged-servers.create
- pam.privileged-servers.delete
- pam.privileged-servers.readonly
- pam.privileged-servers.update
- pam.privileged-websites.create
- pam.privileged-websites.delete
- pam.privileged-websites.readonly
- pam.privileged-websites.update
- pam.readonly
- pam.resource-managers.create
- pam.resource-managers.delete
- pam.resource-managers.readonly
- pam.resource-managers.update
- pam.session-history
- pam.user-groups.create
- pam.user-groups.delete
- pam.user-groups.readonly
- pam.user-groups.update
- partners
- partners.readonly
- passwordmanager
- passwordmanager.readonly
- protect
- providers
- providers.readonly
- radius
- radius.readonly
- reports
- reports.readonly
- roles
- roles.readonly
- saas
- saas.readonly
- serviceaccounts
- serviceaccounts.readonly
- subscriptions.readonly
- support
- support.readonly
- systeminsights.readonly
- systems
- systems.management
- systems.readonly
- transfer
- users
- users.create
- users.password
- users.password.expire
- users.properties
- users.properties.update
- users.readonly
- users.self
- users.state
- users.state.delete
- users.state.readonly
- users.state.unlock
- users.state.update
- workflows
- workflows.readonly