Skip to content

Latest commit

 

History

History
930 lines (612 loc) · 35.7 KB

GSuiteApi.md

File metadata and controls

930 lines (612 loc) · 35.7 KB
Raw

\GSuiteApi

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

Method HTTP request Description
GraphGSuiteAssociationsList Get /gsuites/{gsuite_id}/associations List the associations of a G Suite instance
GraphGSuiteAssociationsPost Post /gsuites/{gsuite_id}/associations Manage the associations of a G Suite instance
GraphGSuiteTraverseUser Get /gsuites/{gsuite_id}/users List the Users bound to a G Suite instance
GraphGSuiteTraverseUserGroup Get /gsuites/{gsuite_id}/usergroups List the User Groups bound to a G Suite instance
GsuitesGet Get /gsuites/{id} Get G Suite
GsuitesListImportJumpcloudUsers Get /gsuites/{gsuite_id}/import/jumpcloudusers Get a list of users in Jumpcloud format to import from a Google Workspace account.
GsuitesListImportUsers Get /gsuites/{gsuite_id}/import/users Get a list of users to import from a G Suite instance
GsuitesPatch Patch /gsuites/{id} Update existing G Suite
TranslationRulesGSuiteDelete Delete /gsuites/{gsuite_id}/translationrules/{id} Deletes a G Suite translation rule
TranslationRulesGSuiteGet Get /gsuites/{gsuite_id}/translationrules/{id} Gets a specific G Suite translation rule
TranslationRulesGSuiteList Get /gsuites/{gsuite_id}/translationrules List all the G Suite Translation Rules
TranslationRulesGSuitePost Post /gsuites/{gsuite_id}/translationrules Create a new G Suite Translation Rule

GraphGSuiteAssociationsList

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

List the associations of a G Suite instance

Example

package main

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

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
gsuiteId string ObjectID of the G Suite instance.

Other Parameters

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

Name Type Description Notes

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

GraphGSuiteAssociationsPost

GraphGSuiteAssociationsPost(ctx, gsuiteId).XOrgId(xOrgId).Body(body).Execute()

Manage the associations of a G Suite instance

Example

package main

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

func main() {
    gsuiteId := "gsuiteId_example" // string | ObjectID of the G Suite instance.
    xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
    body := *openapiclient.NewGraphOperationGSuite("Id_example", "Op_example", "Type_example") // GraphOperationGSuite |  (optional)

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

Other Parameters

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

Name Type Description Notes

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

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]

GraphGSuiteTraverseUser

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

List the Users bound to a G Suite instance

Example

package main

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

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
gsuiteId string ObjectID of the G Suite instance.

Other Parameters

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

GraphGSuiteTraverseUserGroup

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

List the User Groups bound to a G Suite instance

Example

package main

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

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
gsuiteId string ObjectID of the G Suite instance.

Other Parameters

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

GsuitesGet

Gsuite GsuitesGet(ctx, id).XOrgId(xOrgId).Execute()

Get G Suite

Example

package main

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

