JumpCloud SCIM Import API

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 SCIM Import 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: SCIM Import
paths:
  /applications/{application_id}/import/users:
    parameters:
    - description: ObjectID of the Application.
      in: path
      name: application_id
      required: true
      schema:
        type: string
    x-functionalities-tags:
    - user-portal-applications
    get:
      description: Get a list of users to import from an Application IdM service provider.
      operationId: import_users
      parameters:
      - in: query
        name: filter
        description: Filter users by a search term
        schema:
          type: string
          default: ''
        allowReserved: true
      - in: query
        name: query
        description: URL query to merge with the service provider request
        schema:
          type: string
          default: ''
        allowReserved: true
      - in: query
        name: sort
        description: Sort users by supported fields
        schema:
          type: string
          enum:
          - ''
          - firstname
          - lastname
          - email
          default: ''
        allowReserved: true
      - in: query
        name: sortOrder
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      - in: query
        name: sessionId
        description: Import sessionId for manual select and view user
        schema:
          type: string
          default: ''
      - in: query
        name: isCount
        description: IsCount indicates if the request is only for getting the total count of users.
        schema:
          type: boolean
          default: false
      - in: query
        name: isCursor
        description: Enable cursor-based pagination
        schema:
          type: boolean
          default: false
      - in: query
        name: cursor
        description: Cursor token for pagination
        schema:
          type: string
          default: ''
      - $ref: '#/components/parameters/trait_multiTenantRequestHeaders_x-org-id'
      - $ref: '#/components/parameters/trait_limit_limit'
      - $ref: '#/components/parameters/trait_skip_skip'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/importUsersResponse'
      security:
      - x-api-key: []
      summary: Get a list of users to import from an Application IdM service provider
      tags:
      - SCIM Import
      x-scopes:
      - applications
      - applications.readonly
      x-codeSamples:
      - lang: Shell
        source: "curl --request GET \\\n  --url 'https://console.jumpcloud.com/api/v2/applications/{application_id}/import/users?filter=SOME_STRING_VALUE&query=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE&sessionId=SOME_STRING_VALUE&isCount=SOME_BOOLEAN_VALUE&isCursor=SOME_BOOLEAN_VALUE&cursor=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE' \\\n  --header 'x-api-key: REPLACE_KEY_VALUE' \\\n  --header 'x-org-id: SOME_STRING_VALUE'"
      - lang: Python
        source: "import requests\n\nurl = \"https://console.jumpcloud.com/api/v2/applications/{application_id}/import/users\"\n\nquerystring = {\"filter\":\"SOME_STRING_VALUE\",\"query\":\"SOME_STRING_VALUE\",\"sort\":\"SOME_STRING_VALUE\",\"sortOrder\":\"SOME_STRING_VALUE\",\"sessionId\":\"SOME_STRING_VALUE\",\"isCount\":\"SOME_BOOLEAN_VALUE\",\"isCursor\":\"SOME_BOOLEAN_VALUE\",\"cursor\":\"SOME_STRING_VALUE\",\"limit\":\"SOME_INTEGER_VALUE\",\"skip\":\"SOME_INTEGER_VALUE\"}\n\nheaders = {\n    \"x-org-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-org-id", "SOME_STRING_VALUE")

          $headers.Add("x-api-key", "REPLACE_KEY_VALUE")

          $response = Invoke-RestMethod -Uri ''https://console.jumpcloud.com/api/v2/applications/{application_id}/import/users?filter=SOME_STRING_VALUE&query=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE&sessionId=SOME_STRING_VALUE&isCount=SOME_BOOLEAN_VALUE&isCursor=SOME_BOOLEAN_VALUE&cursor=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE'' -Method GET -Headers $headers'
components:
  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_multiTenantRequestHeaders_x-org-id:
      description: Organization identifier that can be obtained from console settings.
      in: header
      name: x-org-id
      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:
    importUserPhoneNumber:
      title: Import User Address
      type: object
      properties:
        type:
          type: string
        value:
          type: string
    importUser:
      title: Import User
      type: object
      properties:
        id:
          type: string
        email:
          type: string
        username:
          type: string
        firstname:
          type: string
        lastname:
          type: string
        middlename:
          type: string
        displayname:
          type: string
        department:
          type: string
        jobTitle:
          type: string
        costCenter:
          type: string
        employeeType:
          type: string
        employeeIdentifier:
          type: string
        company:
          type: string
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/importUserAddress'
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/importUserPhoneNumber'
        manager:
          type: string
        location:
          type: string
        alternateEmail:
          type: string
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/importUserAttribute'
    importUserAddress:
      title: Import User Address
      type: object
      properties:
        type:
          type: string
        streetAddress:
          type: string
        locality:
          type: string
        region:
          type: string
        postalCode:
          type: string
        country:
          type: string
    importUsersResponse:
      title: Import Users Response
      type: object
      properties:
        total_count:
          type: number
        session_id:
          type: string
        users:
          type: array
          items:
            $ref: '#/components/schemas/importUser'
        cursor:
          type: string
    importUserAttribute:
      title: Import User Attribute
      type: object
      properties:
        name:
          type: string
        value:
          type: string
  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