This is an archive version of the document. To get the most up-to-date information, see the current version.Validating Username
This section explains how to check if the user name that you want to use satisfies Veeam Backup for Microsoft Azure validation criteria.
Request
POST https://<hostname>/api/v1/users/validateName |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
None.
Request Body
Property | Type | Description |
name | string | Sets the name to be validated. |
Request Example
Request: POST https://<hostname>/api/v1/users/validateName
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "name": "Authenticationaccount" } |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Examples
If the specified name satisfies validation criteria, nothing will be returned.
If the specified name already exists, the following response will be returned.
Response: 200 OK
Response Body: [{ "severity": "Error", "message": "User 'Authentication' already exists.", "contextId": "" }] |
If the specified name does not satisfy validation criteria, the following response will be returned.
Response: 200 OK
Response Body: [{ "severity": "Error", "message": "Name contains invalid characters ( )", "contextId": "" }] |