Skip to content

Latest commit

 

History

History
1377 lines (898 loc) · 52.7 KB

ManagedServiceProviderApi.md

File metadata and controls

1377 lines (898 loc) · 52.7 KB
Raw

\ManagedServiceProviderApi

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

Method HTTP request Description
AdministratorOrganizationsCreateByAdministrator Post /administrators/{id}/organizationlinks Allow Adminstrator access to an Organization.
AdministratorOrganizationsListByAdministrator Get /administrators/{id}/organizationlinks List the association links between an Administrator and Organizations.
AdministratorOrganizationsListByOrganization Get /organizations/{id}/administratorlinks List the association links between an Organization and Administrators.
AdministratorOrganizationsRemoveByAdministrator Delete /administrators/{administrator_id}/organizationlinks/{id} Remove association between an Administrator and an Organization.
PolicyGroupTemplatesDelete Delete /providers/{provider_id}/policygrouptemplates/{id} Deletes policy group template.
PolicyGroupTemplatesGet Get /providers/{provider_id}/policygrouptemplates/{id} Gets a provider's policy group template.
PolicyGroupTemplatesGetConfiguredPolicyTemplate Get /providers/{provider_id}/configuredpolicytemplates/{id} Retrieve a configured policy template by id.
PolicyGroupTemplatesList Get /providers/{provider_id}/policygrouptemplates List a provider's policy group templates.
PolicyGroupTemplatesListConfiguredPolicyTemplates Get /providers/{provider_id}/configuredpolicytemplates List a provider's configured policy templates.
PolicyGroupTemplatesListMembers Get /providers/{provider_id}/policygrouptemplates/{id}/members Gets the list of members from a policy group template.
ProviderOrganizationsCreateOrg Post /providers/{provider_id}/organizations Create Provider Organization
ProviderOrganizationsUpdateOrg Put /providers/{provider_id}/organizations/{id} Update Provider Organization
ProvidersGetProvider Get /providers/{provider_id} Retrieve Provider
ProvidersListAdministrators Get /providers/{provider_id}/administrators List Provider Administrators
ProvidersListOrganizations Get /providers/{provider_id}/organizations List Provider Organizations
ProvidersPostAdmins Post /providers/{provider_id}/administrators Create a new Provider Administrator
ProvidersRetrieveInvoice Get /providers/{provider_id}/invoices/{ID} Download a provider's invoice.
ProvidersRetrieveInvoices Get /providers/{provider_id}/invoices List a provider's invoices.

AdministratorOrganizationsCreateByAdministrator

AdministratorOrganizationLink AdministratorOrganizationsCreateByAdministrator(ctx, id).Body(body).Execute()

Allow Adminstrator access to an Organization.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/conductorone/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    id := "id_example" // string | 
    body := *openapiclient.NewAdministratorOrganizationLinkReq() // AdministratorOrganizationLinkReq |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ManagedServiceProviderApi.AdministratorOrganizationsCreateByAdministrator(context.Background(), id).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ManagedServiceProviderApi.AdministratorOrganizationsCreateByAdministrator``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AdministratorOrganizationsCreateByAdministrator`: AdministratorOrganizationLink
    fmt.Fprintf(os.Stdout, "Response from `ManagedServiceProviderApi.AdministratorOrganizationsCreateByAdministrator`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Other Parameters

Other parameters are passed through a pointer to a apiAdministratorOrganizationsCreateByAdministratorRequest struct via the builder pattern

Name Type Description Notes

body | AdministratorOrganizationLinkReq | |

Return type

AdministratorOrganizationLink

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]

AdministratorOrganizationsListByAdministrator

[]AdministratorOrganizationLink AdministratorOrganizationsListByAdministrator(ctx, id).Limit(limit).Skip(skip).Execute()

