All URIs are relative to https://console.jumpcloud.com/api/v2
| Method | HTTP request | Description |
|---|---|---|
| GraphSystemGroupAssociationsList | Get /systemgroups/{group_id}/associations | List the associations of a System Group |
| GraphSystemGroupAssociationsPost | Post /systemgroups/{group_id}/associations | Manage the associations of a System Group |
| GraphSystemGroupTraverseCommand | Get /systemgroups/{group_id}/commands | List the Commands bound to a System Group |
| GraphSystemGroupTraversePolicy | Get /systemgroups/{group_id}/policies | List the Policies bound to a System Group |
| GraphSystemGroupTraversePolicyGroup | Get /systemgroups/{group_id}/policygroups | List the Policy Groups bound to a System Group |
| GraphSystemGroupTraverseUser | Get /systemgroups/{group_id}/users | List the Users bound to a System Group |
| GraphSystemGroupTraverseUserGroup | Get /systemgroups/{group_id}/usergroups | List the User Groups bound to a System Group |
[]GraphConnection GraphSystemGroupAssociationsList(ctx, groupId).Targets(targets).Limit(limit).Skip(skip).XOrgId(xOrgId).Execute()
List the associations of a System Group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)
func main() {
groupId := "groupId_example" // string | ObjectID of the System Group.
targets := []string{"Targets_example"} // []string | Targets which a \"system_group\" can be associated 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)
xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.SystemGroupAssociationsApi.GraphSystemGroupAssociationsList(context.Background(), groupId).Targets(targets).Limit(limit).Skip(skip).XOrgId(xOrgId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SystemGroupAssociationsApi.GraphSystemGroupAssociationsList``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GraphSystemGroupAssociationsList`: []GraphConnection
fmt.Fprintf(os.Stdout, "Response from `SystemGroupAssociationsApi.GraphSystemGroupAssociationsList`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | ObjectID of the System Group. |
Other parameters are passed through a pointer to a apiGraphSystemGroupAssociationsListRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
targets | []string | Targets which a "system_group" can be associated 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] xOrgId | string | Organization identifier that can be obtained from console settings. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GraphSystemGroupAssociationsPost(ctx, groupId).XOrgId(xOrgId).Body(body).Execute()
Manage the associations of a System Group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)
func main() {
groupId := "groupId_example" // string | ObjectID of the System Group.
xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
body := *openapiclient.NewGraphOperationSystemGroup("Id_example", "Op_example", "Type_example") // GraphOperationSystemGroup | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.SystemGroupAssociationsApi.GraphSystemGroupAssociationsPost(context.Background(), groupId).XOrgId(xOrgId).Body(body).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SystemGroupAssociationsApi.GraphSystemGroupAssociationsPost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | ObjectID of the System Group. |
Other parameters are passed through a pointer to a apiGraphSystemGroupAssociationsPostRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
xOrgId | string | Organization identifier that can be obtained from console settings. | body | GraphOperationSystemGroup | |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]GraphObjectWithPaths GraphSystemGroupTraverseCommand(ctx, groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
List the Commands bound to a System Group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)
func main() {
groupId := "groupId_example" // string | ObjectID of the System Group.
limit := int32(56) // int32 | The number of records to return at once. Limited to 100. (optional) (default to 10)
xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
skip := int32(56) // int32 | The offset into the records to return. (optional) (default to 0)
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.SystemGroupAssociationsApi.GraphSystemGroupTraverseCommand(context.Background(), groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SystemGroupAssociationsApi.GraphSystemGroupTraverseCommand``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GraphSystemGroupTraverseCommand`: []GraphObjectWithPaths
fmt.Fprintf(os.Stdout, "Response from `SystemGroupAssociationsApi.GraphSystemGroupTraverseCommand`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | ObjectID of the System Group. |
Other parameters are passed through a pointer to a apiGraphSystemGroupTraverseCommandRequest 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] xOrgId | string | Organization identifier that can be obtained from console settings. | skip | int32 | The offset into the records to return. | [default to 0] 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 []]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]GraphObjectWithPaths GraphSystemGroupTraversePolicy(ctx, groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
List the Policies bound to a System Group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)
func main() {
groupId := "groupId_example" // string | ObjectID of the System Group.
limit := int32(56) // int32 | The number of records to return at once. Limited to 100. (optional) (default to 10)
xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
skip := int32(56) // int32 | The offset into the records to return. (optional) (default to 0)
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.SystemGroupAssociationsApi.GraphSystemGroupTraversePolicy(context.Background(), groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SystemGroupAssociationsApi.GraphSystemGroupTraversePolicy``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GraphSystemGroupTraversePolicy`: []GraphObjectWithPaths
fmt.Fprintf(os.Stdout, "Response from `SystemGroupAssociationsApi.GraphSystemGroupTraversePolicy`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | ObjectID of the System Group. |
Other parameters are passed through a pointer to a apiGraphSystemGroupTraversePolicyRequest 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] xOrgId | string | Organization identifier that can be obtained from console settings. | skip | int32 | The offset into the records to return. | [default to 0] 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 []]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]GraphObjectWithPaths GraphSystemGroupTraversePolicyGroup(ctx, groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
List the Policy Groups bound to a System Group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)
func main() {
groupId := "groupId_example" // string | ObjectID of the System Group.
limit := int32(56) // int32 | The number of records to return at once. Limited to 100. (optional) (default to 10)
xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
skip := int32(56) // int32 | The offset into the records to return. (optional) (default to 0)
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.SystemGroupAssociationsApi.GraphSystemGroupTraversePolicyGroup(context.Background(), groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SystemGroupAssociationsApi.GraphSystemGroupTraversePolicyGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GraphSystemGroupTraversePolicyGroup`: []GraphObjectWithPaths
fmt.Fprintf(os.Stdout, "Response from `SystemGroupAssociationsApi.GraphSystemGroupTraversePolicyGroup`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | ObjectID of the System Group. |
Other parameters are passed through a pointer to a apiGraphSystemGroupTraversePolicyGroupRequest 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] xOrgId | string | Organization identifier that can be obtained from console settings. | skip | int32 | The offset into the records to return. | [default to 0] 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 []]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]GraphObjectWithPaths GraphSystemGroupTraverseUser(ctx, groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
List the Users bound to a System Group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)
func main() {
groupId := "groupId_example" // string | ObjectID of the System Group.
limit := int32(56) // int32 | The number of records to return at once. Limited to 100. (optional) (default to 10)
xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
skip := int32(56) // int32 | The offset into the records to return. (optional) (default to 0)
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.SystemGroupAssociationsApi.GraphSystemGroupTraverseUser(context.Background(), groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SystemGroupAssociationsApi.GraphSystemGroupTraverseUser``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GraphSystemGroupTraverseUser`: []GraphObjectWithPaths
fmt.Fprintf(os.Stdout, "Response from `SystemGroupAssociationsApi.GraphSystemGroupTraverseUser`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | ObjectID of the System Group. |
Other parameters are passed through a pointer to a apiGraphSystemGroupTraverseUserRequest 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] xOrgId | string | Organization identifier that can be obtained from console settings. | skip | int32 | The offset into the records to return. | [default to 0] 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 []]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]GraphObjectWithPaths GraphSystemGroupTraverseUserGroup(ctx, groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
List the User Groups bound to a System Group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)
func main() {
groupId := "groupId_example" // string | ObjectID of the System Group.
limit := int32(56) // int32 | The number of records to return at once. Limited to 100. (optional) (default to 10)
xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
skip := int32(56) // int32 | The offset into the records to return. (optional) (default to 0)
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.SystemGroupAssociationsApi.GraphSystemGroupTraverseUserGroup(context.Background(), groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SystemGroupAssociationsApi.GraphSystemGroupTraverseUserGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GraphSystemGroupTraverseUserGroup`: []GraphObjectWithPaths
fmt.Fprintf(os.Stdout, "Response from `SystemGroupAssociationsApi.GraphSystemGroupTraverseUserGroup`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | ObjectID of the System Group. |
Other parameters are passed through a pointer to a apiGraphSystemGroupTraverseUserGroupRequest 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] xOrgId | string | Organization identifier that can be obtained from console settings. | skip | int32 | The offset into the records to return. | [default to 0] 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 []]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]