2016-05-07 17:18:15 +02:00
|
|
|
.. -*- rst -*-
|
|
|
|
|
|
|
|
Security services
|
|
|
|
=================
|
|
|
|
|
2019-03-28 17:48:10 -07:00
|
|
|
You can create, update, view, and delete security services. A
|
|
|
|
security service resource represents configuration information for clients for
|
2016-05-07 17:18:15 +02:00
|
|
|
authentication and authorization (AuthN/AuthZ). For example, a
|
2019-03-28 17:48:10 -07:00
|
|
|
share server will be the client for an existing security service such as
|
2016-05-07 17:18:15 +02:00
|
|
|
LDAP, Kerberos, or Microsoft Active Directory.
|
|
|
|
|
2019-03-28 17:48:10 -07:00
|
|
|
The Shared File Systems service supports three security service types:
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
- ``ldap``. LDAP.
|
|
|
|
|
|
|
|
- ``kerberos``. Kerberos.
|
|
|
|
|
|
|
|
- ``active_directory``. Microsoft Active Directory.
|
|
|
|
|
|
|
|
You can configure a security service with these options:
|
|
|
|
|
2018-03-29 08:48:53 +02:00
|
|
|
- A DNS IP address. Some drivers may allow a comma separated list of multiple
|
|
|
|
addresses, e.g. NetApp ONTAP.
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
- An IP address or host name.
|
|
|
|
|
|
|
|
- A domain.
|
|
|
|
|
2017-05-19 14:46:44 -04:00
|
|
|
- An ou, the organizational unit. (available starting with API version 2.44)
|
|
|
|
|
2016-05-07 17:18:15 +02:00
|
|
|
- A user or group name.
|
|
|
|
|
|
|
|
- The password for the user, if you specify a user name.
|
|
|
|
|
2023-02-16 09:23:07 +00:00
|
|
|
- A default AD site, optional (available starting with API version 2.76)
|
|
|
|
|
2019-03-28 17:48:10 -07:00
|
|
|
A security service resource can also be given a user defined name and
|
|
|
|
description.
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
List security services
|
2022-03-25 01:56:30 +05:30
|
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
2016-05-07 17:18:15 +02:00
|
|
|
|
2021-02-03 11:16:51 -08:00
|
|
|
.. rest_method:: GET /v2/security-services
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Lists all security services.
|
|
|
|
|
2018-03-22 18:38:36 +08:00
|
|
|
Response codes
|
|
|
|
--------------
|
|
|
|
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
|
|
|
|
- 200
|
|
|
|
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
|
|
|
|
- 400
|
|
|
|
- 401
|
|
|
|
- 403
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Request
|
|
|
|
-------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
2018-12-07 19:55:30 +01:00
|
|
|
- project_id: project_id_path
|
2018-11-12 09:43:07 +08:00
|
|
|
- all_tenants: all_tenants_query
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Response parameters
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
2016-09-26 12:07:10 +07:00
|
|
|
- status: security_service_status
|
|
|
|
- type: security_service_type
|
|
|
|
- id: security_service_id
|
2019-03-28 17:48:10 -07:00
|
|
|
- name: name
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Response example
|
|
|
|
----------------
|
|
|
|
|
|
|
|
.. literalinclude:: samples/security-services-list-response.json
|
|
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
List security services with details
|
2022-03-25 01:56:30 +05:30
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2016-05-07 17:18:15 +02:00
|
|
|
|
2021-02-03 11:16:51 -08:00
|
|
|
.. rest_method:: GET /v2/security-services/detail
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Lists all security services with details.
|
|
|
|
|
2018-03-22 18:38:36 +08:00
|
|
|
Response codes
|
|
|
|
--------------
|
|
|
|
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
|
|
|
|
- 200
|
|
|
|
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
|
|
|
|
- 400
|
|
|
|
- 401
|
|
|
|
- 403
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Request
|
|
|
|
-------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
2018-12-07 19:55:30 +01:00
|
|
|
- project_id: project_id_path
|
2018-11-12 09:43:07 +08:00
|
|
|
- all_tenants: all_tenants_query
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Response parameters
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
2016-09-26 12:07:10 +07:00
|
|
|
- status: security_service_status
|
|
|
|
- id: security_service_id
|
2018-12-07 19:55:30 +01:00
|
|
|
- project_id: project_id
|
2016-09-26 12:07:10 +07:00
|
|
|
- type: security_service_type
|
2019-03-28 17:48:10 -07:00
|
|
|
- name: name
|
|
|
|
- description: description
|
2016-09-26 12:07:10 +07:00
|
|
|
- dns_ip: security_service_dns_ip
|
|
|
|
- user: security_service_user
|
|
|
|
- password: security_service_password
|
|
|
|
- domain: security_service_domain
|
2017-05-19 14:46:44 -04:00
|
|
|
- ou: security_service_ou
|
2016-09-26 12:07:10 +07:00
|
|
|
- server: security_service_server
|
2023-02-16 09:23:07 +00:00
|
|
|
- default_ad_site: security_service_default_ad_site
|
2019-03-28 14:56:08 -07:00
|
|
|
- updated_at: updated_at
|
|
|
|
- created_at: created_at
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Response example
|
|
|
|
----------------
|
|
|
|
|
|
|
|
.. literalinclude:: samples/security-services-list-detailed-response.json
|
|
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
Show security service details
|
2022-03-25 01:56:30 +05:30
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2016-05-07 17:18:15 +02:00
|
|
|
|
2021-02-03 11:16:51 -08:00
|
|
|
.. rest_method:: GET /v2/security-services/{security_service_id}
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Shows details for a security service.
|
|
|
|
|
2018-03-22 18:38:36 +08:00
|
|
|
Response codes
|
|
|
|
--------------
|
|
|
|
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
|
|
|
|
- 200
|
|
|
|
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
|
|
|
|
- 400
|
|
|
|
- 401
|
|
|
|
- 403
|
|
|
|
- 404
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Request
|
|
|
|
-------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
2018-12-07 19:55:30 +01:00
|
|
|
- project_id: project_id_path
|
2016-09-26 12:07:10 +07:00
|
|
|
- security_service_id: security_service_id_path
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Response parameters
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
2016-09-26 12:07:10 +07:00
|
|
|
- status: security_service_status
|
|
|
|
- id: security_service_id
|
2018-12-07 19:55:30 +01:00
|
|
|
- project_id: project_id
|
2016-09-26 12:07:10 +07:00
|
|
|
- type: security_service_type
|
2019-03-28 17:48:10 -07:00
|
|
|
- name: name
|
|
|
|
- description: description
|
2016-09-26 12:07:10 +07:00
|
|
|
- dns_ip: security_service_dns_ip
|
|
|
|
- user: security_service_user
|
|
|
|
- password: security_service_password
|
|
|
|
- domain: security_service_domain
|
2017-05-19 14:46:44 -04:00
|
|
|
- ou: security_service_ou
|
2016-09-26 12:07:10 +07:00
|
|
|
- server: security_service_server
|
2023-02-16 09:23:07 +00:00
|
|
|
- default_ad_site: security_service_default_ad_site
|
2019-03-28 14:56:08 -07:00
|
|
|
- updated_at: updated_at
|
|
|
|
- created_at: created_at
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Response example
|
|
|
|
----------------
|
|
|
|
|
|
|
|
.. literalinclude:: samples/security-service-show-response.json
|
|
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
Create security service
|
2022-03-25 01:56:30 +05:30
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
2016-05-07 17:18:15 +02:00
|
|
|
|
2021-02-03 11:16:51 -08:00
|
|
|
.. rest_method:: POST /v2/security-services
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Creates a security service.
|
|
|
|
|
2018-03-22 18:38:36 +08:00
|
|
|
Response codes
|
|
|
|
--------------
|
|
|
|
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
|
|
|
|
- 200
|
|
|
|
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
|
|
|
|
- 400
|
|
|
|
- 401
|
|
|
|
- 403
|
|
|
|
- 422
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Request
|
|
|
|
-------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
2018-12-07 19:55:30 +01:00
|
|
|
- project_id: project_id_path
|
2016-09-26 12:07:10 +07:00
|
|
|
- type: security_service_type
|
2019-03-28 17:48:10 -07:00
|
|
|
- name: name_request
|
|
|
|
- description: description_request
|
2016-09-26 12:07:10 +07:00
|
|
|
- dns_ip: security_service_dns_ip_request
|
|
|
|
- user: security_service_user_request
|
|
|
|
- password: security_service_password_request
|
|
|
|
- domain: security_service_domain_request
|
2017-05-19 14:46:44 -04:00
|
|
|
- ou: security_service_ou_request
|
2016-09-26 12:07:10 +07:00
|
|
|
- server: security_service_server_request
|
2023-02-16 09:23:07 +00:00
|
|
|
- default_ad_site: security_service_default_ad_site_request
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Request example
|
|
|
|
---------------
|
|
|
|
|
|
|
|
.. literalinclude:: samples/security-service-create-request.json
|
|
|
|
:language: javascript
|
|
|
|
|
|
|
|
Response parameters
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
2016-09-26 12:07:10 +07:00
|
|
|
- status: security_service_status
|
|
|
|
- id: security_service_id
|
2018-12-07 19:55:30 +01:00
|
|
|
- project_id: project_id
|
2016-09-26 12:07:10 +07:00
|
|
|
- type: security_service_type
|
2019-03-28 17:48:10 -07:00
|
|
|
- name: name
|
|
|
|
- description: description
|
2016-09-26 12:07:10 +07:00
|
|
|
- dns_ip: security_service_dns_ip
|
|
|
|
- user: security_service_user
|
|
|
|
- password: security_service_password
|
|
|
|
- domain: security_service_domain
|
2017-05-19 14:46:44 -04:00
|
|
|
- ou: security_service_ou
|
2016-09-26 12:07:10 +07:00
|
|
|
- server: security_service_server
|
2023-02-16 09:23:07 +00:00
|
|
|
- default_ad_site: security_service_default_ad_site
|
2019-03-28 14:56:08 -07:00
|
|
|
- updated_at: updated_at
|
|
|
|
- created_at: created_at
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Response example
|
|
|
|
----------------
|
|
|
|
|
|
|
|
.. literalinclude:: samples/security-service-create-response.json
|
|
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
Update security service
|
2022-03-25 01:56:30 +05:30
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
2016-05-07 17:18:15 +02:00
|
|
|
|
2021-02-03 11:16:51 -08:00
|
|
|
.. rest_method:: PUT /v2/security-services/{security_service_id}
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Updates a security service.
|
|
|
|
|
|
|
|
If the security service is in ``active`` state, you can update only
|
|
|
|
the ``name`` and ``description`` attributes. A security service in
|
|
|
|
``active`` state is attached to a share network with an associated
|
|
|
|
share server.
|
|
|
|
|
2018-03-22 18:38:36 +08:00
|
|
|
Response codes
|
|
|
|
--------------
|
|
|
|
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
|
|
|
|
- 200
|
|
|
|
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
|
|
|
|
- 400
|
|
|
|
- 401
|
|
|
|
- 403
|
|
|
|
- 404
|
|
|
|
- 422
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Request
|
|
|
|
-------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
2018-12-07 19:55:30 +01:00
|
|
|
- project_id: project_id_path
|
2016-09-26 12:07:10 +07:00
|
|
|
- security_service_id: security_service_id_path
|
|
|
|
- type: security_service_type
|
2019-03-28 17:48:10 -07:00
|
|
|
- name: name_request
|
|
|
|
- description: description_request
|
2016-09-26 12:07:10 +07:00
|
|
|
- dns_ip: security_service_dns_ip_request
|
|
|
|
- user: security_service_user_request
|
|
|
|
- password: security_service_password_request
|
|
|
|
- domain: security_service_domain_request
|
2017-05-19 14:46:44 -04:00
|
|
|
- ou: security_service_ou_request
|
2016-09-26 12:07:10 +07:00
|
|
|
- server: security_service_server_request
|
2023-02-16 09:23:07 +00:00
|
|
|
- default_ad_site: security_service_default_ad_site_request
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Request example
|
|
|
|
---------------
|
|
|
|
|
|
|
|
.. literalinclude:: samples/security-service-update-request.json
|
|
|
|
:language: javascript
|
|
|
|
|
|
|
|
Response parameters
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
2016-09-26 12:07:10 +07:00
|
|
|
- status: security_service_status
|
|
|
|
- id: security_service_id
|
2018-12-07 19:55:30 +01:00
|
|
|
- project_id: project_id
|
2016-09-26 12:07:10 +07:00
|
|
|
- type: security_service_type
|
2019-03-28 17:48:10 -07:00
|
|
|
- name: name
|
|
|
|
- description: description
|
2016-09-26 12:07:10 +07:00
|
|
|
- dns_ip: security_service_dns_ip
|
|
|
|
- user: security_service_user
|
|
|
|
- password: security_service_password
|
|
|
|
- domain: security_service_domain
|
2017-05-19 14:46:44 -04:00
|
|
|
- ou: security_service_ou
|
2016-09-26 12:07:10 +07:00
|
|
|
- server: security_service_server
|
2023-02-16 09:23:07 +00:00
|
|
|
- default_ad_site: security_service_default_ad_site
|
2019-03-28 14:56:08 -07:00
|
|
|
- updated_at: updated_at
|
|
|
|
- created_at: created_at
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Response example
|
|
|
|
----------------
|
|
|
|
|
|
|
|
.. literalinclude:: samples/security-service-update-response.json
|
|
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
Delete security service
|
2022-03-25 01:56:30 +05:30
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
2016-05-07 17:18:15 +02:00
|
|
|
|
2021-02-03 11:16:51 -08:00
|
|
|
.. rest_method:: DELETE /v2/security-services/{security_service_id}
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Deletes a security service.
|
|
|
|
|
2018-03-22 18:38:36 +08:00
|
|
|
Response codes
|
|
|
|
--------------
|
|
|
|
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
|
|
|
|
- 202
|
|
|
|
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
|
|
|
|
- 400
|
|
|
|
- 401
|
|
|
|
- 403
|
|
|
|
- 404
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
Request
|
|
|
|
-------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
2018-12-07 19:55:30 +01:00
|
|
|
- project_id: project_id_path
|
2016-09-26 12:07:10 +07:00
|
|
|
- security_service_id: security_service_id_path
|