List the association links between an Administrator and Organizations.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/conductorone/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    id := "id_example" // string | 
    limit := int32(56) // int32 | The number of records to return at once. Limited to 100. (optional) (default to 10)
    skip := int32(56) // int32 | The offset into the records to return. (optional) (default to 0)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ManagedServiceProviderApi.AdministratorOrganizationsListByAdministrator(context.Background(), id).Limit(limit).Skip(skip).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ManagedServiceProviderApi.AdministratorOrganizationsListByAdministrator``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AdministratorOrganizationsListByAdministrator`: []AdministratorOrganizationLink
    fmt.Fprintf(os.Stdout, "Response from `ManagedServiceProviderApi.AdministratorOrganizationsListByAdministrator`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Other Parameters

Other parameters are passed through a pointer to a apiAdministratorOrganizationsListByAdministratorRequest struct via the builder pattern

Name Type Description Notes

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]

Return type

[]AdministratorOrganizationLink

Authorization

x-api-key

HTTP request headers

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

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

AdministratorOrganizationsListByOrganization

[]AdministratorOrganizationLink AdministratorOrganizationsListByOrganization(ctx, id).Limit(limit).Skip(skip).Execute()

List the association links between an Organization and Administrators.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/conductorone/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    id := "id_example" // string | 
    limit := int32(56) // int32 | The number of records to return at once. Limited to 100. (optional) (default to 10)
    skip := int32(56) // int32 | The offset into the records to return. (optional) (default to 0)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ManagedServiceProviderApi.AdministratorOrganizationsListByOrganization(context.Background(), id).Limit(limit).Skip(skip).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ManagedServiceProviderApi.AdministratorOrganizationsListByOrganization``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AdministratorOrganizationsListByOrganization`: []AdministratorOrganizationLink
    fmt.Fprintf(os.Stdout, "Response from `ManagedServiceProviderApi.AdministratorOrganizationsListByOrganization`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Other Parameters

Other parameters are passed through a pointer to a apiAdministratorOrganizationsListByOrganizationRequest struct via the builder pattern

Name Type Description Notes

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]

Return type

[]AdministratorOrganizationLink

Authorization

x-api-key

HTTP request headers

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

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

AdministratorOrganizationsRemoveByAdministrator

AdministratorOrganizationsRemoveByAdministrator(ctx, administratorId, id).Execute()

Remove association between an Administrator and an Organization.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/conductorone/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    administratorId := "administratorId_example" // string | 
    id := "id_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.ManagedServiceProviderApi.AdministratorOrganizationsRemoveByAdministrator(context.Background(), administratorId, id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ManagedServiceProviderApi.AdministratorOrganizationsRemoveByAdministrator``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
administratorId string
id string

Other Parameters

Other parameters are passed through a pointer to a apiAdministratorOrganizationsRemoveByAdministratorRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

x-api-key

HTTP request headers

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

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

PolicyGroupTemplatesDelete

PolicyGroupTemplatesDelete(ctx, providerId, id).Execute()

Deletes policy group template.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/conductorone/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    providerId := "providerId_example" // string | 
    id := "id_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.ManagedServiceProviderApi.PolicyGroupTemplatesDelete(context.Background(), providerId, id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ManagedServiceProviderApi.PolicyGroupTemplatesDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId string
id string

Other Parameters

Other parameters are passed through a pointer to a apiPolicyGroupTemplatesDeleteRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

x-api-key

HTTP request headers

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

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

PolicyGroupTemplatesGet

PolicyGroupTemplate PolicyGroupTemplatesGet(ctx, providerId, id).Execute()

