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

Configure a data SVM as a proxy

PDFs

POST /security/authentication/cluster/ad-proxy

Introduced In: 9.7

Configures a data SVM as a proxy for Active Directory based authentication for cluster user accounts.

Required properties

  • svm.name or svm.uuid - Name and UUID of the SVM for a cluster user account.

  • security login domain-tunnel create

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

svm

svm
Example request 
{
  "svm": {
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 201, Created

Error

Status: Default, Error

Definitions

See Definitions

href

Name Type Description

href

string

_links

svm

Name Type Description

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

cluster_ad_proxy

The SVM configured as proxy for Active Directory authentication of cluster accounts.

Name Type Description

svm

svm

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.