Skip to content

Latest commit

 

History

History
1255 lines (832 loc) · 52.2 KB

UsersApi.md

File metadata and controls

1255 lines (832 loc) · 52.2 KB
Raw

\UsersApi

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

Method HTTP request Description
GraphUserAssociationsList Get /users/{user_id}/associations List the associations of a User
GraphUserAssociationsPost Post /users/{user_id}/associations Manage the associations of a User
GraphUserMemberOf Get /users/{user_id}/memberof List the parent Groups of a User
GraphUserTraverseActiveDirectory Get /users/{user_id}/activedirectories List the Active Directory instances bound to a User
GraphUserTraverseApplication Get /users/{user_id}/applications List the Applications bound to a User
GraphUserTraverseDirectory Get /users/{user_id}/directories List the Directories bound to a User
GraphUserTraverseGSuite Get /users/{user_id}/gsuites List the G Suite instances bound to a User
GraphUserTraverseLdapServer Get /users/{user_id}/ldapservers List the LDAP servers bound to a User
GraphUserTraverseOffice365 Get /users/{user_id}/office365s List the Office 365 instances bound to a User
GraphUserTraverseRadiusServer Get /users/{user_id}/radiusservers List the RADIUS Servers bound to a User
GraphUserTraverseSystem Get /users/{user_id}/systems List the Systems bound to a User
GraphUserTraverseSystemGroup Get /users/{user_id}/systemgroups List the System Groups bound to a User
PushEndpointsDelete Delete /users/{user_id}/pushendpoints/{push_endpoint_id} Delete a Push Endpoint associated with a User
PushEndpointsGet Get /users/{user_id}/pushendpoints/{push_endpoint_id} Get a push endpoint associated with a User
PushEndpointsList Get /users/{user_id}/pushendpoints List Push Endpoints associated with a User
PushEndpointsPatch Patch /users/{user_id}/pushendpoints/{push_endpoint_id} Update a push endpoint associated with a User

GraphUserAssociationsList

[]GraphConnection GraphUserAssociationsList(ctx, userId).Targets(targets).Limit(limit).Skip(skip).XOrgId(xOrgId).Execute()

List the associations of a User

Example

package main

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

