Skip to content

Latest commit

 

History

History
333 lines (249 loc) · 15 KB

SambaDomainsApi.md

File metadata and controls

333 lines (249 loc) · 15 KB

jcapiv2.SambaDomainsApi

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

Method HTTP request Description
ldapservers_samba_domains_delete DELETE /ldapservers/{ldapserver_id}/sambadomains/{id} Delete Samba Domain
ldapservers_samba_domains_get GET /ldapservers/{ldapserver_id}/sambadomains/{id} Get Samba Domain
ldapservers_samba_domains_list GET /ldapservers/{ldapserver_id}/sambadomains List Samba Domains
ldapservers_samba_domains_post POST /ldapservers/{ldapserver_id}/sambadomains Create Samba Domain
ldapservers_samba_domains_put PUT /ldapservers/{ldapserver_id}/sambadomains/{id} Update Samba Domain

ldapservers_samba_domains_delete

str ldapservers_samba_domains_delete(ldapserver_id, id, content_type=content_type, accept=accept, x_org_id=x_org_id)

Delete Samba Domain

This endpoint allows you to delete a samba domain from an LDAP server. ##### Sample Request curl -X DELETE https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

from __future__ import print_function
import time
import jcapiv2
from jcapiv2.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = jcapiv2.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = jcapiv2.SambaDomainsApi(jcapiv2.ApiClient(configuration))
ldapserver_id = 'ldapserver_id_example' # str | Unique identifier of the LDAP server.
id = 'id_example' # str | Unique identifier of the samba domain.
content_type = 'application/json' # str |  (optional) (default to application/json)
accept = 'application/json' # str |  (optional) (default to application/json)
x_org_id = '' # str |  (optional) (default to )

try:
    # Delete Samba Domain
    api_response = api_instance.ldapservers_samba_domains_delete(ldapserver_id, id, content_type=content_type, accept=accept, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SambaDomainsApi->ldapservers_samba_domains_delete: %s\n" % e)

Parameters

Name Type Description Notes
ldapserver_id str Unique identifier of the LDAP server.
id str Unique identifier of the samba domain.
content_type str [optional] [default to application/json]
accept str [optional] [default to application/json]
x_org_id str [optional] [default to ]

Return type

str

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]

ldapservers_samba_domains_get

SambaDomainOutput ldapservers_samba_domains_get(ldapserver_id, id, content_type=content_type, accept=accept, x_org_id=x_org_id)

Get Samba Domain

This endpoint returns a specific samba domain for an LDAP server. ##### Sample Request curl -X GET \\ https://console.jumpcloud.com/api/v2/ldapservers/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

from __future__ import print_function
import time
import jcapiv2
from jcapiv2.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = jcapiv2.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = jcapiv2.SambaDomainsApi(jcapiv2.ApiClient(configuration))
ldapserver_id = 'ldapserver_id_example' # str | Unique identifier of the LDAP server.
id = 'id_example' # str | Unique identifier of the samba domain.
content_type = 'application/json' # str |  (optional) (default to application/json)
accept = 'application/json' # str |  (optional) (default to application/json)
x_org_id = '' # str |  (optional) (default to )

try:
    # Get Samba Domain
    api_response = api_instance.ldapservers_samba_domains_get(ldapserver_id, id, content_type=content_type, accept=accept, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SambaDomainsApi->ldapservers_samba_domains_get: %s\n" % e)

Parameters

Name Type Description Notes
ldapserver_id str Unique identifier of the LDAP server.
id str Unique identifier of the samba domain.
content_type str [optional] [default to application/json]
accept str [optional] [default to application/json]
x_org_id str [optional] [default to ]

Return type

SambaDomainOutput

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]

ldapservers_samba_domains_list

list[SambaDomainOutput] ldapservers_samba_domains_list(ldapserver_id, content_type=content_type, accept=accept, fields=fields, filter=filter, limit=limit, skip=skip, sort=sort, x_org_id=x_org_id)

List Samba Domains

This endpoint returns all samba domains for an LDAP server. ##### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

