All URIs are relative to https://console.jumpcloud.com/api/v2
| Method | HTTP request | Description |
|---|---|---|
| GraphSystemGroupMembersList | Get /systemgroups/{group_id}/members | List the members of a System Group |
| GraphSystemGroupMembersPost | Post /systemgroups/{group_id}/members | Manage the members of a System Group |
| GraphSystemGroupMembership | Get /systemgroups/{group_id}/membership | List the System Group's membership |
[]GraphConnection GraphSystemGroupMembersList(ctx, groupId).Limit(limit).Skip(skip).XOrgId(xOrgId).Execute()
List the members 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.
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.SystemGroupMembersMembershipApi.GraphSystemGroupMembersList(context.Background(), groupId).Limit(limit).Skip(skip).XOrgId(xOrgId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SystemGroupMembersMembershipApi.GraphSystemGroupMembersList``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GraphSystemGroupMembersList`: []GraphConnection
fmt.Fprintf(os.Stdout, "Response from `SystemGroupMembersMembershipApi.GraphSystemGroupMembersList`: %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 apiGraphSystemGroupMembersListRequest 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] 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]
GraphSystemGroupMembersPost(ctx, groupId).Date(date).Authorization(authorization).XOrgId(xOrgId).Body(body).Execute()
Manage the members 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.
date := "date_example" // string | Current date header for the System Context API (optional)
authorization := "authorization_example" // string | Authorization header for the System Context API (optional)
xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
body := *openapiclient.NewGraphOperationSystemGroupMember("Id_example", "Op_example", "Type_example") // GraphOperationSystemGroupMember | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.SystemGroupMembersMembershipApi.GraphSystemGroupMembersPost(context.Background(), groupId).Date(date).Authorization(authorization).XOrgId(xOrgId).Body(body).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SystemGroupMembersMembershipApi.GraphSystemGroupMembersPost``: %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 apiGraphSystemGroupMembersPostRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
date | string | Current date header for the System Context API | authorization | string | Authorization header for the System Context API | xOrgId | string | Organization identifier that can be obtained from console settings. | body | GraphOperationSystemGroupMember | |
(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 GraphSystemGroupMembership(ctx, groupId).Limit(limit).Skip(skip).Sort(sort).Filter(filter).XOrgId(xOrgId).Execute()
List the System Group's membership
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)
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 [])
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 [])
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.SystemGroupMembersMembershipApi.GraphSystemGroupMembership(context.Background(), groupId).Limit(limit).Skip(skip).Sort(sort).Filter(filter).XOrgId(xOrgId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SystemGroupMembersMembershipApi.GraphSystemGroupMembership``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GraphSystemGroupMembership`: []GraphObjectWithPaths
fmt.Fprintf(os.Stdout, "Response from `SystemGroupMembersMembershipApi.GraphSystemGroupMembership`: %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 apiGraphSystemGroupMembershipRequest 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] sort | []string | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. | [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 []] 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]