{"id":81704,"date":"2023-06-05T13:09:43","date_gmt":"2023-06-05T17:09:43","guid":{"rendered":"https:\/\/jumpcloud.com\/?post_type=support&p=81704"},"modified":"2024-07-24T16:59:39","modified_gmt":"2024-07-24T20:59:39","slug":"jumpcloud-apis","status":"publish","type":"support","link":"https:\/\/jumpcloud.com\/support\/jumpcloud-apis","title":{"rendered":"JumpCloud APIs"},"content":{"rendered":"\n
Directory Insights is JumpCloud’s event logging and compliance feature. It shines a light on audit trails leading up to critical events so you know the what, where, when, how, and who of your directory activities.<\/p>\n\n\n\n
You can use our RESTful API, PowerShell Module, and Admin Portal to access event logs, see activity happening in your directory, and monitor user authentications to the User Portal, SAML SSO applications, RADIUS, and LDAP. See Directory Insights<\/a> to learn more.<\/p>\n\n\n\n <\/p><\/div> With the exceptions listed below, all API documentation has been moved to JumpCloud API Docs<\/a>. Depending on the functionality desired, you may need to call either, or both endpoints in v1 and v2 of our API.<\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n Supplemental scripts and precompiled binaries can be found on our public Github Support Repository<\/a>. Considerations<\/strong>:<\/p>\n\n\n\n To leverage any of JumpCloud’s available API options, an API key is required during the configuration.<\/p>\n\n\n\n To access your API key:<\/strong><\/p>\n\n\n\n <\/p><\/div> <\/p><\/div> Note:<\/strong> Admin accounts created before July 15, 2024 will have no expiration date for their API keys. This can be changed at any time. <\/p><\/div><\/div><\/div>\n\n\n\n <\/p><\/div> Note:<\/strong> If you generate a new API key, the default expiration for the key will be set to 90 days. <\/p><\/div><\/div><\/div>\n\n\n\n It’s very important to exercise strong security posture when handling your API key, as it gives unfiltered access to your JumpCloud instance through API calls. If you believe for any reason that your API key may have been shared or compromised, we suggest generating a new API key.<\/p>\n\n\n\n <\/p><\/div> Warning:<\/strong> Generating a new API key will revoke access to the current API key. This will render all calls using the previous API key inaccessible. You will have to update any existing integrations that use an API key with the newly generated value.<\/p><\/div><\/div><\/div>\n\n\n\n This will impact any of the following integrations: <\/p>\n\n\n\n
Additional client code can be found in the following repos:<\/p>\n\n\n\n\n
Accessing Your API Key<\/h2>\n\n\n\n
\n
\n
\n
\n
To set a Time to Live (TTL) for your API Key:<\/strong><\/h3>\n\n\n\n
\n
Generating a New API Key<\/h2>\n\n\n\n
\n
\n
\n
FAQ<\/h2>\n\n\n\n