Skip to main content
A newer release of this product is available.

ldap

Contributors
Suggest changes
PDFs

ldap-check-get-iter

GET /api/name-services/ldap

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

client-config

No REST Equivalent

ldap-client-config and ldap-config are merged into a single endpoint in the REST API.
Each SVM can have only one LDAP client config. This field is not required in the REST API.

ldap-dn-status-details

No REST Equivalent

This field is not required in the REST API. LDAP server status details will be provided
in the status.message field.

ldap-status

status.state

This is an advanced privilege field in the REST API.

ldap-status-details

status.message

This is an advanced privilege field in the REST API.

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

ldap-client-create

POST /api/name-services/ldap

Note: The REST API does not treat LDAP client create as an independent operation. Create the LDAP client and LDAP configuration by using LDAP POST. Use the /api/security/authentication/cluster/ldap endpoint to create cluster LDAP configurations.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

ad-domain

ad_domain

base-dn

base_dn

base-scope

base_scope

bind-as-cifs-server

bind-as-cifs-server

bind-dn

bind_dn

bind-password

bind_password

group-dn

group_dn

group-membership-filter

group_membership_filter

group-scope

group_scope

is-netgroup-byhost-enabled

is_netgroup_byhost_enabled

ldap-client-config

No REST Equivalent

ldap-client-config and ldap-config are merged into a single endpoint in the REST API.
Each SVM can have only one LDAP client config. This field is not required in the REST API.

ldap-servers

servers

min-bind-level

min_bind_level

netgroup-byhost-dn

netgroup_byhost_dn

netgroup-byhost-scope

netgroup_byhost_scope

netgroup-dn

netgroup_dn

netgroup-scope

netgroup_scope

obs-password

No REST Equivalent

preferred-ad-servers

preferred_ad_servers

query-timeout

query_timeout

referral-enabled

referral_enabled

return-record

?return_records=true

schema

schema

servers

No REST Equivalent

This field has been deprecated. Use "ldap-servers" parameter.

session-security

session_security

tcp-port

port

use-start-tls

use_start_tls

user-dn

user_dn

user-scope

user_scope

try-channel-binding

try_channel_binding

ldap-client-delete

DELETE /api/name-services/ldap/{svm.uuid}

Note: The REST API does not treat LDAP client delete as an independent operation. Delete the LDAP client and LDAP configuration by using LDAP DELETE. Use the /api/security/authentication/cluster/ldap endpoint to delete cluster LDAP configurations.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

ldap-client-config

No REST Equivalent

To delete an LDAP client config use the DELETE /api/name-services/ldap REST API endpoint.

ldap-client-get-iter

GET /api/name-services/ldap

Note: The REST API does not have a separate LDAP client GET operation. Retrieve LDAP client configurations by using LDAP GET.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

ad-domain

ad_domain

base-dn

base_dn

base-scope

base_scope

bind-as-cifs-server

bind_as_cifs_server

bind-dn

bind_dn

bind-password

bind_password

group-dn

group_dn

This is an advanced privilege field in the REST API.

group-membership-filter

group_membership_filter

This is an advanced privilege field in the REST API.

group-scope

group_scope

This is an advanced privilege field in the REST API.

is-netgroup-byhost-enabled

is_netgroup_byhost_enabled

This is an advanced privilege field in the REST API.

is-owner

is_owner

ldap-client-config

No REST Equivalent

ldap-client-config and ldap-config are merged into a single endpoint in the REST API.
Each SVM can have only one LDAP client config. This field is not required in the REST API.

ldap-servers

servers

min-bind-level

min_bind_level

netgroup-byhost-dn

netgroup_byhost_dn

This is an advanced privilege field in the REST API.

netgroup-byhost-scope

netgroup_byhost_scope

This is an advanced privilege field in the REST API.

netgroup-dn

netgroup_dn

This is an advanced privilege field in the REST API.

netgroup-scope

netgroup_scope

This is an advanced privilege field in the REST API.

obs-password

No REST Equivalent

preferred-ad-servers

preferred_ad_servers

query-timeout

query_timeout

referral-enabled

referral_enabled

schema

schema

servers

No REST Equivalent

