Create

POST v1/chap_users

Description

Create a new CHAP user, which is then assigned to an access control record for a volume. CHAP user authentication requires a CHAP secret that agrees as the challenge response.

Normal Response Codes

201

HTTP Error Codes

400 401 403 404 409 500 503

Detail Codes

SM_cannot_read_object

SM_eexist

SM_invalid_arg_value

SM_invalid_path_variable

SM_invalid_query_param

SM_iscsi_svc_not_available

SM_malformed_url

SM_missing_arg

SM_no_method_for_URL_pattern

SM_no_operation_found

SM_unexpected_query_param

SM_version_name

Request

Parameter	Type	JSON Type	Description	Default	Mandatory
name	NsObjectName	string	Name of CHAP user. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.		true
description	NsDescription	string	Text description of CHAP user. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.	''	false
password	NsChapPassword	string	CHAP secret.The CHAP secret should be between 12-16 characters and cannot contain spaces or most punctuation. String of 12 to 16 printable ASCII characters excluding ampersand and ^[];`. Example: 'password_25-24'.		true

JSON Request

            

{
   "data" : {
      "password" : "012345678901",
      "name" : "chapuser0.692928845369355"
   }
}

Response

Parameter	Type	JSON Type	Description
id	NsObjectID	string	Identifier for the CHAP user. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
name	NsObjectName	string	Name of CHAP user. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
full_name	NsObjectName	string	CHAP user's fully qualified name. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
search_name	NsSearchName	string	CHAP user name used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'.
description	NsDescription	string	Text description of CHAP user. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.
creation_time	NsTime	number	Time when this CHAP user was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
last_modified	NsTime	number	Time when this CHAP user was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
vol_list	NsVolumeList	Array of NsVolumeSummary	List of volumes associated with this CHAP user. List of volumes.
vol_count	NsUnsignedLong	number	Count of volumes associated with this CHAP user. Unsigned 64-bit integer. Example: 1234.

JSON Response

            

{
   "data" : {
      "search_name" : "chapuser0.692928845369355",
      "name" : "chapuser0.692928845369355",
      "last_modified" : 1426776473,
      "id" : "0100000000000004d3000000000000000000000001",
      "creation_time" : 1426776473,
      "full_name" : "",
      "description" : ""
   }
}