func main() {
    userId := "userId_example" // string | ObjectID of the User.
    targets := []string{"Targets_example"} // []string | Targets which a \"user\" 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.UsersApi.GraphUserAssociationsList(context.Background(), userId).Targets(targets).Limit(limit).Skip(skip).XOrgId(xOrgId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.GraphUserAssociationsList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GraphUserAssociationsList`: []GraphConnection
    fmt.Fprintf(os.Stdout, "Response from `UsersApi.GraphUserAssociationsList`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId string ObjectID of the User.

Other Parameters

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

Name Type Description Notes

targets | []string | Targets which a "user" 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. |

Return type

[]GraphConnection

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]

GraphUserAssociationsPost

GraphUserAssociationsPost(ctx, userId).XOrgId(xOrgId).Body(body).Execute()

Manage the associations of a User

Example

package main

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

func main() {
    userId := "userId_example" // string | ObjectID of the User.
    xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
    body := *openapiclient.NewGraphOperationUser("Id_example", "Op_example", "Type_example") // GraphOperationUser |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.UsersApi.GraphUserAssociationsPost(context.Background(), userId).XOrgId(xOrgId).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.GraphUserAssociationsPost``: %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.
userId string ObjectID of the User.

Other Parameters

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

Name Type Description Notes

xOrgId | string | Organization identifier that can be obtained from console settings. | body | GraphOperationUser | |

Return type

(empty response body)

Authorization

x-api-key

HTTP request headers

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

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

GraphUserMemberOf

[]GraphObjectWithPaths GraphUserMemberOf(ctx, userId).Filter(filter).Limit(limit).Skip(skip).Sort(sort).XOrgId(xOrgId).Execute()

List the parent Groups of a User

Example

package main

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

func main() {
    userId := "userId_example" // string | ObjectID of the User.
    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 [])
    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.UsersApi.GraphUserMemberOf(context.Background(), userId).Filter(filter).Limit(limit).Skip(skip).Sort(sort).XOrgId(xOrgId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.GraphUserMemberOf``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GraphUserMemberOf`: []GraphObjectWithPaths
    fmt.Fprintf(os.Stdout, "Response from `UsersApi.GraphUserMemberOf`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId string ObjectID of the User.

Other Parameters

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

Name Type Description Notes

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 []] xOrgId | string | Organization identifier that can be obtained from console settings. |

Return type

[]GraphObjectWithPaths

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]

GraphUserTraverseActiveDirectory

[]GraphObjectWithPaths GraphUserTraverseActiveDirectory(ctx, userId).Filter(filter).Limit(limit).XOrgId(xOrgId).Skip(skip).Execute()

List the Active Directory instances bound to a User

Example

package main

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

func main() {
    userId := "userId_example" // string | ObjectID of the User.
    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)
    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)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId string ObjectID of the User.

Other Parameters

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

Name Type Description Notes

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] xOrgId | string | Organization identifier that can be obtained from console settings. | skip | int32 | The offset into the records to return. | [default to 0]

Return type

[]GraphObjectWithPaths

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]

GraphUserTraverseApplication

[]GraphObjectWithPaths GraphUserTraverseApplication(ctx, userId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()

List the Applications bound to a User

Example

package main

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

func main() {
    userId := "userId_example" // string | ObjectID of the User.
    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.UsersApi.GraphUserTraverseApplication(context.Background(), userId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.GraphUserTraverseApplication``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GraphUserTraverseApplication`: []GraphObjectWithPaths
    fmt.Fprintf(os.Stdout, "Response from `UsersApi.GraphUserTraverseApplication`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId string ObjectID of the User.

Other Parameters

Other parameters are passed through a pointer to a apiGraphUserTraverseApplicationRequest 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 []]

Return type

[]GraphObjectWithPaths

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]

GraphUserTraverseDirectory

[]GraphObjectWithPaths GraphUserTraverseDirectory(ctx, userId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()

List the Directories bound to a User

Example

package main

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

func main() {
    userId := "userId_example" // string | ObjectID of the User.
    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.UsersApi.GraphUserTraverseDirectory(context.Background(), userId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.GraphUserTraverseDirectory``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GraphUserTraverseDirectory`: []GraphObjectWithPaths
    fmt.Fprintf(os.Stdout, "Response from `UsersApi.GraphUserTraverseDirectory`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId string ObjectID of the User.

Other Parameters

Other parameters are passed through a pointer to a apiGraphUserTraverseDirectoryRequest 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 []]

Return type

[]GraphObjectWithPaths

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]

GraphUserTraverseGSuite

[]GraphObjectWithPaths GraphUserTraverseGSuite(ctx, userId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()

List the G Suite instances bound to a User

Example

package main

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

func main() {
    userId := "userId_example" // string | ObjectID of the User.
    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.UsersApi.GraphUserTraverseGSuite(context.Background(), userId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.GraphUserTraverseGSuite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GraphUserTraverseGSuite`: []GraphObjectWithPaths
    fmt.Fprintf(os.Stdout, "Response from `UsersApi.GraphUserTraverseGSuite`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId string ObjectID of the User.

Other Parameters

Other parameters are passed through a pointer to a apiGraphUserTraverseGSuiteRequest 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 []]

Return type

[]GraphObjectWithPaths

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]

GraphUserTraverseLdapServer

[]GraphObjectWithPaths GraphUserTraverseLdapServer(ctx, userId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()

List the LDAP servers bound to a User

Example

package main

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

func main() {
    userId := "userId_example" // string | ObjectID of the User.
    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.UsersApi.GraphUserTraverseLdapServer(context.Background(), userId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.GraphUserTraverseLdapServer``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GraphUserTraverseLdapServer`: []GraphObjectWithPaths
    fmt.Fprintf(os.Stdout, "Response from `UsersApi.GraphUserTraverseLdapServer`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId string ObjectID of the User.

Other Parameters

Other parameters are passed through a pointer to a apiGraphUserTraverseLdapServerRequest 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 []]

Return type

[]GraphObjectWithPaths

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]

GraphUserTraverseOffice365

[]GraphObjectWithPaths GraphUserTraverseOffice365(ctx, userId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()

List the Office 365 instances bound to a User

Example

package main

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

func main() {
    userId := "userId_example" // string | ObjectID of the User.
    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.UsersApi.GraphUserTraverseOffice365(context.Background(), userId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.GraphUserTraverseOffice365``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GraphUserTraverseOffice365`: []GraphObjectWithPaths
    fmt.Fprintf(os.Stdout, "Response from `UsersApi.GraphUserTraverseOffice365`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId string ObjectID of the User.

Other Parameters

Other parameters are passed through a pointer to a apiGraphUserTraverseOffice365Request 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 []]

Return type

[]GraphObjectWithPaths

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]

GraphUserTraverseRadiusServer

[]GraphObjectWithPaths GraphUserTraverseRadiusServer(ctx, userId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()

List the RADIUS Servers bound to a User

Example

package main

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

func main() {
    userId := "userId_example" // string | ObjectID of the User.
    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.UsersApi.GraphUserTraverseRadiusServer(context.Background(), userId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.GraphUserTraverseRadiusServer``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GraphUserTraverseRadiusServer`: []GraphObjectWithPaths
    fmt.Fprintf(os.Stdout, "Response from `UsersApi.GraphUserTraverseRadiusServer`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId string ObjectID of the User.

Other Parameters

Other parameters are passed through a pointer to a apiGraphUserTraverseRadiusServerRequest 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 []]

Return type

[]GraphObjectWithPaths

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]

GraphUserTraverseSystem

[]GraphObjectWithPaths GraphUserTraverseSystem(ctx, userId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()

List the Systems bound to a User

Example

package main

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

func main() {
    userId := "userId_example" // string | ObjectID of the User.
    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.UsersApi.GraphUserTraverseSystem(context.Background(), userId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.GraphUserTraverseSystem``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GraphUserTraverseSystem`: []GraphObjectWithPaths
    fmt.Fprintf(os.Stdout, "Response from `UsersApi.GraphUserTraverseSystem`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId string ObjectID of the User.

Other Parameters

Other parameters are passed through a pointer to a apiGraphUserTraverseSystemRequest 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 []]

Return type

[]GraphObjectWithPaths

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]

GraphUserTraverseSystemGroup

[]GraphObjectWithPaths GraphUserTraverseSystemGroup(ctx, userId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()

List the System Groups bound to a User

Example

package main

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

func main() {
    userId := "userId_example" // string | ObjectID of the User.
    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.UsersApi.GraphUserTraverseSystemGroup(context.Background(), userId).Limit(limit).XOrgId(xOrgId).Skip(skip).Filter(filter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.GraphUserTraverseSystemGroup``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GraphUserTraverseSystemGroup`: []GraphObjectWithPaths
    fmt.Fprintf(os.Stdout, "Response from `UsersApi.GraphUserTraverseSystemGroup`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId string ObjectID of the User.

Other Parameters

Other parameters are passed through a pointer to a apiGraphUserTraverseSystemGroupRequest 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 []]

Return type

[]GraphObjectWithPaths

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]

PushEndpointsDelete

PushEndpointResponse PushEndpointsDelete(ctx, userId, pushEndpointId).XOrgId(xOrgId).Execute()

Delete a Push Endpoint associated with a User

Example

package main

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

func main() {
    userId := "userId_example" // string | 
    pushEndpointId := "pushEndpointId_example" // string | 
    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.UsersApi.PushEndpointsDelete(context.Background(), userId, pushEndpointId).XOrgId(xOrgId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.PushEndpointsDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PushEndpointsDelete`: PushEndpointResponse
    fmt.Fprintf(os.Stdout, "Response from `UsersApi.PushEndpointsDelete`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

xOrgId | string | Organization identifier that can be obtained from console settings. |

Return type

PushEndpointResponse

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]

PushEndpointsGet

PushEndpointResponse PushEndpointsGet(ctx, userId, pushEndpointId).XOrgId(xOrgId).Execute()

Get a push endpoint associated with a User

Example

package main

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

func main() {
    userId := "userId_example" // string | 
    pushEndpointId := "pushEndpointId_example" // string | 
    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.UsersApi.PushEndpointsGet(context.Background(), userId, pushEndpointId).XOrgId(xOrgId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.PushEndpointsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PushEndpointsGet`: PushEndpointResponse
    fmt.Fprintf(os.Stdout, "Response from `UsersApi.PushEndpointsGet`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

xOrgId | string | Organization identifier that can be obtained from console settings. |

Return type

PushEndpointResponse

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]

PushEndpointsList

[]PushEndpointResponse PushEndpointsList(ctx, userId).XOrgId(xOrgId).Execute()

List Push Endpoints associated with a User

Example

package main

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

func main() {
    userId := "userId_example" // string | 
    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.UsersApi.PushEndpointsList(context.Background(), userId).XOrgId(xOrgId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.PushEndpointsList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PushEndpointsList`: []PushEndpointResponse
    fmt.Fprintf(os.Stdout, "Response from `UsersApi.PushEndpointsList`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

xOrgId | string | Organization identifier that can be obtained from console settings. |

Return type

[]PushEndpointResponse

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]

PushEndpointsPatch

PushEndpointResponse PushEndpointsPatch(ctx, userId, pushEndpointId).XOrgId(xOrgId).Body(body).Execute()

Update a push endpoint associated with a User

Example

package main

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

func main() {
    userId := "userId_example" // string | 
    pushEndpointId := "pushEndpointId_example" // string | 
    xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
    body := *openapiclient.NewPushEndpointsPatchRequest() // PushEndpointsPatchRequest |  (optional)

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

xOrgId | string | Organization identifier that can be obtained from console settings. | body | PushEndpointsPatchRequest | |

Return type

PushEndpointResponse

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]