SignInReadOnly
POST {{Host}}/AutodeskDM/Services/Filestore/v26/AuthService.svc
Authenticates to a specific Vault in Read-Only mode via username and password.
Read-Only mode does not consume a Vault License and is used when the API only needs to read Vault data.
You can use the SignIn API call to sign in using a Vault license if there is a need to modify Vault data.
Reading data is still limited to the permissions of the logged in Vault user.
Returns
The Response will return a Ticket and UserId that will need to be passed via the SecurityHeader of each subsequent API call.
Parameters
dataServer
Required String
The Vault Server (Host) name. Can be either an IP address, Fully qualified domain >name, or Alias.
userName
Required String
The Vault User's login name for the Vault.
User must already exist in the Vault users database.
userPassword
Required String
The password related to the Vault User attempting to log in.
User must already exist in the Vault users database.
knowledgeVault
Required String
The name of the Vault Database to be logged into.
Error Responses Values
Below are common error codes that can be returned for this request.
| Error Code | Name | Description |
|---|---|---|
| 106 | TransactionInvalidPrincipal | An example would be making a call without being logged into a vault for methods that require a vault or excluding the SecurityHeader in a SOAP based API call. |
| 300 | BadAuthenticationToken | This can happen when the web services are restarted, a user has logged out, or a bad token is supplied in the SecurityHeader. |
| 301 | InvalidUserPassword | Username and/or Password is invalid, so user cannot be authenticated. |
| 302 | UserNotVaultMember | User is not a member of the vault. |
Note: You need to supply a 0 (Zero) to both the Ticket and UserId elements of the SecurityHeader in the original SignIn request or it will fail.
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
SOAPAction | string |
RESPONSES
status: OK
"\u003cs:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\"\u003e\n \u003cs:Header\u003e\n \u003cSecurityHeader xmlns=\"http://AutodeskDM/Services\"\u003e\n \u003cTicket\u003e66dc8b10-8017-437e-8902-6a35aed7633b\u003c/Ticket\u003e\n \u003cUserId\u003e203\u003c/UserId\u003e\n \u003c/SecurityHeader\u003e\n \u003c/s:Header\u003e\n \u003cs:Body xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\u003e\n \u003cSignInResponse xmlns=\"http://AutodeskDM/Filestore/Auth/1/7/2020/\"/\u003e\n \u003c/s:Body\u003e\n\u003c/s:Envelope\u003e\n"