Skip to content

Latest commit

 

History

History
283 lines (209 loc) · 8.63 KB

DefaultApi.md

File metadata and controls

283 lines (209 loc) · 8.63 KB

DefaultApi

All URIs are relative to https://console.jumpcloud.com/api/v2

Method HTTP request Description
jcEnrollmentProfilesDelete DELETE /enrollmentprofiles/{enrollment_profile_id} Delete Enrollment Profile
jcEnrollmentProfilesGet GET /enrollmentprofiles/{enrollment_profile_id} Get Enrollment Profile
jcEnrollmentProfilesList GET /enrollmentprofiles List Enrollment Profiles
jcEnrollmentProfilesPost POST /enrollmentprofiles Create new Enrollment Profile
jcEnrollmentProfilesPut PUT /enrollmentprofiles/{enrollment_profile_id} Update Enrollment Profile

jcEnrollmentProfilesDelete

JcEnrollmentProfile jcEnrollmentProfilesDelete(enrollmentProfileId)

Delete Enrollment Profile

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.DefaultApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

DefaultApi apiInstance = new DefaultApi();
String enrollmentProfileId = "enrollmentProfileId_example"; // String | 
try {
    JcEnrollmentProfile result = apiInstance.jcEnrollmentProfilesDelete(enrollmentProfileId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DefaultApi#jcEnrollmentProfilesDelete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
enrollmentProfileId String

Return type

JcEnrollmentProfile

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

jcEnrollmentProfilesGet

jcEnrollmentProfilesGet(enrollmentProfileId, body)

Get Enrollment Profile

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.DefaultApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

DefaultApi apiInstance = new DefaultApi();
String enrollmentProfileId = "enrollmentProfileId_example"; // String | 
JcEnrollmentProfile body = new JcEnrollmentProfile(); // JcEnrollmentProfile | 
try {
    apiInstance.jcEnrollmentProfilesGet(enrollmentProfileId, body);
} catch (ApiException e) {
    System.err.println("Exception when calling DefaultApi#jcEnrollmentProfilesGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
enrollmentProfileId String
body JcEnrollmentProfile [optional]

Return type

null (empty response body)

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

jcEnrollmentProfilesList

List<JcEnrollmentProfile> jcEnrollmentProfilesList(limit, skip)

List Enrollment Profiles

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.DefaultApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

DefaultApi apiInstance = new DefaultApi();
Integer limit = 10; // Integer | 
Integer skip = 0; // Integer | The offset into the records to return.
try {
    List<JcEnrollmentProfile> result = apiInstance.jcEnrollmentProfilesList(limit, skip);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DefaultApi#jcEnrollmentProfilesList");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]

Return type

List<JcEnrollmentProfile>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

jcEnrollmentProfilesPost

JcEnrollmentProfile jcEnrollmentProfilesPost(body)

Create new Enrollment Profile

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.DefaultApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

DefaultApi apiInstance = new DefaultApi();
Body1 body = new Body1(); // Body1 | 
try {
    JcEnrollmentProfile result = apiInstance.jcEnrollmentProfilesPost(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DefaultApi#jcEnrollmentProfilesPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body Body1 [optional]

Return type

JcEnrollmentProfile

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

jcEnrollmentProfilesPut

JcEnrollmentProfile jcEnrollmentProfilesPut(enrollmentProfileId, body)

Update Enrollment Profile

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.DefaultApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

DefaultApi apiInstance = new DefaultApi();
String enrollmentProfileId = "enrollmentProfileId_example"; // String | 
Body2 body = new Body2(); // Body2 | 
try {
    JcEnrollmentProfile result = apiInstance.jcEnrollmentProfilesPut(enrollmentProfileId, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DefaultApi#jcEnrollmentProfilesPut");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
enrollmentProfileId String
body Body2 [optional]

Return type

JcEnrollmentProfile

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json