Skip to content

Latest commit

 

History

History
543 lines (358 loc) · 21.7 KB

LDAPServersApi.md

File metadata and controls

543 lines (358 loc) · 21.7 KB
Raw

\LDAPServersApi

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

Method HTTP request Description
GraphLdapServerAssociationsList Get /ldapservers/{ldapserver_id}/associations List the associations of a LDAP Server
GraphLdapServerAssociationsPost Post /ldapservers/{ldapserver_id}/associations Manage the associations of a LDAP Server
GraphLdapServerTraverseUser Get /ldapservers/{ldapserver_id}/users List the Users bound to a LDAP Server
GraphLdapServerTraverseUserGroup Get /ldapservers/{ldapserver_id}/usergroups List the User Groups bound to a LDAP Server
LdapserversGet Get /ldapservers/{id} Get LDAP Server
LdapserversList Get /ldapservers List LDAP Servers
LdapserversPatch Patch /ldapservers/{id} Update existing LDAP server

GraphLdapServerAssociationsList

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

List the associations of a LDAP Server

Example

package main

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

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

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

GraphLdapServerAssociationsPost

GraphLdapServerAssociationsPost(ctx, ldapserverId).XOrgId(xOrgId).Body(body).Execute()

Manage the associations of a LDAP Server

Example

package main

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

func main() {
    ldapserverId := "ldapserverId_example" // string | ObjectID of the LDAP Server.
    xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
    body := *openapiclient.NewGraphOperationLdapServer("Id_example", "Op_example", "Type_example") // GraphOperationLdapServer |  (optional)

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

Other Parameters

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

Name Type Description Notes

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

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]

GraphLdapServerTraverseUser

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

List the Users bound to a LDAP Server

Example

package main

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

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

Path Parameters

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

Other Parameters

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

GraphLdapServerTraverseUserGroup

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

List the User Groups bound to a LDAP Server

Example

package main

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

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

Path Parameters

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

Other Parameters

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

LdapserversGet

LdapServer LdapserversGet(ctx, id).XOrgId(xOrgId).Execute()

Get LDAP Server

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 LDAP server.
    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.LDAPServersApi.LdapserversGet(context.Background(), id).XOrgId(xOrgId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LDAPServersApi.LdapserversGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `LdapserversGet`: LdapServer
    fmt.Fprintf(os.Stdout, "Response from `LDAPServersApi.LdapserversGet`: %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 LDAP server.

Other Parameters

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

Name Type Description Notes

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

Return type

LdapServer

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]

LdapserversList

[]LdapServer LdapserversList(ctx).Fields(fields).Filter(filter).Limit(limit).Skip(skip).Sort(sort).XOrgId(xOrgId).Execute()

List LDAP Servers

Example

package main

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

func main() {
    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 [])
    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.LDAPServersApi.LdapserversList(context.Background()).Fields(fields).Filter(filter).Limit(limit).Skip(skip).Sort(sort).XOrgId(xOrgId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LDAPServersApi.LdapserversList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `LdapserversList`: []LdapServer
    fmt.Fprintf(os.Stdout, "Response from `LDAPServersApi.LdapserversList`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiLdapserversListRequest 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 []]
xOrgId string Organization identifier that can be obtained from console settings.

Return type

[]LdapServer

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]

LdapserversPatch

LdapserversPatch200Response LdapserversPatch(ctx, id).XOrgId(xOrgId).Body(body).Execute()

Update existing LDAP server

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 LDAP server.
    xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
    body := *openapiclient.NewLdapserversPatchRequest() // LdapserversPatchRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LDAPServersApi.LdapserversPatch(context.Background(), id).XOrgId(xOrgId).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LDAPServersApi.LdapserversPatch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `LdapserversPatch`: LdapserversPatch200Response
    fmt.Fprintf(os.Stdout, "Response from `LDAPServersApi.LdapserversPatch`: %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 LDAP server.

Other Parameters

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

Name Type Description Notes

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

Return type

LdapserversPatch200Response

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]