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 404 409 500 503
Detail Error Codes
Request
| Parameter | Type | JSON Type | Description | Default | Mandatory | Deprecated |
|---|---|---|---|---|---|---|
| name | NsObjectName | string | Name of CHAP user. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | Yes | ||
| description | NsDescription | string | Text description of CHAP user. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | '' | No | |
| 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'. | Yes |
JSON Request
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| 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'. |
JSON Response