from __future__ import print_function
import time
import jcapiv2
from jcapiv2.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = jcapiv2.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = jcapiv2.SambaDomainsApi(jcapiv2.ApiClient(configuration))
ldapserver_id = 'ldapserver_id_example' # str | Unique identifier of the LDAP server.
content_type = 'application/json' # str |  (optional) (default to application/json)
accept = 'application/json' # str |  (optional) (default to application/json)
fields = ['[]'] # list[str] | The comma separated fields included in the returned records. If omitted, the default list of fields will be returned.  (optional) (default to [])
filter = ['[]'] # list[str] | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in (optional) (default to [])
limit = 10 # int | The number of records to return at once. Limited to 100. (optional) (default to 10)
skip = 0 # int | The offset into the records to return. (optional) (default to 0)
sort = ['[]'] # list[str] | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.  (optional) (default to [])
x_org_id = '' # str |  (optional) (default to )

try:
    # List Samba Domains
    api_response = api_instance.ldapservers_samba_domains_list(ldapserver_id, content_type=content_type, accept=accept, fields=fields, filter=filter, limit=limit, skip=skip, sort=sort, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SambaDomainsApi->ldapservers_samba_domains_list: %s\n" % e)

Parameters

Name Type Description Notes
ldapserver_id str Unique identifier of the LDAP server.
content_type str [optional] [default to application/json]
accept str [optional] [default to application/json]
fields list[str] The comma separated fields included in the returned records. If omitted, the default list of fields will be returned. [optional] [default to []]
filter list[str] Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional] [default to []]
limit int The number of records to return at once. Limited to 100. [optional] [default to 10]
skip int The offset into the records to return. [optional] [default to 0]
sort list[str] The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. [optional] [default to []]
x_org_id str [optional] [default to ]

Return type

list[SambaDomainOutput]

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]

ldapservers_samba_domains_post

SambaDomainOutput ldapservers_samba_domains_post(ldapserver_id, body=body, content_type=content_type, accept=accept, x_org_id=x_org_id)

Create Samba Domain

This endpoint allows you to create a samba domain for an LDAP server. ##### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"sid\":\"{SID_ID}\", \"name\":\"{WORKGROUP_NAME}\" }'

Example

from __future__ import print_function
import time
import jcapiv2
from jcapiv2.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = jcapiv2.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = jcapiv2.SambaDomainsApi(jcapiv2.ApiClient(configuration))
ldapserver_id = 'ldapserver_id_example' # str | Unique identifier of the LDAP server.
body = jcapiv2.SambaDomainInput() # SambaDomainInput |  (optional)
content_type = 'application/json' # str |  (optional) (default to application/json)
accept = 'application/json' # str |  (optional) (default to application/json)
x_org_id = '' # str |  (optional) (default to )

try:
    # Create Samba Domain
    api_response = api_instance.ldapservers_samba_domains_post(ldapserver_id, body=body, content_type=content_type, accept=accept, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SambaDomainsApi->ldapservers_samba_domains_post: %s\n" % e)

Parameters

Name Type Description Notes
ldapserver_id str Unique identifier of the LDAP server.
body SambaDomainInput [optional]
content_type str [optional] [default to application/json]
accept str [optional] [default to application/json]
x_org_id str [optional] [default to ]

Return type

SambaDomainOutput

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]

ldapservers_samba_domains_put

SambaDomainOutput ldapservers_samba_domains_put(ldapserver_id, id, body=body, content_type=content_type, accept=accept, x_org_id=x_org_id)

Update Samba Domain

This endpoint allows you to update the samba domain information for an LDAP server. ##### Sample Request curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"sid\":\"{SID_ID}\", \"name\":\"{WORKGROUP_NAME}\" }'

Example

from __future__ import print_function
import time
import jcapiv2
from jcapiv2.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = jcapiv2.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = jcapiv2.SambaDomainsApi(jcapiv2.ApiClient(configuration))
ldapserver_id = 'ldapserver_id_example' # str | Unique identifier of the LDAP server.
id = 'id_example' # str | Unique identifier of the samba domain.
body = jcapiv2.SambaDomainInput() # SambaDomainInput |  (optional)
content_type = 'application/json' # str |  (optional) (default to application/json)
accept = 'application/json' # str |  (optional) (default to application/json)
x_org_id = '' # str |  (optional) (default to )

try:
    # Update Samba Domain
    api_response = api_instance.ldapservers_samba_domains_put(ldapserver_id, id, body=body, content_type=content_type, accept=accept, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SambaDomainsApi->ldapservers_samba_domains_put: %s\n" % e)

Parameters

Name Type Description Notes
ldapserver_id str Unique identifier of the LDAP server.
id str Unique identifier of the samba domain.
body SambaDomainInput [optional]
content_type str [optional] [default to application/json]
accept str [optional] [default to application/json]
x_org_id str [optional] [default to ]

Return type

SambaDomainOutput

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]