All URIs are relative to https://console.jumpcloud.com/api/v2
| Method | HTTP request | Description |
|---|---|---|
| GraphUserGroupAssociationsList | Get /usergroups/{group_id}/associations | List the associations of a User Group. |
| GraphUserGroupAssociationsPost | Post /usergroups/{group_id}/associations | Manage the associations of a User Group |
| GraphUserGroupTraverseActiveDirectory | Get /usergroups/{group_id}/activedirectories | List the Active Directories bound to a User Group |
| GraphUserGroupTraverseApplication | Get /usergroups/{group_id}/applications | List the Applications bound to a User Group |
| GraphUserGroupTraverseDirectory | Get /usergroups/{group_id}/directories | List the Directories bound to a User Group |
| GraphUserGroupTraverseGSuite | Get /usergroups/{group_id}/gsuites | List the G Suite instances bound to a User Group |
| GraphUserGroupTraverseLdapServer | Get /usergroups/{group_id}/ldapservers | List the LDAP Servers bound to a User Group |
| GraphUserGroupTraverseOffice365 | Get /usergroups/{group_id}/office365s | List the Office 365 instances bound to a User Group |
| GraphUserGroupTraverseRadiusServer | Get /usergroups/{group_id}/radiusservers | List the RADIUS Servers bound to a User Group |
| GraphUserGroupTraverseSystem | Get /usergroups/{group_id}/systems | List the Systems bound to a User Group |
| GraphUserGroupTraverseSystemGroup | Get /usergroups/{group_id}/systemgroups | List the System Groups bound to User Groups |
[]GraphConnection GraphUserGroupAssociationsList(ctx, groupId).Targets(targets).Limit(limit).Skip(skip).XOrgId(xOrgId).Execute()
List the associations of a User Group.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)
func main() {
groupId := "groupId_example" // string | ObjectID of the User Group.
targets := []string{"Targets_example"} // []string | Targets which a \"user_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.UserGroupAssociationsApi.GraphUserGroupAssociationsList(context.Background(), groupId).Targets(targets).Limit(limit).Skip(skip).XOrgId(xOrgId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserGroupAssociationsApi.GraphUserGroupAssociationsList``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GraphUserGroupAssociationsList`: []GraphConnection
fmt.Fprintf(os.Stdout, "Response from `UserGroupAssociationsApi.GraphUserGroupAssociationsList`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | ObjectID of the User Group. |
Other parameters are passed through a pointer to a apiGraphUserGroupAssociationsListRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
targets | []string | Targets which a "user_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]
GraphUserGroupAssociationsPost(ctx, groupId).XOrgId(xOrgId).Body(body).Execute()
Manage the associations of a User Group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)
func main() {
groupId := "groupId_example" // string | ObjectID of the User Group.
xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
body := *openapiclient.NewGraphOperationUserGroup("Id_example", "Op_example", "Type_example") // GraphOperationUserGroup | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.UserGroupAssociationsApi.GraphUserGroupAssociationsPost(context.Background(), groupId).XOrgId(xOrgId).Body(body).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserGroupAssociationsApi.GraphUserGroupAssociationsPost``: %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 User Group. |
Other parameters are passed through a pointer to a apiGraphUserGroupAssociationsPostRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
xOrgId | string | Organization identifier that can be obtained from console settings. | body | GraphOperationUserGroup | |
(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 GraphUserGroupTraverseActiveDirectory(ctx, groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
List the Active Directories bound to a User Group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)
func main() {
groupId := "groupId_example" // string | ObjectID of the User 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.UserGroupAssociationsApi.GraphUserGroupTraverseActiveDirectory(context.Background(), groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserGroupAssociationsApi.GraphUserGroupTraverseActiveDirectory``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GraphUserGroupTraverseActiveDirectory`: []GraphObjectWithPaths
fmt.Fprintf(os.Stdout, "Response from `UserGroupAssociationsApi.GraphUserGroupTraverseActiveDirectory`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | ObjectID of the User Group. |
Other parameters are passed through a pointer to a apiGraphUserGroupTraverseActiveDirectoryRequest 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 GraphUserGroupTraverseApplication(ctx, groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
List the Applications bound to a User Group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)
func main() {
groupId := "groupId_example" // string | ObjectID of the User 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.UserGroupAssociationsApi.GraphUserGroupTraverseApplication(context.Background(), groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserGroupAssociationsApi.GraphUserGroupTraverseApplication``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GraphUserGroupTraverseApplication`: []GraphObjectWithPaths
fmt.Fprintf(os.Stdout, "Response from `UserGroupAssociationsApi.GraphUserGroupTraverseApplication`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | ObjectID of the User Group. |
Other parameters are passed through a pointer to a apiGraphUserGroupTraverseApplicationRequest 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 GraphUserGroupTraverseDirectory(ctx, groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
List the Directories bound to a User Group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)
func main() {
groupId := "groupId_example" // string | ObjectID of the User 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.UserGroupAssociationsApi.GraphUserGroupTraverseDirectory(context.Background(), groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserGroupAssociationsApi.GraphUserGroupTraverseDirectory``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GraphUserGroupTraverseDirectory`: []GraphObjectWithPaths
fmt.Fprintf(os.Stdout, "Response from `UserGroupAssociationsApi.GraphUserGroupTraverseDirectory`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | ObjectID of the User Group. |
Other parameters are passed through a pointer to a apiGraphUserGroupTraverseDirectoryRequest 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 GraphUserGroupTraverseGSuite(ctx, groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
List the G Suite instances bound to a User Group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)
func main() {
groupId := "groupId_example" // string | ObjectID of the User 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.UserGroupAssociationsApi.GraphUserGroupTraverseGSuite(context.Background(), groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserGroupAssociationsApi.GraphUserGroupTraverseGSuite``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GraphUserGroupTraverseGSuite`: []GraphObjectWithPaths
fmt.Fprintf(os.Stdout, "Response from `UserGroupAssociationsApi.GraphUserGroupTraverseGSuite`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | ObjectID of the User Group. |
Other parameters are passed through a pointer to a apiGraphUserGroupTraverseGSuiteRequest 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 GraphUserGroupTraverseLdapServer(ctx, groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
List the LDAP Servers bound to a User Group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)
func main() {
groupId := "groupId_example" // string | ObjectID of the User 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.UserGroupAssociationsApi.GraphUserGroupTraverseLdapServer(context.Background(), groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserGroupAssociationsApi.GraphUserGroupTraverseLdapServer``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GraphUserGroupTraverseLdapServer`: []GraphObjectWithPaths
fmt.Fprintf(os.Stdout, "Response from `UserGroupAssociationsApi.GraphUserGroupTraverseLdapServer`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | ObjectID of the User Group. |
Other parameters are passed through a pointer to a apiGraphUserGroupTraverseLdapServerRequest 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 GraphUserGroupTraverseOffice365(ctx, groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
List the Office 365 instances bound to a User Group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)
func main() {
groupId := "groupId_example" // string | ObjectID of the User 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.UserGroupAssociationsApi.GraphUserGroupTraverseOffice365(context.Background(), groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserGroupAssociationsApi.GraphUserGroupTraverseOffice365``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GraphUserGroupTraverseOffice365`: []GraphObjectWithPaths
fmt.Fprintf(os.Stdout, "Response from `UserGroupAssociationsApi.GraphUserGroupTraverseOffice365`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | ObjectID of the User Group. |
Other parameters are passed through a pointer to a apiGraphUserGroupTraverseOffice365Request 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 GraphUserGroupTraverseRadiusServer(ctx, groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
List the RADIUS Servers bound to a User Group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)
func main() {
groupId := "groupId_example" // string | ObjectID of the User 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.UserGroupAssociationsApi.GraphUserGroupTraverseRadiusServer(context.Background(), groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserGroupAssociationsApi.GraphUserGroupTraverseRadiusServer``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GraphUserGroupTraverseRadiusServer`: []GraphObjectWithPaths
fmt.Fprintf(os.Stdout, "Response from `UserGroupAssociationsApi.GraphUserGroupTraverseRadiusServer`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | ObjectID of the User Group. |
Other parameters are passed through a pointer to a apiGraphUserGroupTraverseRadiusServerRequest 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 GraphUserGroupTraverseSystem(ctx, groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
List the Systems bound to a User Group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)
func main() {
groupId := "groupId_example" // string | ObjectID of the User 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.UserGroupAssociationsApi.GraphUserGroupTraverseSystem(context.Background(), groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserGroupAssociationsApi.GraphUserGroupTraverseSystem``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GraphUserGroupTraverseSystem`: []GraphObjectWithPaths
fmt.Fprintf(os.Stdout, "Response from `UserGroupAssociationsApi.GraphUserGroupTraverseSystem`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | ObjectID of the User Group. |
Other parameters are passed through a pointer to a apiGraphUserGroupTraverseSystemRequest 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 GraphUserGroupTraverseSystemGroup(ctx, groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
List the System Groups bound to User Groups
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)
func main() {
groupId := "groupId_example" // string | ObjectID of the User 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.UserGroupAssociationsApi.GraphUserGroupTraverseSystemGroup(context.Background(), groupId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserGroupAssociationsApi.GraphUserGroupTraverseSystemGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GraphUserGroupTraverseSystemGroup`: []GraphObjectWithPaths
fmt.Fprintf(os.Stdout, "Response from `UserGroupAssociationsApi.GraphUserGroupTraverseSystemGroup`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | ObjectID of the User Group. |
Other parameters are passed through a pointer to a apiGraphUserGroupTraverseSystemGroupRequest 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]