Gets a provider's policy group template.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/conductorone/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    providerId := "providerId_example" // string | 
    id := "id_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ManagedServiceProviderApi.PolicyGroupTemplatesGet(context.Background(), providerId, id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ManagedServiceProviderApi.PolicyGroupTemplatesGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PolicyGroupTemplatesGet`: PolicyGroupTemplate
    fmt.Fprintf(os.Stdout, "Response from `ManagedServiceProviderApi.PolicyGroupTemplatesGet`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId string
id string

Other Parameters

Other parameters are passed through a pointer to a apiPolicyGroupTemplatesGetRequest struct via the builder pattern

Name Type Description Notes

Return type

PolicyGroupTemplate

Authorization

x-api-key

HTTP request headers

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

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

PolicyGroupTemplatesGetConfiguredPolicyTemplate

ConfiguredPolicyTemplate PolicyGroupTemplatesGetConfiguredPolicyTemplate(ctx, providerId, id).Execute()

Retrieve a configured policy template by id.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/conductorone/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    providerId := "providerId_example" // string | 
    id := "id_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ManagedServiceProviderApi.PolicyGroupTemplatesGetConfiguredPolicyTemplate(context.Background(), providerId, id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ManagedServiceProviderApi.PolicyGroupTemplatesGetConfiguredPolicyTemplate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PolicyGroupTemplatesGetConfiguredPolicyTemplate`: ConfiguredPolicyTemplate
    fmt.Fprintf(os.Stdout, "Response from `ManagedServiceProviderApi.PolicyGroupTemplatesGetConfiguredPolicyTemplate`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId string
id string

Other Parameters

Other parameters are passed through a pointer to a apiPolicyGroupTemplatesGetConfiguredPolicyTemplateRequest struct via the builder pattern

Name Type Description Notes

Return type

ConfiguredPolicyTemplate

Authorization

x-api-key

HTTP request headers

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

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

PolicyGroupTemplatesList

PolicyGroupTemplates PolicyGroupTemplatesList(ctx, providerId).Fields(fields).Skip(skip).Sort(sort).Limit(limit).Filter(filter).Execute()

List a provider's policy group templates.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/conductorone/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    providerId := "providerId_example" // string | 
    fields := []string{"Inner_example"} // []string | The comma separated fields included in the returned records. If omitted, the default list of fields will be returned.  (optional) (default to [])
    skip := int32(56) // int32 | The offset into the records to return. (optional) (default to 0)
    sort := []string{"Inner_example"} // []string | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.  (optional) (default to [])
    limit := int32(56) // int32 | The number of records to return at once. Limited to 100. (optional) (default to 10)
    filter := []string{"Inner_example"} // []string | A filter to apply to the query.  **Filter structure**: `<field>:<operator>:<value>`.  **field** = Populate with a valid field from an endpoint response.  **operator** =  Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. _Note: v1 operators differ from v2 operators._  **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards.  **EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` (optional) (default to [])

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ManagedServiceProviderApi.PolicyGroupTemplatesList(context.Background(), providerId).Fields(fields).Skip(skip).Sort(sort).Limit(limit).Filter(filter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ManagedServiceProviderApi.PolicyGroupTemplatesList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PolicyGroupTemplatesList`: PolicyGroupTemplates
    fmt.Fprintf(os.Stdout, "Response from `ManagedServiceProviderApi.PolicyGroupTemplatesList`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId string

Other Parameters

Other parameters are passed through a pointer to a apiPolicyGroupTemplatesListRequest struct via the builder pattern

Name Type Description Notes

fields | []string | The comma separated fields included in the returned records. If omitted, the default list of fields will be returned. | [default to []] skip | int32 | The offset into the records to return. | [default to 0] sort | []string | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. | [default to []] limit | int32 | The number of records to return at once. Limited to 100. | [default to 10] filter | []string | A filter to apply to the query. Filter structure: `<field>:<operator>:<value>`. field = Populate with a valid field from an endpoint response. operator = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. Note: v1 operators differ from v2 operators. value = Populate with the value you want to search for. Is case sensitive. Supports wild cards. EX: `GET /api/v2/groups?filter=name:eq:Test+Group` | [default to []]

Return type

PolicyGroupTemplates

Authorization

x-api-key

HTTP request headers

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

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

PolicyGroupTemplatesListConfiguredPolicyTemplates

PolicyGroupTemplatesListConfiguredPolicyTemplates200Response PolicyGroupTemplatesListConfiguredPolicyTemplates(ctx, providerId).Skip(skip).Sort(sort).Limit(limit).Filter(filter).Execute()

List a provider's configured policy templates.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/conductorone/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    providerId := "providerId_example" // string | 
    skip := int32(56) // int32 | The offset into the records to return. (optional) (default to 0)
    sort := []string{"Inner_example"} // []string | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.  (optional) (default to [])
    limit := int32(56) // int32 | The number of records to return at once. Limited to 100. (optional) (default to 10)
    filter := []string{"Inner_example"} // []string | A filter to apply to the query.  **Filter structure**: `<field>:<operator>:<value>`.  **field** = Populate with a valid field from an endpoint response.  **operator** =  Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. _Note: v1 operators differ from v2 operators._  **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards.  **EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` (optional) (default to [])

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ManagedServiceProviderApi.PolicyGroupTemplatesListConfiguredPolicyTemplates(context.Background(), providerId).Skip(skip).Sort(sort).Limit(limit).Filter(filter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ManagedServiceProviderApi.PolicyGroupTemplatesListConfiguredPolicyTemplates``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PolicyGroupTemplatesListConfiguredPolicyTemplates`: PolicyGroupTemplatesListConfiguredPolicyTemplates200Response
    fmt.Fprintf(os.Stdout, "Response from `ManagedServiceProviderApi.PolicyGroupTemplatesListConfiguredPolicyTemplates`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId string

Other Parameters

Other parameters are passed through a pointer to a apiPolicyGroupTemplatesListConfiguredPolicyTemplatesRequest struct via the builder pattern

Name Type Description Notes

skip | int32 | The offset into the records to return. | [default to 0] sort | []string | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. | [default to []] limit | int32 | The number of records to return at once. Limited to 100. | [default to 10] filter | []string | A filter to apply to the query. Filter structure: `<field>:<operator>:<value>`. field = Populate with a valid field from an endpoint response. operator = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. Note: v1 operators differ from v2 operators. value = Populate with the value you want to search for. Is case sensitive. Supports wild cards. EX: `GET /api/v2/groups?filter=name:eq:Test+Group` | [default to []]

Return type

PolicyGroupTemplatesListConfiguredPolicyTemplates200Response

Authorization

x-api-key

HTTP request headers

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

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

PolicyGroupTemplatesListMembers

PolicyGroupTemplateMembers PolicyGroupTemplatesListMembers(ctx, providerId, id).Skip(skip).Sort(sort).Limit(limit).Filter(filter).Execute()

Gets the list of members from a policy group template.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/conductorone/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    providerId := "providerId_example" // string | 
    id := "id_example" // string | 
    skip := int32(56) // int32 | The offset into the records to return. (optional) (default to 0)
    sort := []string{"Inner_example"} // []string | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.  (optional) (default to [])
    limit := int32(56) // int32 | The number of records to return at once. Limited to 100. (optional) (default to 10)
    filter := []string{"Inner_example"} // []string | A filter to apply to the query.  **Filter structure**: `<field>:<operator>:<value>`.  **field** = Populate with a valid field from an endpoint response.  **operator** =  Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. _Note: v1 operators differ from v2 operators._  **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards.  **EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` (optional) (default to [])

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ManagedServiceProviderApi.PolicyGroupTemplatesListMembers(context.Background(), providerId, id).Skip(skip).Sort(sort).Limit(limit).Filter(filter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ManagedServiceProviderApi.PolicyGroupTemplatesListMembers``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PolicyGroupTemplatesListMembers`: PolicyGroupTemplateMembers
    fmt.Fprintf(os.Stdout, "Response from `ManagedServiceProviderApi.PolicyGroupTemplatesListMembers`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId string
id string

Other Parameters

Other parameters are passed through a pointer to a apiPolicyGroupTemplatesListMembersRequest struct via the builder pattern

Name Type Description Notes

skip | int32 | The offset into the records to return. | [default to 0] sort | []string | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. | [default to []] limit | int32 | The number of records to return at once. Limited to 100. | [default to 10] filter | []string | A filter to apply to the query. Filter structure: `<field>:<operator>:<value>`. field = Populate with a valid field from an endpoint response. operator = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. Note: v1 operators differ from v2 operators. value = Populate with the value you want to search for. Is case sensitive. Supports wild cards. EX: `GET /api/v2/groups?filter=name:eq:Test+Group` | [default to []]

Return type

PolicyGroupTemplateMembers

Authorization

x-api-key

HTTP request headers

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

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

ProviderOrganizationsCreateOrg

Organization ProviderOrganizationsCreateOrg(ctx, providerId).Body(body).Execute()

Create Provider Organization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/conductorone/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    providerId := "providerId_example" // string | 
    body := *openapiclient.NewCreateOrganization() // CreateOrganization |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ManagedServiceProviderApi.ProviderOrganizationsCreateOrg(context.Background(), providerId).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ManagedServiceProviderApi.ProviderOrganizationsCreateOrg``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProviderOrganizationsCreateOrg`: Organization
    fmt.Fprintf(os.Stdout, "Response from `ManagedServiceProviderApi.ProviderOrganizationsCreateOrg`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId string

Other Parameters

Other parameters are passed through a pointer to a apiProviderOrganizationsCreateOrgRequest struct via the builder pattern

Name Type Description Notes

body | CreateOrganization | |

Return type

Organization

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]

ProviderOrganizationsUpdateOrg

Organization ProviderOrganizationsUpdateOrg(ctx, providerId, id).Body(body).Execute()

Update Provider Organization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/conductorone/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    providerId := "providerId_example" // string | 
    id := "id_example" // string | 
    body := *openapiclient.NewOrganization() // Organization |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ManagedServiceProviderApi.ProviderOrganizationsUpdateOrg(context.Background(), providerId, id).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ManagedServiceProviderApi.ProviderOrganizationsUpdateOrg``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProviderOrganizationsUpdateOrg`: Organization
    fmt.Fprintf(os.Stdout, "Response from `ManagedServiceProviderApi.ProviderOrganizationsUpdateOrg`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId string
id string

Other Parameters

Other parameters are passed through a pointer to a apiProviderOrganizationsUpdateOrgRequest struct via the builder pattern

Name Type Description Notes

body | Organization | |

Return type

Organization

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]

ProvidersGetProvider

Provider ProvidersGetProvider(ctx, providerId).Fields(fields).Execute()

Retrieve Provider

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/conductorone/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    providerId := "providerId_example" // string | 
    fields := []string{"Inner_example"} // []string | The comma separated fields included in the returned records. If omitted, the default list of fields will be returned.  (optional) (default to [])

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ManagedServiceProviderApi.ProvidersGetProvider(context.Background(), providerId).Fields(fields).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ManagedServiceProviderApi.ProvidersGetProvider``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersGetProvider`: Provider
    fmt.Fprintf(os.Stdout, "Response from `ManagedServiceProviderApi.ProvidersGetProvider`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId string

Other Parameters

Other parameters are passed through a pointer to a apiProvidersGetProviderRequest struct via the builder pattern

Name Type Description Notes

fields | []string | The comma separated fields included in the returned records. If omitted, the default list of fields will be returned. | [default to []]

Return type

Provider

Authorization

x-api-key

HTTP request headers

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

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

ProvidersListAdministrators

ProvidersListAdministrators200Response ProvidersListAdministrators(ctx, providerId).Fields(fields).Filter(filter).Limit(limit).Skip(skip).Sort(sort).SortIgnoreCase(sortIgnoreCase).Execute()

List Provider Administrators

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/conductorone/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    providerId := "providerId_example" // string | 
    fields := []string{"Inner_example"} // []string | The comma separated fields included in the returned records. If omitted, the default list of fields will be returned.  (optional) (default to [])
    filter := []string{"Inner_example"} // []string | A filter to apply to the query.  **Filter structure**: `<field>:<operator>:<value>`.  **field** = Populate with a valid field from an endpoint response.  **operator** =  Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. _Note: v1 operators differ from v2 operators._  **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards.  **EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` (optional) (default to [])
    limit := int32(56) // int32 | The number of records to return at once. Limited to 100. (optional) (default to 10)
    skip := int32(56) // int32 | The offset into the records to return. (optional) (default to 0)
    sort := []string{"Inner_example"} // []string | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.  (optional) (default to [])
    sortIgnoreCase := []string{"Inner_example"} // []string | The comma separated fields used to sort the collection, ignoring case. Default sort is ascending, prefix with `-` to sort descending.  (optional) (default to [])

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ManagedServiceProviderApi.ProvidersListAdministrators(context.Background(), providerId).Fields(fields).Filter(filter).Limit(limit).Skip(skip).Sort(sort).SortIgnoreCase(sortIgnoreCase).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ManagedServiceProviderApi.ProvidersListAdministrators``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersListAdministrators`: ProvidersListAdministrators200Response
    fmt.Fprintf(os.Stdout, "Response from `ManagedServiceProviderApi.ProvidersListAdministrators`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId string

Other Parameters

Other parameters are passed through a pointer to a apiProvidersListAdministratorsRequest struct via the builder pattern

Name Type Description Notes

fields | []string | The comma separated fields included in the returned records. If omitted, the default list of fields will be returned. | [default to []] filter | []string | A filter to apply to the query. Filter structure: `<field>:<operator>:<value>`. field = Populate with a valid field from an endpoint response. operator = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. Note: v1 operators differ from v2 operators. value = Populate with the value you want to search for. Is case sensitive. Supports wild cards. EX: `GET /api/v2/groups?filter=name:eq:Test+Group` | [default to []] 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] sort | []string | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. | [default to []] sortIgnoreCase | []string | The comma separated fields used to sort the collection, ignoring case. Default sort is ascending, prefix with `-` to sort descending. | [default to []]

Return type

ProvidersListAdministrators200Response

Authorization

x-api-key

HTTP request headers

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

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

ProvidersListOrganizations

ProvidersListOrganizations200Response ProvidersListOrganizations(ctx, providerId).Fields(fields).Filter(filter).Limit(limit).Skip(skip).Sort(sort).SortIgnoreCase(sortIgnoreCase).Execute()

List Provider Organizations

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/conductorone/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    providerId := "providerId_example" // string | 
    fields := []string{"Inner_example"} // []string | The comma separated fields included in the returned records. If omitted, the default list of fields will be returned.  (optional) (default to [])
    filter := []string{"Inner_example"} // []string | A filter to apply to the query.  **Filter structure**: `<field>:<operator>:<value>`.  **field** = Populate with a valid field from an endpoint response.  **operator** =  Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. _Note: v1 operators differ from v2 operators._  **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards.  **EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` (optional) (default to [])
    limit := int32(56) // int32 | The number of records to return at once. Limited to 100. (optional) (default to 10)
    skip := int32(56) // int32 | The offset into the records to return. (optional) (default to 0)
    sort := []string{"Inner_example"} // []string | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.  (optional) (default to [])
    sortIgnoreCase := []string{"Inner_example"} // []string | The comma separated fields used to sort the collection, ignoring case. Default sort is ascending, prefix with `-` to sort descending.  (optional) (default to [])

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ManagedServiceProviderApi.ProvidersListOrganizations(context.Background(), providerId).Fields(fields).Filter(filter).Limit(limit).Skip(skip).Sort(sort).SortIgnoreCase(sortIgnoreCase).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ManagedServiceProviderApi.ProvidersListOrganizations``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersListOrganizations`: ProvidersListOrganizations200Response
    fmt.Fprintf(os.Stdout, "Response from `ManagedServiceProviderApi.ProvidersListOrganizations`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId string

Other Parameters

Other parameters are passed through a pointer to a apiProvidersListOrganizationsRequest struct via the builder pattern

Name Type Description Notes

fields | []string | The comma separated fields included in the returned records. If omitted, the default list of fields will be returned. | [default to []] filter | []string | A filter to apply to the query. Filter structure: `<field>:<operator>:<value>`. field = Populate with a valid field from an endpoint response. operator = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. Note: v1 operators differ from v2 operators. value = Populate with the value you want to search for. Is case sensitive. Supports wild cards. EX: `GET /api/v2/groups?filter=name:eq:Test+Group` | [default to []] 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] sort | []string | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. | [default to []] sortIgnoreCase | []string | The comma separated fields used to sort the collection, ignoring case. Default sort is ascending, prefix with `-` to sort descending. | [default to []]

Return type

ProvidersListOrganizations200Response

Authorization

x-api-key

HTTP request headers

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

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

ProvidersPostAdmins

Administrator ProvidersPostAdmins(ctx, providerId).Body(body).Execute()

Create a new Provider Administrator

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/conductorone/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    providerId := "providerId_example" // string | 
    body := *openapiclient.NewProviderAdminReq("Email_example") // ProviderAdminReq |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ManagedServiceProviderApi.ProvidersPostAdmins(context.Background(), providerId).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ManagedServiceProviderApi.ProvidersPostAdmins``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersPostAdmins`: Administrator
    fmt.Fprintf(os.Stdout, "Response from `ManagedServiceProviderApi.ProvidersPostAdmins`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId string

Other Parameters

Other parameters are passed through a pointer to a apiProvidersPostAdminsRequest struct via the builder pattern

Name Type Description Notes

body | ProviderAdminReq | |

Return type

Administrator

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]

ProvidersRetrieveInvoice

*os.File ProvidersRetrieveInvoice(ctx, providerId, iD).Execute()

Download a provider's invoice.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/conductorone/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    providerId := "providerId_example" // string | 
    iD := "iD_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ManagedServiceProviderApi.ProvidersRetrieveInvoice(context.Background(), providerId, iD).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ManagedServiceProviderApi.ProvidersRetrieveInvoice``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersRetrieveInvoice`: *os.File
    fmt.Fprintf(os.Stdout, "Response from `ManagedServiceProviderApi.ProvidersRetrieveInvoice`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId string
iD string

Other Parameters

Other parameters are passed through a pointer to a apiProvidersRetrieveInvoiceRequest struct via the builder pattern

Name Type Description Notes

Return type

*os.File

Authorization

x-api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/pdf

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

ProvidersRetrieveInvoices

ProviderInvoiceResponse ProvidersRetrieveInvoices(ctx, providerId).Skip(skip).Sort(sort).Limit(limit).Execute()

List a provider's invoices.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/conductorone/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    providerId := "providerId_example" // string | 
    skip := int32(56) // int32 | The offset into the records to return. (optional) (default to 0)
    sort := []string{"Inner_example"} // []string | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.  (optional) (default to [])
    limit := int32(56) // int32 | The number of records to return at once. Limited to 100. (optional) (default to 10)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ManagedServiceProviderApi.ProvidersRetrieveInvoices(context.Background(), providerId).Skip(skip).Sort(sort).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ManagedServiceProviderApi.ProvidersRetrieveInvoices``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersRetrieveInvoices`: ProviderInvoiceResponse
    fmt.Fprintf(os.Stdout, "Response from `ManagedServiceProviderApi.ProvidersRetrieveInvoices`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId string

Other Parameters

Other parameters are passed through a pointer to a apiProvidersRetrieveInvoicesRequest struct via the builder pattern

Name Type Description Notes

skip | int32 | The offset into the records to return. | [default to 0] sort | []string | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. | [default to []] limit | int32 | The number of records to return at once. Limited to 100. | [default to 10]

Return type

ProviderInvoiceResponse

Authorization

x-api-key

HTTP request headers

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

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