The REST API provides the following methods for managing the web service user store:

PUT /admin/webservices/users

URI

PUT /admin/webservices/users

Description

Clears the existing web service user store and loads the provided one.

Request Header

Content-Type: application/xml
CSRF Protection Enabled

Content-Type: application/vnd.orchestral.rhapsody.6_1+xml

Request Parameter

commitComment - a string containing the comment to use for the commit.
Request Body

The content of the web service user store in XML format:

<WebServicesUserStore version="5">
    <passwordStorageTechnique>STORE_HASHED_PASSWORDS</passwordStorageTechnique>
    <user>
        <id>0</id>
        <name>b1</name>
        <password/>
    </user>
    <user>
		<id>1</id>
		<name>b2</name>
		<password isVariable="true">$(bingpwd)</password>
    </user>
    <user>
        <id>2</id>
        <name>b3</name>
        <password isVariable="true">$(bingpwd)</password>
        <certificateAlias>rest</certificateAlias>
    </user>
    <user>
		<id>3</id>
		<name>b3</name>
		<password></password>
	</user>
	<user>
		<id>4</id>
		<name>b4</name>
		<password>ToraTora</password>
    </user>
</WebServicesUserStore>

Response Status

204 No Content - the web service user store was loaded successfully.
Response Body Empty.

Access Rights

'Load web services users REST API.'

GET /admin/webservices/users

URI

GET /admin/webservices/users

Description

Returns the web service user store with the passwords omitted.

Request Header

Accept: application/xml

Accept: application/vnd.orchestral.rhapsody.6_1+xml

Request Body

Empty.

Response Status

200 OK - returns the web service user store information in XML format.
Response Body 
<WebServicesUserStore version="5">
  <passwordStorageTechnique>STORE_ENCRYPTED_PASSWORDS</passwordStorageTechnique>
  <user>
    <id>0</id>
    <name>anna</name>
    <password isVariable="true">$(a)</password>
  </user>
  <user>
    <id>1</id>
    <name>bob</name>
    <password/>
  </user>
  <user>
    <id>2</id>
    <name>sally</name>
    <password/>
  </user>
</WebServicesUserStore>

Access Rights

'Save web services users REST API.'