func main() {
    id := "id_example" // string | Unique identifier of the GSuite.
    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.GSuiteApi.GsuitesGet(context.Background(), id).XOrgId(xOrgId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `GSuiteApi.GsuitesGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GsuitesGet`: Gsuite
    fmt.Fprintf(os.Stdout, "Response from `GSuiteApi.GsuitesGet`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Unique identifier of the GSuite.

Other Parameters

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

Name Type Description Notes

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

Return type

Gsuite

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]

GsuitesListImportJumpcloudUsers

GsuitesListImportJumpcloudUsers200Response GsuitesListImportJumpcloudUsers(ctx, gsuiteId).MaxResults(maxResults).OrderBy(orderBy).PageToken(pageToken).Query(query).SortOrder(sortOrder).Execute()

Get a list of users in Jumpcloud format to import from a Google Workspace account.

Example

package main

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

func main() {
    gsuiteId := "gsuiteId_example" // string | 
    maxResults := int32(56) // int32 | Google Directory API maximum number of results per page. See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. (optional)
    orderBy := "orderBy_example" // string | Google Directory API sort field parameter. See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. (optional)
    pageToken := "pageToken_example" // string | Google Directory API token used to access the next page of results. See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. (optional)
    query := "query_example" // string | Google Directory API search parameter. See https://developers.google.com/admin-sdk/directory/v1/guides/search-users. (optional)
    sortOrder := "sortOrder_example" // string | Google Directory API sort direction parameter. See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.GSuiteApi.GsuitesListImportJumpcloudUsers(context.Background(), gsuiteId).MaxResults(maxResults).OrderBy(orderBy).PageToken(pageToken).Query(query).SortOrder(sortOrder).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `GSuiteApi.GsuitesListImportJumpcloudUsers``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GsuitesListImportJumpcloudUsers`: GsuitesListImportJumpcloudUsers200Response
    fmt.Fprintf(os.Stdout, "Response from `GSuiteApi.GsuitesListImportJumpcloudUsers`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

maxResults | int32 | Google Directory API maximum number of results per page. See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. | orderBy | string | Google Directory API sort field parameter. See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. | pageToken | string | Google Directory API token used to access the next page of results. See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. | query | string | Google Directory API search parameter. See https://developers.google.com/admin-sdk/directory/v1/guides/search-users. | sortOrder | string | Google Directory API sort direction parameter. See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. |

Return type

GsuitesListImportJumpcloudUsers200Response

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]

GsuitesListImportUsers

GsuitesListImportUsers200Response GsuitesListImportUsers(ctx, gsuiteId).Limit(limit).MaxResults(maxResults).OrderBy(orderBy).PageToken(pageToken).Query(query).SortOrder(sortOrder).Execute()

Get a list of users to import from a G Suite instance

Example

package main

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

func main() {
    gsuiteId := "gsuiteId_example" // string | 
    limit := int32(56) // int32 | The number of records to return at once. Limited to 100. (optional) (default to 10)
    maxResults := int32(56) // int32 | Google Directory API maximum number of results per page. See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. (optional)
    orderBy := "orderBy_example" // string | Google Directory API sort field parameter. See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. (optional)
    pageToken := "pageToken_example" // string | Google Directory API token used to access the next page of results. See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. (optional)
    query := "query_example" // string | Google Directory API search parameter. See https://developers.google.com/admin-sdk/directory/v1/guides/search-users. (optional)
    sortOrder := "sortOrder_example" // string | Google Directory API sort direction parameter. See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.GSuiteApi.GsuitesListImportUsers(context.Background(), gsuiteId).Limit(limit).MaxResults(maxResults).OrderBy(orderBy).PageToken(pageToken).Query(query).SortOrder(sortOrder).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `GSuiteApi.GsuitesListImportUsers``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GsuitesListImportUsers`: GsuitesListImportUsers200Response
    fmt.Fprintf(os.Stdout, "Response from `GSuiteApi.GsuitesListImportUsers`: %v\n", resp)
}

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiGsuitesListImportUsersRequest 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] maxResults | int32 | Google Directory API maximum number of results per page. See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. | orderBy | string | Google Directory API sort field parameter. See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. | pageToken | string | Google Directory API token used to access the next page of results. See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. | query | string | Google Directory API search parameter. See https://developers.google.com/admin-sdk/directory/v1/guides/search-users. | sortOrder | string | Google Directory API sort direction parameter. See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. |

Return type

GsuitesListImportUsers200Response

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]

GsuitesPatch

Gsuite GsuitesPatch(ctx, id).XOrgId(xOrgId).Body(body).Execute()

Update existing G Suite

Example

package main

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

func main() {
    id := "id_example" // string | Unique identifier of the GSuite.
    xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
    body := *openapiclient.NewGsuite() // Gsuite |  (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Unique identifier of the GSuite.

Other Parameters

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

Name Type Description Notes

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

Return type

Gsuite

Authorization

No authorization required

HTTP request headers

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

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

TranslationRulesGSuiteDelete

TranslationRulesGSuiteDelete(ctx, gsuiteId, id).Execute()

Deletes a G Suite translation rule

Example

package main

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

func main() {
    gsuiteId := "gsuiteId_example" // string | 
    id := "id_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.GSuiteApi.TranslationRulesGSuiteDelete(context.Background(), gsuiteId, id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `GSuiteApi.TranslationRulesGSuiteDelete``: %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.
gsuiteId string
id string

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

x-api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

TranslationRulesGSuiteGet

GSuiteTranslationRule TranslationRulesGSuiteGet(ctx, gsuiteId, id).Execute()

Gets a specific G Suite translation rule

Example

package main

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

func main() {
    gsuiteId := "gsuiteId_example" // string | 
    id := "id_example" // string | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

GSuiteTranslationRule

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]

TranslationRulesGSuiteList

[]GSuiteTranslationRule TranslationRulesGSuiteList(ctx, gsuiteId).Fields(fields).Filter(filter).Limit(limit).Skip(skip).Sort(sort).Execute()

List all the G Suite Translation Rules

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

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

Return type

[]GSuiteTranslationRule

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]

TranslationRulesGSuitePost

GSuiteTranslationRule TranslationRulesGSuitePost(ctx, gsuiteId).Body(body).Execute()

Create a new G Suite Translation Rule

Example

package main

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

func main() {
    gsuiteId := "gsuiteId_example" // string | 
    body := *openapiclient.NewGSuiteTranslationRuleRequest() // GSuiteTranslationRuleRequest |  (optional)

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

body | GSuiteTranslationRuleRequest | |

Return type

GSuiteTranslationRule

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]