netgate-ldap API (24.02)

The YANG module provides a data-model for the LDAP client.

Copyright 2023, 2024 Rubicon Communications, LLC.

ldap-client

returns netgate.ldap.LdapClient

get /data/netgate-ldap:ldap-client

Example URL

https://hostname/restconf/data/netgate-ldap:ldap-client

LDAP client configuration for PAM subsystem.

Responses

200

netgate.ldap.LdapClient

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ldap:ldap-client"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "netgate-ldap:ldap-client-wrapper":
    {
    }
}

creates netgate.ldap.LdapClient

post /data/netgate-ldap:ldap-client

Example URL

https://hostname/restconf/data/netgate-ldap:ldap-client

LDAP client configuration for PAM subsystem.

Request Body schema: application/yang-data+json

netgate.ldap.LdapClient to be added to list

netgate-ldap:ldap-client
object (netgate.ldap.LdapClient)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "netgate-ldap:ldap-client":
    {
    }
}

creates or updates netgate.ldap.LdapClient

put /data/netgate-ldap:ldap-client

Example URL

https://hostname/restconf/data/netgate-ldap:ldap-client

LDAP client configuration for PAM subsystem.

Request Body schema: application/yang-data+json

netgate.ldap.LdapClient to be added or updated

netgate-ldap:ldap-client-wrapper
object (netgate.ldap.LdapClientWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "netgate-ldap:ldap-client-wrapper":
    {
    }
}

removes netgate.ldap.LdapClient

delete /data/netgate-ldap:ldap-client

Example URL

https://hostname/restconf/data/netgate-ldap:ldap-client

LDAP client configuration for PAM subsystem.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ldap:ldap-client"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.ldap.ldapclient.Client

get /data/netgate-ldap:ldap-client/client

Example URL

https://hostname/restconf/data/netgate-ldap:ldap-client/client

The LDAP client parameters.

Responses

200

netgate.ldap.ldapclient.Client

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ldap:ldap-client/client"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "netgate-ldap:client-wrapper":
    {
    }
}

creates netgate.ldap.ldapclient.Client

post /data/netgate-ldap:ldap-client/client

Example URL

https://hostname/restconf/data/netgate-ldap:ldap-client/client

The LDAP client parameters.

Request Body schema: application/yang-data+json

netgate.ldap.ldapclient.Client to be added to list

client
object (netgate.ldap.ldapclient.Client)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "client":
    {
    }
}

creates or updates netgate.ldap.ldapclient.Client

put /data/netgate-ldap:ldap-client/client

Example URL

https://hostname/restconf/data/netgate-ldap:ldap-client/client

The LDAP client parameters.

Request Body schema: application/yang-data+json

netgate.ldap.ldapclient.Client to be added or updated

netgate-ldap:client-wrapper
object (netgate.ldap.ldapclient.ClientWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "netgate-ldap:client-wrapper":
    {
    }
}

removes netgate.ldap.ldapclient.Client

delete /data/netgate-ldap:ldap-client/client

Example URL

https://hostname/restconf/data/netgate-ldap:ldap-client/client

The LDAP client parameters.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ldap:ldap-client/client"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.ldap.ldapclient.client.Attributes

get /data/netgate-ldap:ldap-client/client/attributes

Example URL

https://hostname/restconf/data/netgate-ldap:ldap-client/client/attributes

returns netgate.ldap.ldapclient.client.Attributes

Responses

200

netgate.ldap.ldapclient.client.Attributes

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ldap:ldap-client/client/attributes"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "netgate-ldap:attributes-wrapper":
    {
    }
}

creates netgate.ldap.ldapclient.client.Attributes

post /data/netgate-ldap:ldap-client/client/attributes

Example URL

https://hostname/restconf/data/netgate-ldap:ldap-client/client/attributes

creates netgate.ldap.ldapclient.client.Attributes

Request Body schema: application/yang-data+json

netgate.ldap.ldapclient.client.Attributes to be added to list

attributes
object (netgate.ldap.ldapclient.client.Attributes)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "attributes":
    {
    }
}

creates or updates netgate.ldap.ldapclient.client.Attributes

put /data/netgate-ldap:ldap-client/client/attributes

Example URL

https://hostname/restconf/data/netgate-ldap:ldap-client/client/attributes

creates or updates netgate.ldap.ldapclient.client.Attributes

Request Body schema: application/yang-data+json

netgate.ldap.ldapclient.client.Attributes to be added or updated

netgate-ldap:attributes-wrapper
object (netgate.ldap.ldapclient.client.AttributesWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "netgate-ldap:attributes-wrapper":
    {
    }
}

removes netgate.ldap.ldapclient.client.Attributes

delete /data/netgate-ldap:ldap-client/client/attributes

Example URL

https://hostname/restconf/data/netgate-ldap:ldap-client/client/attributes

removes netgate.ldap.ldapclient.client.Attributes

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ldap:ldap-client/client/attributes"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.ldap.ldapclient.client.attributes.Overrides

post /data/netgate-ldap:ldap-client/client/attributes/overrides

Example URL

https://hostname/restconf/data/netgate-ldap:ldap-client/client/attributes/overrides

creates netgate.ldap.ldapclient.client.attributes.Overrides

Request Body schema: application/yang-data+json

netgate.ldap.ldapclient.client.attributes.Overrides to be added to list

overrides
object (netgate.ldap.ldapclient.client.attributes.Overrides)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "overrides":
    {
    }
}

returns netgate.ldap.ldapclient.client.attributes.Overrides

get /data/netgate-ldap:ldap-client/client/attributes/overrides={attribute}

Example URL

https://hostname/restconf/data/netgate-ldap:ldap-client/client/attributes/overrides={attribute}

returns netgate.ldap.ldapclient.client.attributes.Overrides

path Parameters
attribute
required
string

Id of overrides

Responses

200

netgate.ldap.ldapclient.client.attributes.Overrides

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ldap:ldap-client/client/attributes/overrides=%7Battribute%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "netgate-ldap:overrides-wrapper":
    {
    }
}

creates or updates netgate.ldap.ldapclient.client.attributes.Overrides

put /data/netgate-ldap:ldap-client/client/attributes/overrides={attribute}

Example URL

https://hostname/restconf/data/netgate-ldap:ldap-client/client/attributes/overrides={attribute}

creates or updates netgate.ldap.ldapclient.client.attri