session-security

session_security

skip-config-validation

No REST Equivalent

tcp-port

port

use-start-tls

use_start_tls

user-dn

user_dn

This is an advanced privilege field in the REST API.

user-scope

user_scope

This is an advanced privilege field in the REST API.

vserver

svm.name

try-channel-binding

try_channel_binding

max-records

max_records

Specifies the maximum number of records to return before paging.

ldap-client-modify

PATCH /api/name-services/ldap/{svm.uuid}

Note: The REST API does not have a separate LDAP client modify operation. Update the LDAP client by using LDAP PATCH. Use the /api/security/authentication/cluster/ldap endpoint to modify cluster LDAP configurations.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

ad-domain

ad_domain

base-dn

base_dn

base-scope

base_scope

bind-as-cifs-server

bind_as_cifs_server

bind-dn

bind_dn

bind-password

bind_password

group-dn

group_dn

group-membership-filter

group_membership_filter

group-scope

group_scope

is-netgroup-byhost-enabled

is_netgroup_byhost_enabled

ldap-client-config

No REST Equivalent

ldap-client-config and ldap-config are merged into a single endpoint in the REST API.
Each SVM can have only one LDAP client config. This field is not required in the REST API.

ldap-servers

servers

min-bind-level

min_bind_level

netgroup-byhost-dn

netgroup_byhost_dn

netgroup-byhost-scope

netgroup_byhost_scope

netgroup-dn

netgroup_dn

netgroup-scope

netgroup_scope

obs-password

No REST Equivalent

preferred-ad-servers

preferred_ad_servers

query-timeout

query_timeout

referral-enabled

referral_enabled

schema

schema

servers

No REST Equivalent

session-security

session_security

skip-config-validation

skip_config_validation

tcp-port

port

use-start-tls

use_start_tls

user-dn

user_dn

user-scope

user_scope

try-channel-binding

try_channel_binding

ldap-client-schema-copy

This ONTAPI call does not have an equivalent REST API call.

ldap-client-schema-delete

This ONTAPI call does not have an equivalent REST API call.

ldap-client-schema-get-iter

This ONTAPI call does not have an equivalent REST API call.

ldap-client-schema-modify

This ONTAPI call does not have an equivalent REST API call.

ldap-config-create

POST /api/name-services/ldap

Note: Use the /api/security/authentication/cluster/ldap REST API endpoint to create cluster LDAP configurations.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

client-config

No REST Equivalent

ldap-client-config and ldap-config are merged into a single endpoint in the REST API.
Each SVM can have only one LDAP client config. This field is not required in the REST API.

client-enabled

No REST Equivalent

ldap-client-config and ldap-config are merged into a single endpoint in the REST API.
Each SVM can have only one LDAP client config. This field is not required in the REST API.

return-record

?return_records=true

skip-config-validation

skip_config_validation

ldap-config-delete

DELETE /api/name-services/ldap/{svm.uuid}

Note: Use the /api/security/authentication/cluster/ldap REST API endpoint to delete cluster LDAP configurations.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

There are no attributes defined for this ONTAPI call.

ldap-config-get-iter

GET /api/name-services/ldap

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

client-config

No REST Equivalent

ldap-client-config and ldap-config are merged into a single endpoint in the REST API.
Each SVM can have only one LDAP client config. This field is not required in the REST API.

client-enabled

No REST Equivalent

ldap-client-config and ldap-config are merged into a single endpoint in the REST API.
Each SVM can have only one LDAP client config. This field is not required in the REST API.

skip-config-validation

No REST Equivalent

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

ldap-config-modify

PATCH /api/name-services/ldap/{svm.uuid}

Note: Use the /api/security/authentication/cluster/ldap REST API endpoint to modify cluster LDAP configurations.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

client-config

No REST Equivalent

ldap-client-config and ldap-config are merged into a single endpoint in the REST API.
Each SVM can have only one LDAP client config. This field is not required in the REST API.

client-enabled

No REST Equivalent

ldap-client-config and ldap-config are merged into a single endpoint in the REST API.
Each SVM can have only one LDAP client config. This field is not required in the REST API.

skip-config-validation

skip_config_validation