Skip to content

Latest commit

 

History

History
179 lines (123 loc) · 7.33 KB

BulkJobRequestsApi.md

File metadata and controls

179 lines (123 loc) · 7.33 KB

\BulkJobRequestsApi

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

Method HTTP request Description
BulkUsersCreate Post /bulk/users Bulk Users Create
BulkUsersCreateResults Get /bulk/users/{job_id}/results List Bulk Users Create Results
JobsGet Get /jobs/{id} Get Job (incomplete)
JobsResults Get /jobs/{id}/results List Job Results

BulkUsersCreate

JobId BulkUsersCreate(ctx, contentType, accept, optional) Bulk Users Create

The endpoint allows you to create a bulk job to asynchronously create users. #### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"email\":\"{email}\", \"firstname\":\"{firstname}\", \"lastname\":\"{firstname}\", \"username\":\"{username}\", \"attributes\":[ {\"name\":\"EmployeeID\",\"value\":\"0000\"}, {\"name\":\"Custom\",\"value\":\"attribute\"} ] } ]

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
contentType string [default to application/json]
accept string [default to application/json]
body []BulkUserCreate
xOrgId string [default to ]

Return type

JobId

Authorization

x-api-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BulkUsersCreateResults

[]JobWorkresult BulkUsersCreateResults(ctx, jobId, contentType, accept, optional) List Bulk Users Create Results

This endpoint will return the results of particular import job request. ###Sample Request curl -X GET \\ https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
jobId string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
jobId string
contentType string [default to application/json]
accept string [default to application/json]
limit int32 The number of records to return at once. Limited to 100. [default to 10]
skip int32 The offset into the records to return. [default to 0]
xOrgId string [default to ]

Return type

[]JobWorkresult

Authorization

x-api-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

JobsGet

JobDetails JobsGet(ctx, id, contentType, accept, optional) Get Job (incomplete)

This endpoint is not complete and should remain hidden as it's not functional yet.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
id string
contentType string [default to application/json]
accept string [default to application/json]
xOrgId string [default to ]

Return type

JobDetails

Authorization

x-api-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

JobsResults

[]JobWorkresult JobsResults(ctx, id, contentType, accept, optional) List Job Results

This endpoint will return the results of particular import job request. ###Sample Request curl -X GET \\ https://console.jumpcloud.com/api/v2/jobs/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
id string
contentType string [default to application/json]
accept string [default to application/json]
limit int32 The number of records to return at once. Limited to 100. [default to 10]
skip int32 The offset into the records to return. [default to 0]
xOrgId string [default to ]

Return type

[]JobWorkresult

Authorization

x-api-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]