JumpCloud Integration Setup

Integrating Rewst with JumpCloud offers users a powerful combination of IT documentation and cloud directory services. With this integration, Rewst users can seamlessly leverage JumpCloud's comprehensive identity and access management capabilities within the Rewst platform. Users can efficiently manage user accounts, access permissions, and authentication processes, all while maintaining a centralized documentation repository in Rewst. This integration streamlines IT operations, enhances security, and simplifies user management, providing a seamless experience for managing identities and accessing IT documentation within the Rewst platform.

Setup​

Jumpcloud Setup​

  1. Log in to the JumpCloud Console.

  2. Click on your User Icon to reveal the user settings menu.

  3. Click "My API Key".

  4. Copy the API Key.

To access multiple organizations with this integration you must also:

  • Have access to the JumpCloud Multi-Tenant Portal

  • Define a default organization ID in the integration configuration form in Rewst

  • Map organizations to their JumpCloud counterparts in Rewst

Click here for more information about multi-tenancy in JumpCloud.

Rewst Setup​

  1. Navigate to the integrations page in Rewst.

  2. Click on the JumpCloud integration.

  3. Fill out the configuration form using the API key generated in JumpCloud.

  4. (Optional) Define a default organization ID in the configuration form.

  5. Save the configuration form.

  6. Map Rewst organizations to their JumpCloud counterparts in Rewst.

Actions

Groups

List User Groups​

Request - List User Groups​

GET /v2/usergroups

KeyTypeDescription

x-org-id

Jumpcloud Organization ID

None Provided

fields

String (?)

The fields to return in the response

Add User To Group​

Adds a user to specified group

Request - Add User To Group​

POST /v2/usergroups/{group_id}/members

KeyTypeDescription

x-org-id

Jumpcloud Organization ID

None Provided

group_id*

Jumpcloud Group ID

None Provided

id*

Jumpcloud User ID

None Provided

type

String (?)

None Provided

op

String (?)

None Provided

Remove User From Group​

Removes a user to specified group

Request - Remove User From Group​

POST /v2/usergroups/{group_id}/members

KeyTypeDescription

x-org-id

Jumpcloud Organization ID

None Provided

group_id*

Jumpcloud Group ID

None Provided

id*

Jumpcloud User ID

None Provided

type

String (?)

None Provided

op

String (?)

None Provided


Objects - Group​

Filter​

KeyTypeDescription

field

String

None Provided

operator

String

None Provided

value

String (?)

None Provided

Users

Get User​

Gets user by user ID

Request - Get User​

GET /systemusers?filter=_id:$eq:{user_id}

KeyTypeDescription

x-org-id

Jumpcloud Organization

None Provided

user_id*

Jumpcloud User ID

None Provided

Create User​

Request - Create User​

POST /systemusers

KeyTypeDescription

x-org-id

Jumpcloud Organization ID

None Provided

username*

String (?)

None Provided

email*

String (?)

None Provided

account_locked

String (?)

None Provided

activated

String (?)

None Provided

allow_public_key

String (?)

None Provided

alternateEmail

String (?)

None Provided

company

String (?)

None Provided

costCenter

String (?)

None Provided

department

String (?)

None Provided

description

String (?)

None Provided

disableDeviceMaxLoginAttempts

String (?)

None Provided

displayname

String (?)

None Provided

employeeIdentifier

String (?)

None Provided

employeeType

String (?)

None Provided

enable_managed_uid

String (?)

None Provided

enable_user_portal_multifactor

String (?)

None Provided

external_dn

String (?)

None Provided

external_password_expiration_date

String (?)

None Provided

external_source_type

String (?)

None Provided

externally_managed

String (?)

None Provided

firstname

String (?)

None Provided

middlename

String (?)

None Provided

lastname

String (?)

None Provided

jobTitle

String (?)

None Provided

ldap_binding_user

String (?)

None Provided

location

String (?)

None Provided

managedAppleId

String (?)

None Provided

manager

String (?)

None Provided

mfa

String (?)

None Provided

password

String (?)

None Provided

password_never_expires

String (?)

None Provided

passwordless_sudo

String (?)

None Provided

public_key

String (?)

None Provided

samba_service_user

String (?)

None Provided

state

String

None Provided

sudo

String (?)

None Provided

suspended

String (?)

None Provided

tags

String (?)

None Provided

unix_guid

String (?)

None Provided

unix_uid

String (?)

None Provided

Delete User​

Delete user by user ID

Request - Delete User​

DELETE /systemusers/{user_id}

KeyTypeDescription

x-org-id

Jumpcloud Organization ID

None Provided

user_id*

Jumpcloud User ID

None Provided

Modify User​

Modify user by user ID

Request - Modify User​

PUT /systemusers/{user_id}

KeyTypeDescription

x-org-id

Jumpcloud Organization ID

None Provided

username*

String (?)

None Provided

email*

String (?)

None Provided

account_locked

String (?)

None Provided

activated

String (?)

None Provided

allow_public_key

String (?)

None Provided

alternateEmail

String (?)

None Provided

company

String (?)

None Provided

costCenter

String (?)

None Provided

department

String (?)

None Provided

description

String (?)

None Provided

disableDeviceMaxLoginAttempts

String (?)

None Provided

displayname

String (?)

None Provided

employeeIdentifier

String (?)

None Provided

employeeType

String (?)

None Provided

enable_managed_uid

String (?)

None Provided

enable_user_portal_multifactor

String (?)

None Provided

external_dn

String (?)

None Provided

external_password_expiration_date

String (?)

None Provided

external_source_type

String (?)

None Provided

externally_managed

String (?)

None Provided

firstname

String (?)

None Provided

middlename

String (?)

None Provided

lastname

String (?)

None Provided

jobTitle

String (?)

None Provided

ldap_binding_user

String (?)

None Provided

location

String (?)

None Provided

managedAppleId

String (?)

None Provided

manager

String (?)

None Provided

mfa

String (?)

None Provided

password

String (?)

None Provided

password_never_expires

String (?)

None Provided

passwordless_sudo

String (?)

None Provided

public_key

String (?)

None Provided

samba_service_user

String (?)

None Provided

state

String

None Provided

sudo

String (?)

None Provided

suspended

String (?)

None Provided

tags

String (?)

None Provided

unix_guid

String (?)

None Provided

unix_uid

String (?)

None Provided

Assign Manager​

Assigns manager to specified user

Request - Assign Manager​

PUT /systemusers/{user_id}

KeyTypeDescription

x-org-id

Jumpcloud Organization ID

None Provided

user_id*

Jumpcloud User ID

None Provided

manager*

Jumpcloud Manager ID

None Provided

Change Password​

Changes the specified user's password

Request - Change Password​

PUT /systemusers/{user_id}

KeyTypeDescription

x-org-id

Jumpcloud Organization ID

None Provided

user_id*

Jumpcloud User ID

None Provided

password*

String (?)

New password


Objects - User​

Address​

KeyTypeDescription

country

String (?)

None Provided

extendedAddress

String (?)

None Provided

locality

String (?)

None Provided

poBox

String (?)

None Provided

postalCode

String (?)

None Provided

region

String (?)

None Provided

streetAddress

String (?)

None Provided


Attribute​

KeyTypeDescription

name

String (?)

None Provided

value

String (?)

None Provided


Phonenumber​

KeyTypeDescription

name

String (?)

None Provided

value

String (?)

None Provided


Recoveryemail​

KeyTypeDescription

address

String (?)

None Provided


Relationship​

KeyTypeDescription

type

String (?)

None Provided

value

String (?)

None Provided

Last updated