Skip to content

SecurityManagementLDAPApi.md

Latest commit

 

History

History
345 lines (246 loc) · 10.3 KB

SecurityManagementLDAPApi.md

File metadata and controls

345 lines (246 loc) · 10.3 KB

nexus_api_python_client.SecurityManagementLDAPApi

All URIs are relative to http://localhost/service/rest

Method HTTP request Description
change_order POST /beta/security/ldap/change-order Change LDAP server order
create_ldap_server POST /beta/security/ldap Create LDAP server
delete_ldap_server DELETE /beta/security/ldap/{name} Delete LDAP server
get_ldap_server GET /beta/security/ldap/{name} Get LDAP server
get_ldap_servers GET /beta/security/ldap List LDAP servers
update_ldap_server PUT /beta/security/ldap/{name} Update LDAP server

change_order

change_order(body=body)

Change LDAP server order

Example

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

# Enter a context with an instance of the API client
with nexus_api_python_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = nexus_api_python_client.SecurityManagementLDAPApi(api_client)
    body = ['body_example'] # list[str] | Ordered list of LDAP server names (optional)

    try:
        # Change LDAP server order
        api_instance.change_order(body=body)
    except ApiException as e:
        print("Exception when calling SecurityManagementLDAPApi->change_order: %s\n" % e)

Parameters

Name Type Description Notes
body list[str] Ordered list of LDAP server names [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 LDAP server order changed -
401 Authentication required -
403 Insufficient permissions -

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

create_ldap_server

create_ldap_server(body=body)

Create LDAP server

Example

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

# Enter a context with an instance of the API client
with nexus_api_python_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = nexus_api_python_client.SecurityManagementLDAPApi(api_client)
    body = nexus_api_python_client.CreateLdapServerXo() # CreateLdapServerXo |  (optional)

    try:
        # Create LDAP server
        api_instance.create_ldap_server(body=body)
    except ApiException as e:
        print("Exception when calling SecurityManagementLDAPApi->create_ldap_server: %s\n" % e)

Parameters

Name Type Description Notes
body CreateLdapServerXo [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 LDAP server created -
401 Authentication required -
403 Insufficient permissions -

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

delete_ldap_server

delete_ldap_server(name)

Delete LDAP server

Example

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

# Enter a context with an instance of the API client
with nexus_api_python_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = nexus_api_python_client.SecurityManagementLDAPApi(api_client)
    name = 'name_example' # str | Name of the LDAP server to delete

    try:
        # Delete LDAP server
        api_instance.delete_ldap_server(name)
    except ApiException as e:
        print("Exception when calling SecurityManagementLDAPApi->delete_ldap_server: %s\n" % e)

Parameters

Name Type Description Notes
name str Name of the LDAP server to delete

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 LDAP server deleted -
401 Authentication required -
403 Insufficient permissions -
404 LDAP server not found -

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

get_ldap_server

get_ldap_server(name)

Get LDAP server

Example

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

# Enter a context with an instance of the API client
with nexus_api_python_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = nexus_api_python_client.SecurityManagementLDAPApi(api_client)
    name = 'name_example' # str | Name of the LDAP server to retrieve

    try:
        # Get LDAP server
        api_instance.get_ldap_server(name)
    except ApiException as e:
        print("Exception when calling SecurityManagementLDAPApi->get_ldap_server: %s\n" % e)

Parameters

Name Type Description Notes
name str Name of the LDAP server to retrieve

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 LDAP server returned -
401 Authentication required -
403 Insufficient permissions -
404 LDAP server not found -

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

get_ldap_servers

get_ldap_servers()

List LDAP servers

Example

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

# Enter a context with an instance of the API client
with nexus_api_python_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = nexus_api_python_client.SecurityManagementLDAPApi(api_client)
    
    try:
        # List LDAP servers
        api_instance.get_ldap_servers()
    except ApiException as e:
        print("Exception when calling SecurityManagementLDAPApi->get_ldap_servers: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 LDAP server list returned -
401 Authentication required -
403 Insufficient permissions -

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

update_ldap_server

update_ldap_server(name, body=body)

Update LDAP server

Example

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

# Enter a context with an instance of the API client
with nexus_api_python_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = nexus_api_python_client.SecurityManagementLDAPApi(api_client)
    name = 'name_example' # str | Name of the LDAP server to update
body = nexus_api_python_client.UpdateLdapServerXo() # UpdateLdapServerXo | Updated values of LDAP server (optional)

    try:
        # Update LDAP server
        api_instance.update_ldap_server(name, body=body)
    except ApiException as e:
        print("Exception when calling SecurityManagementLDAPApi->update_ldap_server: %s\n" % e)

Parameters

Name Type Description Notes
name str Name of the LDAP server to update
body UpdateLdapServerXo Updated values of LDAP server [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 LDAP server updated -
401 Authentication required -
403 Insufficient permissions -
404 LDAP server not found -

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