Credential-access (Section)#
Path: /facilities/data-sources/data-source{id}/json/credential-access
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| backend-verifies-password | boolean | optional | true | If set to true, the backend will verify the password. It is required the server responds with HTTP Success to indicate a successful password verification.If set to false the password will not be sent to the server and the response should contain both the username, password and the status of the account. |
| password-parameter | string | optional | password | Name of the parameter that will contain the password in a query. |
| submit-as | enumeration | optional | post-as-json | Specify how username and password are provided to the server. This sets both the HTTP method that is used, as well as the content-type that the data is encoded with |
| tenant-id-parameter | string | optional | Name of the parameter that will contain the tenant ID in a query. | |
| url-path | string | optional | / | The path relative to the webservice context to make the request to. The path may contain the :subject, :password and :tenantId placeholders, which are substituted with username, password and tenant ID, respectively. On password verification, the :password placeholder is only substituted when ‘backend-verifies-password’ is set to true (the default). |
| username-parameter | string | optional | username | Name of the parameter that will contain the username in a query. |