User role management
POST /v1/objects/external-auth-server-root-certificates/<targetServer>/actions/import/invoke
Required Role: Security
Imports a root certificate (to be used in communication with the user's external authentication server) to a storage cluster.
PEM- and DER-format authentication files are supported. The root certificate is applied immediately if TLS communication with the server is enabled in the storage cluster settings for the external authentication server specified as "targetServer".
This API can be executed only for a cluster master node (primary). If this API is executed for any node other than a cluster master node (primary), HTTP status code 412 (Precondition Failed) is returned.
multipart/form-data
|
Name |
Description |
Type |
Data type |
|
rootCertificate |
Root certificate file (used in communication with the external authentication server) to be imported to the storage cluster. |
formData |
file required |
|
targetServer |
Target external authentication server in user authentication. |
path |
string , x ∈ { "primary1", "secondary1" } required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X POST -H "Content-Type: multipart/form-data" -H "Expect:" -F rootCertificate=@win2016ca.cer https://192.168.1.100/ConfigurationManager/simple/v1/objects/external-auth-server-root-certificates/primary1/actions/import/invoke
Uses default content-types: application/json
Indicates that an asynchronous process request was accepted.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the Content-Length header must be specified. It is returned when the request body was not specified and "Content-Length: 0" was not specified as the header parameter.
Indicates that the conditions for executing the API are not met.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
GET /v1/objects/external-auth-server-root-certificates/<targetServer>/download
Required Role: Security
Obtains a root certificate (to be used in communication with the user's external authentication server) which is imported to a storage cluster.
A root certificate is output as a DER file.
If this API is called when no root certificate is imported, HTTP status code 404 (Not Found) is returned.
This API can be executed only for a cluster master node (primary). If this API is executed for any node other than a cluster master node (primary), HTTP status code 412 (Precondition Failed) is returned.
If you have not imported the root certificate for the external authentication server, you may see message ID: KARS15553-E. If this is the case, import the root certificate of the external authentication server.
|
Name |
Description |
Type |
Data type |
|
targetServer |
Target external authentication server in user authentication. |
path |
string , x ∈ { "primary1", "secondary1" } required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -J -O -X GET -u admin:password https://192.168.1.100/ConfigurationManager/simple/v1/objects/external-auth-server-root-certificates/primary1/download
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 832 100 832 0 0 1165 0 --:--:-- --:--:-- --:--:-- 1163
curl: Saved to filename 'download-external-auth-server-root-certificate.crt'
Uses default content-types: application/x-x509-ca-cert, application/json
200 OK
Root certificate file corresponding to the server specified as "targetServer".
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the conditions for executing the API are not met.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
GET /v1/objects/external-auth-server-setting
Required Role: Security
Obtains the settings of the external authentication server.
This API can be executed only for a cluster master node (primary). If this API is executed for any node other than a cluster master node (primary), HTTP status code 412 (Precondition Failed) is returned.
None
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -i -u admin:password -X GET https://192.168.1.100/ConfigurationManager/simple/v1/objects/external-auth-server-setting
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: private, no-store, no-cache, must-revalidate
Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline';
Access-Control-Allow-Methods: GET, POST, DELETE, PATCH
Access-Control-Allow-Headers: Content-Type
Content-Type: application/json
Content-Length: 401
Date: Fri, 30 Jul 2021 07:56:23 GMT
{"isEnabled":false,"authProtocol":"LDAP","ldapSetting":{"mappingMode":"User","primaryLdapServerUrl":"","secondaryLdapServerUrl":"","isStartTlsEnabled":false,"baseDn":"","bindDn":"","userIdAttribute":"cn","userTreeDn":"","userObjectClass":"person","externalGroupNameAttribute":"cn","userGroupTreeDn":"","userGroupObjectClass":"group","timeoutSeconds":-1,"retryIntervalMilliseconds":100,"maxRetries":3}}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the conditions for executing the API are not met.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
PATCH /v1/objects/external-auth-server-setting
Required Role: Security
Edits the settings of the external authentication server.
This API can be executed only for a cluster master node (primary). If this API is executed for any node other than a cluster master node (primary), HTTP status code 412 (Precondition Failed) is returned.
Uses default content-types: application/json
None
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X PATCH -H "Content-Type: application/json" -H "Expect:" -d '{ "isEnabled": true, "authProtocol": "LDAP", "ldapSetting": { "mappingMode": "User", "primaryLdapServerUrl": "ldap://192.168.19.174:389", "secondaryLdapServerUrl": "", "isStartTlsEnabled": false, "baseDn": "DC=local", "bindDn": "CN=binddn,CN=Users,DC=userrole,DC=local", "bindDnPassword": "TestPassword", "userIdAttribute": "sAMAccountName", "userTreeDn": "OU=Test01,DC=userrole,DC=local", "userObjectClass": "user", "userGroupIdAttribute": "sAMAccountName", "userGroupTreeDn": "OU=Test01,DC=userrole,DC=local", "userGroupObjectClass": "group" } }' https://192.168.1.100/ConfigurationManager/simple/v1/objects/external-auth-server-setting
The following shows an example using a json body.
curl -u admin:password -i -X PATCH -H "Content-Type: application/json" -H "Expect:" -d @example.json https://192.168.1.100/ConfigurationManager/simple/v1/objects/external-auth-server-setting
example.json is defined as follows:
{
"isEnabled": true,
"authProtocol": "LDAP",
"ldapSetting":
{
"mappingMode": "User",
"primaryLdapServerUrl": "ldap://192.168.19.174:389",
"secondaryLdapServerUrl": "",
"isStartTlsEnabled": false,
"baseDn": "DC=local",
"bindDn": "CN=binddn,CN=Users,DC=userrole,DC=local",
"bindDnPassword": "TestPassword",
"userIdAttribute": "sAMAccountName",
"userTreeDn": "OU=Test01,DC=userrole,DC=local",
"userObjectClass": "user",
"userGroupIdAttribute": "sAMAccountName",
"userGroupTreeDn": "OU=Test01,DC=userrole,DC=local",
"userGroupObjectClass": "group"
}
}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the conditions for executing the API are not met.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
POST /v1/objects/external-auth-server-setting/actions/verify-connectivity/invoke
Required Role: Security or Service
Verifies the connection with the external authentication server. As the connection destination, use the external authentication server which is already set.
This API can be executed only for a cluster master node (primary). If this API is executed for any node other than a cluster master node (primary), HTTP status code 412 (Precondition Failed) is returned.
None
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X POST -H "Content-Length: 0" https://192.168.1.100/ConfigurationManager/simple/v1/objects/external-auth-server-setting/actions/verify-connectivity/invoke
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the Content-Length header must be specified. It is returned when the request body was not specified and "Content-Length: 0" was not specified as the header parameter.
Indicates that the conditions for executing the API are not met.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
GET /v1/objects/user-auth-setting
Required Role: None
Obtains the user authentication settings.
This API can be executed only for a cluster master node (primary). If this API is executed for any node other than a cluster master node (primary), HTTP status code 412 (Precondition Failed) is returned.
None
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -i -u admin:password -X GET https://192.168.1.100/ConfigurationManager/simple/v1/objects/user-auth-setting
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: private, no-store, no-cache, must-revalidate
Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline';
Access-Control-Allow-Methods: GET, POST, DELETE, PATCH
Access-Control-Allow-Headers: Content-Type
Content-Type: application/json
Content-Length: 393
Date: Fri, 30 Jul 2021 07:56:24 GMT
{"passwordComplexitySetting":{"minLength":8,"minNumberOfUpperCaseChars":0,"minNumberOfLowerCaseChars":0,"minNumberOfNumerals":0,"minNumberOfSymbols":0,"numberOfPasswordHistory":1},"passwordAgeSetting":{"requiresInitialPasswordReset":true,"minAgeDays":0,"maxAgeDays":42},"lockoutSetting":{"maxAttempts":3,"lockoutSeconds":60},"sessionSetting":{"maxLifetimeSeconds":86400,"maxIdleSeconds":1800}}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the conditions for executing the API are not met.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
PATCH /v1/objects/user-auth-setting
Required Role: Security
Edits the user authentication settings.
This API can be executed only for a cluster master node (primary). If this API is executed for any node other than a cluster master node (primary), HTTP status code 412 (Precondition Failed) is returned.
None
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X PATCH -H "Content-Type: application/json" -H "Expect:" -d '{ "passwordComplexitySetting":{ "minLength": 4, "minNumberOfUpperCaseChars": 0, "minNumberOfLowerCaseChars": 0, "minNumberOfNumerals": 0, "minNumberOfSymbols": 0, "numberOfPasswordHistory": 1 }, "passwordAgeSetting":{ "requiresInitialPasswordReset":false, "minAgeDays": 0, "maxAgeDays": 42 }, "lockoutSetting":{ "maxAttempts": 3, "lockoutSeconds": 60 }, "sessionSetting":{ "maxLifetimeSeconds": 86400, "maxIdleSeconds": 1800 } }' https://192.168.1.100/ConfigurationManager/simple/v1/objects/user-auth-setting
The following shows an example using a json body.
curl -u admin:password -i -X PATCH -H "Content-Type: application/json" -H "Expect:" -d @example.json https://192.168.1.100/ConfigurationManager/simple/v1/objects/user-auth-setting
example.json is defined as follows:
{
"passwordComplexitySetting":
{
"minLength": 4,
"minNumberOfUpperCaseChars": 0,
"minNumberOfLowerCaseChars": 0,
"minNumberOfNumerals": 0,
"minNumberOfSymbols": 0,
"numberOfPasswordHistory": 1
},
"passwordAgeSetting":
{
"requiresInitialPasswordReset":false,
"minAgeDays": 0,
"maxAgeDays": 42
},
"lockoutSetting":
{
"maxAttempts": 3,
"lockoutSeconds": 60
},
"sessionSetting":
{
"maxLifetimeSeconds": 86400,
"maxIdleSeconds": 1800
}
}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the conditions for executing the API are not met.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
GET /v1/objects/user-groups
Required Role: Security or VpsSecurity
Obtains a list of user groups.
|
Name |
Description |
Type |
Data type |
|
vpsId |
The ID of the virtual private storage (VPS) that the acquisition-target resource belongs to. To filter out the resources that do not belong to the VPS, specify "system". To filter the resources by the VPS that the resources belong to, specify it in UUID format. |
query |
string , must match /^system$|^[A-Fa-f0-9]{8}(-[A-Fa-f0-9]{4}){3}-[A-Fa-f0-9]{12}$/ |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -i -u admin:password -X GET https://192.168.1.100/
ConfigurationManager/simple/v1/objects/user-groups
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: private, no-store, no-cache, must-revalidate
Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline';
Access-Control-Allow-Methods: GET, POST, DELETE, PATCH
Access-Control-Allow-Headers: Content-Type
Content-Type: application/json
Content-Length: 2402
Date: Thu, 20 Oct 2022 06:00:00 GMT
{"data":[{"userGroupId":"SecurityAdministrators","userGroupObjectId":"SecurityAdministrators","roleNames":["Security","Monitor"],"isBuiltIn":true,"externalGroupName":null,"vpsId":"(system)","scope":["system"]},{"userGroupId":"AuditAdministrators","userGroupObjectId":"AuditAdministrators","roleNames":["Audit","Monitor"],"isBuiltIn":true,"externalGroupName":null,"vpsId":"(system)","scope":["system"]},{"userGroupId":"MonitorUsers","userGroupObjectId":"MonitorUsers","roleNames":["Monitor"],"isBuiltIn":true,"externalGroupName":null,"vpsId":"(system)","scope":["system"]},{"userGroupId":"ServiceAdministrators","userGroupObjectId":"ServiceAdministrators","roleNames":["Storage","Service"],"isBuiltIn":true,"externalGroupName":null,"vpsId":"(system)","scope":["system"]},{"userGroupId":"SystemAdministrators","userGroupObjectId":"SystemAdministrators","roleNames":["Audit","Security","Storage","Monitor","Service","Resource"],"isBuiltIn":true,"externalGroupName":null,"vpsId":"(system)","scope":["system"]},{"userGroupId":"StorageAdministrators","userGroupObjectId":"StorageAdministrators","roleNames":["Storage","Resource"],"isBuiltIn":true,"externalGroupName":null,"vpsId":"(system)","scope":["system"]},{"userGroupId":"UG_ALL","userGroupObjectId":"UG_ALL","roleNames":["Security","Storage","Monitor","Service","Audit","Resource"],"isBuiltIn":false,"externalGroupName":null,"vpsId":"(system)","scope":["system","54665c29-784a-4b71-9b61-2894d55697e9"]},{"userGroupId":"SysSec","userGroupObjectId":"SysSec","roleNames":["Security"],"isBuiltIn":false,"externalGroupName":null,"vpsId":"(system)","scope":["system"]},{"userGroupId":"SysSto","userGroupObjectId":"SysSto","roleNames":["Storage"],"isBuiltIn":false,"externalGroupName":null,"vpsId":"(system)","scope":["system"]},{"userGroupId":"SysMo","userGroupObjectId":"SysMo","roleNames":["Monitor"],"isBuiltIn":false,"externalGroupName":null,"vpsId":"(system)","scope":["system"]},{"userGroupId":"SysAu","userGroupObjectId":"SysAu","roleNames":["Audit"],"isBuiltIn":false,"externalGroupName":null,"vpsId":"(system)","scope":["system"]},{"userGroupId":"SysSer","userGroupObjectId":"SysSer","roleNames":["Service"],"isBuiltIn":false,"externalGroupName":null,"vpsId":"(system)","scope":["system"]},{"userGroupId":"SysRe","userGroupObjectId":"SysRe","roleNames":["Resource"],"isBuiltIn":false,"externalGroupName":null,"vpsId":"(system)","scope":["system"]}]}]}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when no information is obtained.
DESCRIPTION
A list of user group summary information.
PROPERTIES
data:object[]
ITEMS
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
POST /v1/objects/user-groups
Required Role: Security or VpsSecurity
Creates a user group.
None
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X POST -H "Content-Type: application/json" -H "Expect:" -d '{"userGroupId":"testGroup", "roleNames": [ "Service"], "externalGroupName": "testgroup"}' https://192.168.1.100/ConfigurationManager/simple/v1/objects/user-groups
The following shows an example using a json body.
curl -u admin:password -i -X POST -H "Content-Type: application/json" -H "Expect:" -d @example.json https://192.168.1.100/ConfigurationManager/simple/v1/objects/user-groups
example.json is defined as follows:
{
"userGroupId":"testGroup",
"roleNames":
[
"Service"
],
"externalGroupName": "testgroup"
}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
DELETE /v1/objects/user-groups/<userGroupId>
Required Role: Security or VpsSecurity
Deletes a user group.
|
Name |
Description |
Type |
Data type |
|
userGroupId |
User group ID. |
path |
string (1 to 64 chars), must match /^[a-zA-Z0-9!#\$%&'\-\.@\^_`\{\}~]{1,64}$/ required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -X DELETE -u admin:password https://192.168.1.100/ConfigurationManager/simple/v1/objects/user-groups/SampleGroup
Uses default content-types: application/json
Indicates that the request was processed correctly, but no response data to be returned exists.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that an inconsistent or impossible request was issued for the resource specified by URL (for example, creating a resource whose ID is same as the resource already created).
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
GET /v1/objects/user-groups/<userGroupId>
Required Role: Security or VpsSecurity
Obtains the user group information.
|
Name |
Description |
Type |
Data type |
|
userGroupId |
User group ID. |
path |
string (1 to 64 chars), must match /^[a-zA-Z0-9!#\$%&'\-\.@\^_`\{\}~]{1,64}$/ required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -i -u admin:password -X GET https://192.168.1.100/ConfigurationManager/simple/v1/objects/user-groups/SystemAdministrators
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: private, no-store, no-cache, must-revalidate
Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline';
Access-Control-Allow-Methods: GET, POST, DELETE, PATCH
Access-Control-Allow-Headers: Content-Type
Content-Type: application/json
Content-Length: 293
Date: Thu, 20 Oct 2022 06:23:31 GMT
{"memberUsers":[{"userId":"admin","userObjectId":"admin"}],"userGroupId":"SystemAdministrators","userGroupObjectId":"SystemAdministrators","roleNames":["Audit","Security","Storage","Monitor","Service","Resource"],"isBuiltIn":true,"externalGroupName":null,"vpsId":"(system)","scope":["system"]}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when no information is obtained.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
PATCH /v1/objects/user-groups/<userGroupId>
Required Role: Security or VpsSecurity
Edits the user group information.
|
Name |
Description |
Type |
Data type |
|
userGroupId |
User group ID. |
path |
string (1 to 64 chars), must match /^[a-zA-Z0-9!#\$%&'\-\.@\^_`\{\}~]{1,64}$/ required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X PATCH -H "Content-Type: application/json" -H "Expect:" -d '{"roleNames": ["Security","Service","Storage","Audit"]}' https://192.168.1.100/ConfigurationManager/simple/v1/objects/user-groups/groupA
The following shows an example using a json body.
curl -u admin:password -i -X PATCH -H "Content-Type: application/json" -H "Expect:" -d @example.json https://192.168.1.100/ConfigurationManager/simple/v1/objects/user-groups/groupA
example.json is defined as follows:
{
"roleNames":
[
"Security",
"Service",
"Storage",
"Audit"
]
}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that an inconsistent or impossible request was issued for the resource specified by URL (for example, creating a resource whose ID is same as the resource already created).
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
GET /v1/objects/users
Required Role: Security or VpsSecurity
Obtains a list of users.
If external authentication is enabled and "mappingMode" is set to "Group", the users on the external authentication server are not included in the output list and only the users whose "authentication" is "local" are included in the output list.
|
Name |
Description |
Type |
Data type |
|
vpsId |
The ID of the virtual private storage (VPS) that the acquisition-target resource belongs to. To filter out the resources that do not belong to the VPS, specify "system". To filter the resources by the VPS that the resources belong to, specify it in UUID format. |
query |
string , must match /^system$|^[A-Fa-f0-9]{8}(-[A-Fa-f0-9]{4}){3}-[A-Fa-f0-9]{12}$/ |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -i -u admin:password -X GET https://192.168.1.100/ConfigurationManager/simple/v1/objects/users
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: private, no-store, no-cache, must-revalidate
Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline';
Access-Control-Allow-Methods: GET, POST, DELETE, PATCH
Access-Control-Allow-Headers: Content-Type
Content-Type: application/json
Content-Length: 3194
Date: Thu, 20 Oct 2022 06:19:29 GMT
{"data":[{"userId":"admin","userObjectId":"admin","passwordExpirationTime":"2022-11-30T07:21:21Z","isEnabled":true,"userGroups":[{"userGroupId":"SystemAdministrators","userGroupObjectId":"SystemAdministrators"}],"isBuiltIn":true,"authentication":"local","roleNames":["Security","Storage","Monitor","Service","Audit","Resource"],"isEnabledConsoleLogin":null,"vpsId":"(system)","privileges":[{"scope":"system","roleNames":["Audit","Security","Storage","Monitor","Service","Resource"]}]}]}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when no information is obtained.
DESCRIPTION
A list of user information.
PROPERTIES
data:object[]
ITEMS
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
POST /v1/objects/users
Required Role: Security or VpsSecurity
Creates a user.
None
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X POST -H "Content-Type: application/json" -H "Expect:" -d '{"userId":"testUser", "password":"testPassword", "userGroupIds": [ "SecurityAdministrators"], "authentication": "external"}' https://192.168.1.100/ConfigurationManager/simple/v1/objects/users
The following shows an example using a json body.
curl -u admin:password -i -X POST -H "Content-Type: application/json" -H "Expect:" -d @example.json https://192.168.1.100/ConfigurationManager/simple/v1/objects/users
example.json is defined as follows:
{
"userId":"testUser",
"password":"testPassword",
"userGroupIds":
[
"SecurityAdministrators"
],
"authentication": "external"
}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that an inconsistent or impossible request was issued for the resource specified by URL (for example, creating a resource whose ID is same as the resource already created).
Indicates that the Content-Length header must be specified. It is returned when the request body was not specified and "Content-Length: 0" was not specified as the header parameter.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
DELETE /v1/objects/users/<userId>
Required Role: Security or VpsSecurity
Deletes a user.
If you do not have access permission for the virtual private storage (VPS) that the specified user belongs to, HTTP status code 404 (Not Found) is returned.
|
Name |
Description |
Type |
Data type |
|
userId |
User ID. |
path |
string (5 to 255 chars), must match /^[\-A-Za-z0-9!#\$%&'\.@\^_`\{\}~]{5,255}$/ required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -X DELETE -u admin:password https://192.168.1.100/ConfigurationManager/simple/v1/objects/users/sample-user
Uses default content-types: application/json
Indicates that the request was processed correctly, but no response data to be returned exists.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that an inconsistent or impossible request was issued for the resource specified by URL (for example, creating a resource whose ID is same as the resource already created).
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
GET /v1/objects/users/<userId>
Required Role: None
Obtains the user information.
If you have the Security or VpsSecurity role, in this API, you can specify the user ID of any user in your accessible range. If you do not have the Security or VpsSecurity role, you can specify only your own user ID. If you specify a user ID other than your own, HTTP status code 403 (Forbidden) is returned regardless of whether the specified user ID exists.
If you specify a user on the external authentication server in the API when external authentication is enabled and "mappingMode" is set to "Group", HTTP status code 404 (Not Found) is returned.
If "self" is specified for userId, information about the user who was authenticated when this API was issued is returned.
|
Name |
Description |
Type |
Data type |
|
userId |
User ID. |
path |
string (up to 255 chars), must match /^self$|^[\-A-Za-z0-9!#\$%&'\.@\^_`\{\}~]{5,255}$/ required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -i -u admin:password -X GET https://192.168.1.100/ConfigurationManager/simple/v1/objects/users/admin
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: private, no-store, no-cache, must-revalidate
Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline';
Access-Control-Allow-Methods: GET, POST, DELETE, PATCH
Access-Control-Allow-Headers: Content-Type
Content-Type: application/json
Content-Length: 475
Date: Thu, 20 Oct 2022 06:24:53 GMT
{"userId":"admin","userObjectId":"admin","passwordExpirationTime":"2022-11-30T07:21:21Z","isEnabled":true,"userGroups":[{"userGroupId":"SystemAdministrators","userGroupObjectId":"SystemAdministrators"}],"isBuiltIn":true,"authentication":"local","roleNames":["Security","Storage","Monitor","Service","Audit","Resource"],"isEnabledConsoleLogin":null,"vpsId":"(system)","privileges":[{"scope":"system","roleNames":["Audit","Security","Storage","Monitor","Service","Resource"]}]}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
PATCH /v1/objects/users/<userId>
Required Role: Security or VpsSecurity
Edits the user information.
When the password is changed for the API, if requiresInitialPasswordReset of the user authentication settings is true, the password of the user expires.
The expired password can be recovered by using the password changing API(PATCH /v1/objects/users/<userId>/password) or CLI(user_password_set) of the local user.
If you do not have access permission for the virtual private storage (VPS) that the specified user belongs to, HTTP status code 404 (Not Found) is returned.
|
Name |
Description |
Type |
Data type |
|
userId |
User ID. |
path |
string (5 to 255 chars), must match /^[\-A-Za-z0-9!#\$%&'\.@\^_`\{\}~]{5,255}$/ required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X PATCH -H "Content-Type: application/json" -H "Expect:" -d '{"isEnabled": true}' https://192.168.1.100/ConfigurationManager/simple/v1/objects/users/admin
The following shows an example using a json body.
curl -u admin:password -i -X PATCH -H "Content-Type: application/json" -H "Expect:" -d @example.json https://192.168.1.100/ConfigurationManager/simple/v1/objects/users/admin
example.json is defined as follows:
{
"isEnabled": true
}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that an inconsistent or impossible request was issued for the resource specified by URL (for example, creating a resource whose ID is same as the resource already created).
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
POST /v1/objects/users/<userId>/actions/add-user-group/invoke
Required Role: Security or VpsSecurity
Adds a user to a user group.
If you do not have access permission for the virtual private storage (VPS) that the specified user belongs to, HTTP status code 404 (Not Found) is returned.
|
Name |
Description |
Type |
Data type |
|
userId |
User ID. |
path |
string (5 to 255 chars), must match /^[\-A-Za-z0-9!#\$%&'\.@\^_`\{\}~]{5,255}$/ required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X POST -H "Content-Type: application/json" -H "Expect:" -d '{"userGroupIds": ["StorageAdministrators"]}' https://192.168.1.100/ConfigurationManager/simple/v1/objects/users/userAA/actions/add-user-group/invoke
The following shows an example using a json body.
curl -u admin:password -i -X POST -H "Content-Type: application/json" -H "Expect:" -d @example.json https://192.168.1.100/ConfigurationManager/simple/v1/objects/users/userAA/actions/add-user-group/invoke
example.json is defined as follows:
{
"userGroupIds":
[
"StorageAdministrators"
]
}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that an inconsistent or impossible request was issued for the resource specified by URL (for example, creating a resource whose ID is same as the resource already created).
Indicates that the Content-Length header must be specified. It is returned when the request body was not specified and "Content-Length: 0" was not specified as the header parameter.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
POST /v1/objects/users/<userId>/actions/delete-user-group/invoke
Required Role: Security or VpsSecurity
Deletes a user from a user group.
If you do not have access permission for the virtual private storage (VPS) that the specified user belongs to, HTTP status code 404 (Not Found) is returned.
|
Name |
Description |
Type |
Data type |
|
userId |
User ID. |
path |
string (5 to 255 chars), must match /^[\-A-Za-z0-9!#\$%&'\.@\^_`\{\}~]{5,255}$/ required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X POST -H "Content-Type: application/json" -H "Expect:" -d '{"userGroupIds": ["groupA"]}' https://192.168.1.100/ConfigurationManager/simple/v1/objects/users/userAA/actions/delete-user-group/invoke
The following shows an example using a json body.
curl -u admin:password -i -X POST -H "Content-Type: application/json" -H "Expect:" -d @example.json https://192.168.1.100/ConfigurationManager/simple/v1/objects/users/userAA/actions/delete-user-group/invoke
example.json is defined as follows:
{
"userGroupIds":
[
"groupA"
]
}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that an inconsistent or impossible request was issued for the resource specified by URL (for example, creating a resource whose ID is same as the resource already created).
Indicates that the Content-Length header must be specified. It is returned when the request body was not specified and "Content-Length: 0" was not specified as the header parameter.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
PATCH /v1/objects/users/<userId>/password
Required Role: None
Changes the password of the local user.
You can execute this API only for a user whose "authentication" is set to "local". If you execute the API for a user whose "authentication" is set to "external", HTTP status code 401 (Unauthorized) is returned.
For security reasons, HTTP status code 401 (Unauthorized) is returned even if an invalid password is specified as the current password or a non-existent user is specified as userID.
|
Name |
Description |
Type |
Data type |
|
userId |
user ID. |
path |
string (5 to 255 chars), must match /^[\-A-Za-z0-9!#\$%&'\.@\^_`\{\}~]{5,255}$/ required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X PATCH -H "Content-Type: application/json" -H "Expect:" -d '{"currentPassword":"password","newPassword":"new-password"}' https://192.168.1.100/ConfigurationManager/simple/v1/objects/users/admin/password
The following shows an example using a json body.
curl -u admin:password -i -X PATCH -H "Content-Type: application/json" -H "Expect:" -d @example.json https://192.168.1.100/ConfigurationManager/simple/v1/objects/users/admin/password
example.json is defined as follows:
{
"currentPassword":"password",
"newPassword":"new-password"
}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.