5. RESTful API

Access Control offers increased control and flexibility through the support of a RESTful API, delivered over HTTP(S) via the same port that is used for the admin console (6444 by default).

A RESTful API web service uses HTTP and the principles of REST to facilitate interaction between client and server, running with the following principles:

• All calls use the base URI:

  http(s)://<server-host>:<server-port>/rest/v1.0/<resource> 

• The Internet media type of the data supported by the web service.
• The API must be hypertext driven, using the following HTTP methods:

Type	Action
POST	to create a resource on the server
GET	to retrieve a resource from the server
PUT	to modify the state of a resource
DELETE	to remove a resource

Examples

Change the password for user "bfoster" to "newpassword":

curl -X POST -d
"password=newpassword&authusername=admin&authpassword=admin"
http://10.2.5.73:6444/rest/v1.0/users/bfoster?action=passwordUpdate

Add user "aaxley" with password "changepassword", email "db@thefirm.com" and System Admin Status set to "false":

curl -X POST -d
"fullname=Abi%20Axley&password=changepassword&email=db@thefirm.com&isSysAdmin=false&authusername=admin&authpassword=admin"
http://10.2.5.73:6444/rest/v1.0/users/aaxley

5.1 Synchronisation

5.1.1 Sync Stop

Description: Initiate a synchronized stop. This action applies only when Access Control is running as part of WANdisco's Subversion MultiSite. Read more about the Synchronized Stop.

Path:

http(s)://<server-host>:<server-port>/rest/v1.0/sync/stop

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
members=#List<node-name>


parameters support multiple names
Lists of parameters can be specified in the request by using the parameter name multiple times e.g. members=node1&members=node2&members=node3.

quorum=true|false


Successful Response:

200 - Success

Error Response:

400 - Bad Request - Some element of the request was invalid, see response message for detailed error message.
401 - Unauthorized Access

Example:

curl -X POST -d "authusername=<username>&authpassword=<password>" http://<nodeIP>:6444/rest/v1.0/sync/stop

5.1.2 Sync Resume

Description: Restart replication after the completion of a synchronized stop. This action applies when Access Control is running as part of WANdisco's Subversion MultiSite. Read more about the Resuming from a Synchronized Stop.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/sync/resume

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>


Successful Response:

200 - Success

Error Response:

401 - Unauthorized Access

Example:

curl -X POST -d "authusername=<username>&authpassword=<password>" http://<nodeIP>:6444/rest/v1.0/sync/resume

5.1.3 Sync Status

Description: Get the current status of the syncronization between MultiSite nodes. This command is applicable when Access Control is running with WANdisco's Subversion MultiSite.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/sync/status

Type:

GET

Parameters:

authusername=<valid username> authpassword=<valid password>


Successful Response:

200 - Success

Error Response:

401 - Unauthorized Access

Example:

curl "http://<nodeIP>:6444/rest/v1.0/sync/status?authusername=<username>&authpassword=<password>"

5.1.4 Toggle LDAP login authentication

Description: Switch the "Use LDAP for login authentication" setting to either on (true) or off (false).

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/system/toggleprerepldap

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
value=<setting-value>

Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status.
401 - Unauthorized Access

Example:

curl -X POST -d "authusername=<username>&authpassword=<password>&value=<true|false>" http://<nodeIP>:6444/rest/v1.0/system/toggleprerepldap 
 

5.1.5 Toggle LDAP admin authentication

Description: This command toggles the use of LDAP authorities to authenticate administrators Switch the LDAP admin authentication state - setting it either on (true) or off (false).

Prequisite Must have a LDAP authority specified and must have at least one LDAP user with admin privileges.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/system/toggleldapadmin

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
value=true|false

Successful Response: See message for detailed status

200 - Success

Error Response:

400 - Bad Request - See message for detailed status.
401 - Unauthorized Access

Example:

curl -X POST -d "authusername=<LDAP username>&authpassword=<password>&value=<true|false>" http://<nodeIP>:6444/rest/v1.0/system/toggleldapadmin

5.2.1 Get User

Description: Get a selected Subversion user.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/users/{username}

Type:

GET

Parameters:

authusername=<valid username>
authpassword=<valid password>
includePendingChanges=true|false

Successful Response:

200 - Success - UserRSDTO (REST Data Transfer Object)

Error Response:

401 - Unauthorized Access
404 - Not Found

Example

   curl "http://<nodeIP>:6444/rest/v1.0/users/<user>?authusername=<username>&authpassword=<password>"
 

5.2.2 Get All Users

Description: Get all Subversion user, lists all known users on that node.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/users

Type:

GET

Parameters:

authusername=<valid username>
authpassword=<valid password>
includePendingChanges=true|false

Successful Response:

200 - Success - UserRSDTO (REST Data Transfer Object)

Error Response:

401 - Unauthorized Access
404 - Not Found

Example

    curl "http://<nodeIP>:6444/rest/v1.0/users?authusername=<username>&authpassword=<password>"
 

5.2.3 Update User

Description: Update a selected Subversion user.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/users/{username}

Type:

PUT

Parameters:

authusername=<valid username>
password=<user password>
fullname=<user's full name>
email=<email>
includePendingChanges=true|false
localuser=true|false

Successful Response:

200 - Success - See message for detailed status

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access 404 - Not Found

Example:

curl -X PUT -d "authusername=<username>&authpassword=<password>&password=<passwordToUpdate>&fullname=<fullnameToUpdate>&email=<emailToUpdate>&localuser=true" http://<nodeIP>:6444/rest/v1.0/users/<user>

5.2.4 Delete User

Description: Delete a specified Subversion user.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/users/{username}

Type:

DELETE

Parameters:

authusername=<valid username>
authpassword=<valid password>
includePendingChanges=true|false
localuser=true|false

Successful Response:

200 - Success

Error Response:

401 - Unauthorized Access
404 - Not Found

Example:

	curl -X DELETE "http://<nodeIP>:6444/rest/v1.0/users/<user>?authusername=<username>&authpassword=<password>"    

5.2.5 Create User

Description: Create a new Subversion user.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/users/{username}

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
fullname=<Users Full Name>
password=<Users Password>
email=<Users Email>
isSysAdmin=true|false
includePendingChanges=true|false
localuser=true|false

Successful Response:

200 - Success - See message for detailed status.

Error Response:

401 - Unauthorized Access
400 - Bad Request - See message for detailed status.

Example:

    curl -X POST -d "authusername=<username>&authpassword=<password>&password=<password>&fullname=<fullname>&email=<email>&localuser=<true> "http://<nodeIP>:6444/rest/v1.0/users/<user>
    

5.2.6 Update User Password

Description: Update a Subversion user's current password.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/users/{username}?action=passwordUpdate



Type:

POST

Parameters:

authusername=<valid username>
authpassword=<valid password>
action=passwordUpdate
password=<Users Password>
includePendingChanges=true|false

Successful Response:

200 - Success

Error Response:

401 - Unauthorized Access

Example:

curl -X POST -d "authusername=<username>&authpassword=<password>&password=<newPassword>" http://<nodeIP>:6444/rest/v1.0/users/<user>?action=passwordUpdate

5.2.7 Update User Password (Unencrypted)

Description: Update a user's password, in an unencrypted form.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/users/{username}?action=passwordUpdateUnencrypted


Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
action=passwordUpdateUnencrypted
password=<Users Password>
includePendingChanges=true|false

Successful Response:

200 - Success - See message for detailed status

Error Response:

400 - Bad Request - See message for detailed status.
401 - Unauthorized Access
404 - Not Found

Example:

    curl -X POST -d "authusername=<username>&authpassword=<password>&password=<newPassword>" http://<nodeIP>:6444/rest/v1.0/users/<user>?action=passwordUpdateUnencrypted

5.2.8 Toggle System Administrator Permission

Description: Toggle administrator permission for the specified user.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/users/{username}?action=permissionUpdate"

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
action=permissionUpdate
isSysAdmin=true|false
includePendingChanges=true|false

Successful Response:

200 - Success - See message for detailed status

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found



Example:


curl -X POST -d "authusername=<username>&authpassword=<password>&isSysAdmin=<true|false>" http://<nodeIP>:6444/rest/v1.0/users/<user>?action=permissionUpdate

5.2.9 Enable User

Description: Enable a Subversion user who is currently in a disabled state.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/users/{username}?action=enable

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
action=enable
includePendingChanges=true|false

Successful Response:

200 - Success - See message for detailed status

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found


Example:

 curl -X POST -d "authusername=<username>&authpassword=<password>" http://<nodeIP>:6444/rest/v1.0/users/<user>?action=enable
    

5.2.10 Disable User

Description: Disable a Subversion user, stopping them from accessing repository data.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/users/{username}?action=disable

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
action=disable
includePendingChanges=true|false

Successful Response:

200 - Success - See message for detailed status

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found


Example:

 curl -X POST -d "authusername=<username>&authpassword=<password>" http://<nodeIP>:6444/rest/v1.0/users/<user>?action=disable

5.2.11 Generic File Replication

Description: Replicate generic files (Authz files etc, not repository changes) to all nodes.

Prerequisite: The setting "Use generic file replication" in the System Settings page must to be enabled.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/filenotifier

Type:

GET

Parameters:

authusername=<valid username> authpassword=<valid password>
fileLocation=<source-file-location>
fileDestination=<destination-file-location>


Successful Response:

200 - Success - See message for detailed status

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found


Example:

curl "http://<nodeIP>:6444/rest/v1.0/filenotifier?authusername=<username>&authpassword=<password>&fileLocation=%2Fopt%2Fsvnauthfiles%2Fauthz.authz&fileDestination=%2Fopt%2Fsvnauthfiles%2Fauthz.authz.bak"

5.2.12 Auto skip bypassable transactions

Description: Toggle the "Auto skip bypassable transactions" setting in the System Settings page.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/system/toggleautobypass

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
value=true|false

Successful Response:

200 - Success - See message for detailed status

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found


Example:

curl -X POST -d "authusername=<username>&authpassword=<password>&value=<true|false>" http://<nodeIP>:6444/rest/v1.0/system/toggleautobypass
 

5.2.13 Change the Distinguished Node

Description: A call that allows the distinguish node to be changed:

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/replication/changeDistinguishedNode


Type:

POST

Parameters:

authusername=<valid username>
authpassword=<valid password>
newdnip=<The new Distinguished Node's IP Address

Successful Response:

200 - Success - See message for detailed status

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found


Example:

curl -X POST -d "authusername=<username>&authpassword=<password>&newdnip=<newNodeIP>" http://<nodeIP>:6444/rest/v1.0/replication/?action=changeDistinguishedNode

5.2.14 List Disabled Users

Description: A call that will create a list of all users who are currently disabled:

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/users/disabledUsers?


Type:

GET

Parameters:

authusername=<valid username>
authpassword=<valid password>


Successful Response:

200 - Success - See message for detailed status

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found


Example:

curl "http://<nodeIP>:6444/rest/v1.0/users/admins?authusername=admin&authpassword=disabledUsers?"

5.2.15 List Admin Users

Description: A call that will create a list of all users who are currently assigned as System Administrators (within SVN MultiSite):

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/users/admin?


Type:

GET

Parameters:

authusername=<valid username>
authpassword=<valid password>


Successful Response:

200 - Success - See message for detailed status

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found


Example:

curl "http://<nodeIP>:6444/rest/v1.0/users/admins?authusername=admin&authpassword=admin"

5.2.16 Search repository access information

Description: The call provides you with users' access and permissions information. Any user can call this end point by supplying their username and password. SVN MultiSite Plus will get the rules associated with that user and based on their permissions return the results:

pathName=/svn(|/.), permission=RW
pathName=/svn/engineering(|/.), permission=R

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/search?


Type:

GET

Parameters:

authusername=<valid username>
authpassword=<valid password>
PendingChanges=<true/false>

Successful Response:

200 - Success - See message for detailed status

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found


Example 1:

What's the state of my account (active/deactivated), what repositories do I have access to, with what level of access (RO/RW)?

curl -X GET -d  "http://localhost:6444/rest/v1.0/search?authusername=admin&authpassword=admin&includePendingChanges=false"

Output:

 <resourcePermissionRSDTOes>
<resourcePermissionRSDTO>
<pathName>
RuleDAO [parentTeamName=testteam, ruleName=teamrule, ipPattern=, dateCreated=null,
lastModified=null, createdByUsername=null, disabled=false, users=null, resourcePermissions=null]
</pathName>
<permission>
ResourcePermissionDAO [pathName=/svn(|/.*), permission=RW]
</permission>
</resourcePermissionRSDTO>
</resourcePermissionRSDTOes>   

Example 2:

I need access (RO/RW) to a specific repository – what LDAP/Active Directory Groups give will provide that access and who is the owner?

Any user can call this end point supplying their username and password and pathName e.g. /svn/engineering. MultiSite Plus will search the teams for matching rules/permissions and return the teams and team leaders that would allow them access.

curl -X GET -d "http://localhost:6444/rest/v1.0/search/svn/repo-path?authusername=admin&authpassword=admin&includePendingChanges=true"   

Output

<teamRSDTOes>
    <teamRSDTO>
        <description/>
        <id>f864e389-52bb-11e3-ade3-e6e915ec3433_10</id>
            <ldapAuthority>
            <adminAuthority>false</adminAuthority>
            <bindPassword>[REDACTED]</bindPassword>
            <bindUserName/>
            <caseSensitive>false</caseSensitive>
            <connectionUrl>
                ldap://10.2.2.42:389/cn=WANdisco Users,dc=wandisco,dc=com?uid
            </connectionUrl>
            <disabled>false</disabled>
            <emailAddressAttribute/>
            <firstNameAttrbute/>
            <lastNameAttribute/>
            <patternOrder>100</patternOrder>
            <regularExpression>.*</regularExpression>
            </ldapAuthority>
            <ldapFilter>cn=k*</ldapFilter>
            <ldapManagingNode>
                <available>false</available>
                <guid>7d925f40-51e2-11e3-bdf9-9a321ad90e3a</guid>
                <host>0.0.0.0</host>
                <name>Gavs_MacBook_Pro_local</name>
                <port>6444</port>
            </ldapManagingNode>
        <ldapPopulated>true</ldapPopulated>
        <name>LDAP Team</name>
        <teamLeaders>
            <addResources>false</addResources>
            <createSubteams>false</createSubteams>
            <createUsers>false</createUsers>
            <disableUsers>false</disableUsers>
            <fullName>null null</fullName>
            <modifyRules>true</modifyRules>
            <modifyUsers>false</modifyUsers>
            <teamId>f864e389-52bb-11e3-ade3-e6e915ec3433_10</teamId>
            <teamName>LDAP Team</teamName>
            <userName>ksheehan</userName>
        </teamLeaders>
    </teamRSDTO>
    <teamRSDTO>
        <description/>
        <id>91d031a2-51f3-11e3-ba4a-edb937704f92_3</id>
        <ldapPopulated>false</ldapPopulated>
        <name>testteam</name>
        <teamLeaders>
            <addResources>false</addResources>
            <createSubteams>false</createSubteams>
            <createUsers>false</createUsers>
            <disableUsers>false</disableUsers>
            <fullName>null null</fullName>
            <modifyRules>true</modifyRules>
            <modifyUsers>false</modifyUsers>
            <teamId>91d031a2-51f3-11e3-ba4a-edb937704f92_3</teamId>
            <teamName>testteam</teamName>
            <userName>admin</userName>
        </teamLeaders>
        <teamLeaders>
            <addResources>false</addResources>
            <createSubteams>false</createSubteams>
            <createUsers>false</createUsers>
            <disableUsers>false</disableUsers>
            <fullName>test </fullName>
            <modifyRules>true</modifyRules>
            <modifyUsers>false</modifyUsers>
            <teamId>91d031a2-51f3-11e3-ba4a-edb937704f92_3</teamId>
            <teamName>testteam</teamName>
            <userName>test</userName>
        </teamLeaders>
    </teamRSDTO>
</teamRSDTOes>

Example 3:

An Auditor queries who has access to the repositories and what is the access? The Audit or Admin user supplies their username and password and the parameter * = wildcard all repositories or a repository name. Repositories along with rules and users are returned.

curl -X GET -d "http://localhost:6444/rest/v1.0/search/svn/access?authusername=admin&authpassword=admin&includePendingChanges=true"

Output

<teamRuleRSDTOes>
	<rule>
		<id>17266dd6-536a-11e3-b1b4-bfee9cc62fb5_7</id>
		<rule-name>Rule2</rule-name>
		<team-name>testteam</team-name>
		<ip-pattern/>
		<ip-pattern-option>NoRestrictions</ip-pattern-option>
		<disabled>false</disabled>
		<apply-to-all-users>false</apply-to-all-users>
		<users>
		<user>admin</user>
		</users>
		<resource-permissions>
		<resourcePermissions>
		<pathName>/svn(|/.*)</pathName>
		<permission>D</permission>
		</resourcePermissions>
		</resource-permissions>
	</rule>
	<rule>
		<id>bcc85130-52cb-11e3-b12f-6711daecb2be_10</id>
		<rule-name>gav</rule-name>
		<team-name>LDAP Team</team-name>
		<ip-pattern/>
		<ip-pattern-option>NoRestrictions</ip-pattern-option>
		<disabled>false</disabled>
		<apply-to-all-users>true</apply-to-all-users>
		<users>
		<user>ksheehan</user>
		</users>
		<resource-permissions>
		<resourcePermissions>
		<pathName>/svn(|/.*)</pathName>
		<permission>RO</permission>
		</resourcePermissions>
		</resource-permissions>
	</rule>
	<rule>
		<id>cc8e874c-529e-11e3-aac7-6cc55f382da7_7</id>
		<rule-name>teamrule</rule-name>
		<team-name>testteam</team-name>
		<ip-pattern/>
		<ip-pattern-option>NoRestrictions</ip-pattern-option>
		<disabled>false</disabled>
		<apply-to-all-users>true</apply-to-all-users>
		<users>
		<user>test</user>
		<user>admin</user>
		</users>
		<resource-permissions>
		<resourcePermissions>
		<pathName>/svn(|/.*)</pathName>
		<permission>RW</permission>
		</resourcePermissions>
		</resource-permissions>
	</rule>
</teamRuleRSDTOes>    

5.3 LDAP

5.3.1 Get All LDAP Authorities

Description: Get all LDAP Authorities.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/ldapauthorities

Type:

GET

Parameters:

authusername=<valid username> authpassword=<valid password>


Successful Response:

200 - Success

Error Response:

401 - Unauthorized Access
404 - Not Found - No resources found

Example:

 curl "http://<nodeIP>:6444/rest/v1.0/ldapauthorities?authusername=<username>&authpassword=<password>"

5.3.2 Get LDAP Authority

Description: Get a an LDAP Authority.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/ldapauthorities/{order}

Type:

GET

Parameters:

authusername=<valid username> authpassword=<valid password>


Successful Response:

200 - Success - LDAPAuthorityRSDTO (REST Data Transfer Object)

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - No resources found


Example

curl "http://<nodeIP>:6444/rest/v1.0/ldapauthorities/<LdapOrder>?authusername=<username>&authpassword=<password>"

5.3.3 Update LDAP Authority

Description: Update a selected LDAP authority.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/ldapauthorities/{order}

Type:

PUT

Parameters:

authusername=<valid username> authpassword=<valid password>
order=<order-number>
url=<url>
bindDn=<bindDn>
bindPass=<bindPass>
firstNameAttr=<First Name Attribute>
lastNameAttr=<Last Name Attribute>
emailAttr=<Email Attribute>


Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found


Example:

   curl -X PUT -d "authusername=<username>&authpassword=<password>&order=<newLdapOrder>&url=<newUrl>&bindDn=<newBindDN>&bindPass=<newBindPassword>&firstNameAttr=<newFirstNameAttribute>&lastNameAttr=<newLastNameAttribute>&emailAttr=<newEmailAttribute>" http://<nodeIP>:6444/rest/v1.0/ldapauthorities/<LdapOrder>
  

5.3.4 Delete LDAP Authority

Description: Delete an LDAP authority.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/ldapauthorities/{order}

Type:

DELETE

Parameters:

authusername=<valid username> authpassword=<valid password>


Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example:

curl -X DELETE "http://<nodeIP>:6444/rest/v1.0/ldapauthorities/<LdapOrder>?authusername=<username>&authpassword=<password>"

5.3.5 Add LDAP Authority

Description: Add an LDAP authority.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/ldapauthorities/{order}

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
order=<order-number>
url=<url>
bindDn=<bindDn>
bindPass=<bindPass>
firstNameAttr=<First Name Attribute>
lastNameAttr=<Last Name Attribute>
emailAttr=<Email Attribute>


Successful Response:

201 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access

Example:

    	curl -X POST -d "authusername=<username>&authpassword=<password>&order=<LdapOrder>&url=<newUrl>&bindDn=<newBindDN>&bindPass=<newBindPassword>&firstNameAttr=<newFirstNameAttribute>&lastNameAttr=<newLastNameAttribute>&emailAttr=<newEmailAttribute>" http://<nodeIP>:6444/rest/v1.0/ldapauthorities/<LdapOrder>

5.3.6 Trigger LDAP Poll

Description: API call to trigger a poll for changes on the LDAP service.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/ldapauthorities/pollLDAPAuthorities

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
order=<order-number>
token=<SSL Token value>

Successful Response:

201 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access

Example:

curl -X POST -d "authusername=<username>&authpassword=<password>" http://<nodeIP>:6444/rest/v1.0/ldapauthorities/pollLDAPAuthorities

5.3.7 Trigger LDAP Poll for a team

Description: API call to trigger a poll for changes on the LDAP service for a given team.

URL:

http(s)://<server-host>:6444/rest/v1.0/teams/<root-team>/subteam/<sub-team>/subteam/<target-team>?action=pollLdapTeam

Type:

POST

Parameters:

<target-team> - the team that you wish to resync with LDAP.


Successful Response:

201 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access

Example:

curl -X POST -d "authusername=<username>&authpassword=<password>" http://<nodeIP>:6444/rest/v1.0/teams/<root-team>/subteam/<sub-team>/subteam/<target-team>?action=pollLdapTeam

254 Repository

5.4.1 Get Repository

Description: Get a repository.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/repos/{repo}

Type:

GET

Parameters:

authusername=<valid username> authpassword=<valid password>


Successful Response:

200 - Success - repositoryRSDTO (REST Data Transfer Object)

Error Response:

400 - Bad Request - See message for detailed status
404 - Not Found - No resources found
401 - Unauthorized Access

Example:

   curl "http://<nodeIP>:6444/rest/v1.0/repos/<DAVLocation>?authusername=<username>&authpassword=<password>"

5.4.2 Add Repository

Description: Add a repository.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/repos/{repo}

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
authusername=<valid username> authpassword=<valid password>
davLocation=<Dav Location>
directory=<Directory path on disk>
managePasswordFile=
passwordFilePath=
parentPath=
parentPathChild=true|false


Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access

Example: adding a repository using SVNPath

curl -X POST -d "authusername=<username>&authpassword=<password>&davLocation=<DAVLocation>&directory=<pathOnFileSystem>&managePasswordFile=<true|false>&passwordFilePath=<passwordFilePath>" http://<nodeIP>:6444/rest/v1.0/repos/<DAVLocation>  

Example: Adding an SVNParentPath directory

curl -X POST -d "authusername=<username>&authpassword=<password>&davLocation=<DAVLocation>&directory=<pathOnFileSystem>&managePasswordFile=<true|false>&passwordFilePath=<passwordFilePath>&parentPath=true" http://<nodeIP>:6444/rest/v1.0/repos/<DAVLocation> 

Example: adding a repository that is in an SVNParentPath directory

curl -X POST -d "authusername=<username>&authpassword=<password>&parentPathChild=true" http://<nodeIP>:6444/rest/v1.0/repos/<ChildDAVLocation>   

5.4.3 Update Repository

Description: Update an existing repository.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/repos/{repo}

Type:

PUT

Parameters:

authusername=<valid username> authpassword=<valid password>
davLocation=
directory=
managePasswordFile=
passwordFilePath=
preCommitHook=
preLockHook=
preUnlockHook=


Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found

Example:

    	curl -X PUT -d "authusername=<username>&authpassword=<password>&davLocation=<newDAVLocation>&directory=<newDirectory>&managePasswordFile=<true|false>&passwordFilePath=<newPasswordFilePath>&preCommitHook=<newPreCommitHookLocation>&preLockHook=<newPreLockHookLocation>&preUnlockHook=<newPreUnlockHookLocation>" http://<nodeIP>:6444/rest/v1.0/repos/<DAVLocation>

5.4.4 Delete Repository

Description: Delete a repository.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/repos/{repo}

Type:

DELETE

Parameters:

authusername=<valid username> authpassword=<valid password>


Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example

 curl -X DELETE "http://<nodeIP>:6444/rest/v1.0/repos/<DAVLocation>?authusername=<username>&authpassword=<password>"
        

5.4.5 Update repository hook

Description: Update a repository hook script.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/repos/{repo}/hook

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
hookname=
action=0|1


Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example:

curl -X POST -d "authusername=<username>&authpassword=<password>&hookname=<pre-commit|pre-lock|pre-unlock>&action=<enable|disable>" http://<nodeIP>:6444/rest/v1.0/repos/<DAVLocation>/hook

5.4.6 Get Overview of all Repositories

Description: Use to get a list of all repositories and their current status.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/repos/

Type:

GET

Parameters:

authusername=<valid username> authpassword=<valid password>

Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access


Example:

curl "http://<nodeIP>:6444/rest/v1.0/repos?authusername=<username>&authpassword=<password>"


Example Return

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositoryRSDTOes>
<repository>
<childRepositories>repo1_pp</childRepositories>
<childRepositories>repo2_pp</childRepositories>
<childRepositories>repo3_pp</childRepositories>
<davLocation>/svn</davLocation>
<fileSystemLocation>/repos_pp</fileSystemLocation>
<parentPath>true</parentPath>
<status>Active</status>
</repository>
<repository>
<davLocation>/svn/repo1_pp</davLocation>
<fileSystemLocation>/repos_pp/repo1_pp</fileSystemLocation>
<parentPath>false</parentPath>
<status>Active</status>
</repository>
<repository>
<davLocation>.........
    
    

5.5 Teams

5.5.1 Get All Teams

Description: Get all Access Control teams.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams

Type:

GET

Parameters:

authusername=<valid username>
authpassword=<valid password>
includePendingChanges=true|false


Successful Response:

200 - Success - teamRSDTO (REST Data Transfer Object)

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access


Example:

  curl "http://<nodeIP>:6444/rest/v1.0/teams?authusername=<username>&authpassword=<password>"

5.5.2 Update Team

Description: Update an Access Control team.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}

Type:

PUT

Parameters:

authusername=<valid username>
authpassword=<valid password>
newTeamName=
newTeamDescription=
includePendingChanges=true|false

Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example

curl -X PUT -d "authusername=<username>&authpassword=<password>&newTeamDescription=<newDescription>&newTeamName=<newTeamName>" http://<nodeIP>:6444/rest/v1.0/teams/<teamName> 

5.5.3 Delete Team

Description: Delete an Access Control team.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}

Type:

DELETE

Parameters:

authusername=<valid username>
authpassword=<valid password>
includePendingChanges=true|false

Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example:

curl -X DELETE http://<nodeIP>:6444/rest/v1.0/teams/<teamName>?authusername=<username>&authpassword=<password>"

5.5.4 Get Team

Description: Get an Access Control team.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}

Type:

GET

Parameters:

authusername=<valid username>
authpassword=<valid password>
includePendingChanges=true|false

Successful Response:

200 - Success - teamRSDTO (REST Data Transfer Object)

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example:

curl "http://<nodeIP>:6444/rest/v1.0/teams/<teamName>?authusername=<username>&authpassword=<password>"   
 

5.5.5 Create Team

Description: Create an Access Control team.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}

Type:

POST

Parameters:

authusername=<valid username>
authpassword=<valid password>
includePendingChanges=true|false
action=create
teamDescription=


Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access

Example:

curl -X POST -d "authusername=<username>&authpassword=<password>" http://<nodeIP>:6444/rest/v1.0/teams/<teamName> 
 

5.5.6 Set LDAP Team

Description: Set a team through LDAP.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}

Type:

POST

Parameters:

authusername=<valid username>
authpassword=<valid password>
includePendingChanges=true|false
action=setLdapTeam
ldapAuthOrder=
ldapFilter=
managingNodeName=


Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example:

curl -X POST -d "authusername=<username>&authpassword=<password>&ldapAuthOrder=<LdapOrder>&LdapFilter=<LdapFilter>" http://<nodeIP>:6444/rest/v1.0/teams/TeamLdapManaged?action=setLdapTeam

5.5.7 Disable (Depopulate) LDAP Team

Description: This command turns off team population (via LDAP), effectively disabling the team.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}

Type:

POST

Parameters:

authusername=<valid username>
authpassword=<valid password>
includePendingChanges=true|false
action=disableLdapTeam

Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example:

curl -X POST -d "authusername=<username>&authpassword=<password>" http://<nodeIP>:6444/rest/v1.0/teams/TeamLdapManaged?action=disableLdapTeam

5.5.8 Add Resource to Team

Description: Add a repository resource to an Access Control team.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}?action=addResourceToTeam

Type:

POST

Parameters:

authusername=<valid username>
authpassword=<valid password>
includePendingChanges=true|false
action=addResourceToTeam
resourceToUpdate=Repo DAV location

Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example:

curl -X POST -d "authusername=<username>&authpassword=<password>&resourceToUpdate=<DAVLocation>" http://<nodeIP>:6444/rest/v1.0/teams/<teamName>?action=addResourceToTeam
  

5.5.9 Remove Resource From Team

Description: Remove a repository resource from an Access Control team.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}?action=removeResourceToTeam

Type:

POST

Parameters:

authusername=<valid username>
authpassword=<valid password>
includePendingChanges=true|false action=removeResourceFromTeam
includePendingChanges=true|false
resourceToUpdate=Repo DAV location

Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example:

 curl -X POST -d "authusername=<username>&authpassword=<password>&resourceToUpdate=<DAVLocation>" http://<nodeIP>:6444/rest/v1.0/teams/<teamName>?action=removeResourceFromTeam
 

5.5.10 Add User To Team

Description: Add a user to an Access Control teams.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}?action=addUserToTeam

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
action=addUserToTeam
userToUpdate=<existing user>
userToUpdate=
includePendingChanges=true|false

Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example:

curl -X POST -d "authusername=<username>&authpassword=<password>&userToUpdate=<user>" http://<nodeIP>:6444/rest/v1.0/teams/<teamName>?action=addUserToTeam

5.5.11 Remove user From Team

Description: Remove a user from an Access Control team.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}?action=removeUserFromTeam

Type:

POST

Parameters:

action=removeUserFromTeam
userToUpdate=<existing user>
userToUpdate=
includePendingChanges=true|false

Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example:

curl -X POST -d "authusername=<username>&authpassword=<password>&userToUpdate=<user>" http://<nodeIP>:6444/rest/v1.0/teams/<teamName>?action=removeUserFromTeam

5.5.12 Promote User To Team Leader

Description: Make an existing user into a team leader.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}?action=promoteUserToTeamLeader

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
action=promoteUserToTeamLeader
userToUpdate=
includePendingChanges=true|false

Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example:

curl -X POST -d "authusername=<username>&authpassword=<password>&userToUpdate=<user>" http://<nodeIP>:6444/rest/v1.0/teams/<teamName>?action=promoteUserToTeamLeader

5.5.13 Demote Team Leader

Description: Remove team leader privileges from a user.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}?action=demoteUserFromTeamLeader

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
action=demoteUserFromTeamLeader
userToUpdate=
includePendingChanges=true|false

Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example:

curl -X POST -d "authusername=<username>&authpassword=<password>&userToUpdate=<user>" http://<nodeIP>:6444/rest/v1.0/teams/<teamName>?action=demoteUserFromTeamLeader

5.5.14 Grant Admin Permission

Description: Assign Access Control system administrator permission to a user.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}? action=grantAdminPermission

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
action=grantAdminPermission
userToUpdate=
permission=createSubteams|addResources|createUsers|disableUsers|modifyUsers|modifyRules
includePendingChanges=true|false

Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example:

curl -X POST -d "authusername=<username>&authpassword=<password>&userToUpdate=<user>&permission=<createSubteams|addResources|createUsers|disableUsers|modifyUsers|modifyRules>" http://<nodeIP>:6444/rest/v1.0/teams/<teamName>?action=grantAdminPermission
 

5.5.15 Remove Admin Permission

Description: Remove Access Control system administrator permission.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
action=removeAdminPermission
userToUpdate=
permission=createSubteams|addResources|createUsers|disableUsers|modifyUsers|modifyRules
includePendingChanges=true|false

Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example:

curl -X POST -d "authusername=<username>&authpassword=<password>&userToUpdate=<user>&permission=< createSubteams|addResources|createUsers|disableUsers|modifyUsers|modifyRules>" http://<nodeIP>:6444/rest/v1.0/teams/<teamName>?action=removeAdminPermission   

5.5.16 Get All Team Rules

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}/teamrules

Type:

GET

Parameters:

authusername=<valid username> authpassword=<valid password>
includePendingChanges=true|false

Successful Response:

200 - Success - List<TeamRuleRSDTO> (REST Data Transfer Object)

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example

curl "http://<nodeIP>:6444/rest/v1.0/teams/<teamName>/teamrules?authusername=<username>&authpassword=<password>"
 

5.5.17 Get Team Rule

Description: Get an Access Control team rule.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}/teamrules/{rule-name}

Type:

GET

Parameters:

authusername=<valid username> authpassword=<valid password>
rulename=
team=
id=
includePendingChanges=true|false

Successful Response:

200 - Success - TeamRuleRSDTO (REST Data Transfer Object)

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example:

curl "http://<nodeIP>:6444/rest/v1.0/teams/<teamName>/teamrules/<ruleName>?authusername=<username>&authpassword=<password>"

5.5.18 Delete Team Rule

Description: Delete an Access Control team rule.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}/teamrules/{rule-name}

Type:

DELETE

Parameters:

authusername=<valid username>
authpassword=<valid password>
includePendingChanges=true|false

Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example:

curl -X DELETE "http://<nodeIP>:6444/rest/v1.0/teams/<teamName>/teamrules/<ruleName>?authusername=<username>&authpassword=<password>"

5.55.19 Update Team Rule

Description: Update an Access Control team rule.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}/teamrules/{rule-name}

Type:

PUT

Parameters:

authusername=<valid username>
authpassword=<valid password>
includePendingChanges=true|false

Consumes:

<rule>
  <id>{ruleID}</id>
  <rule-name>{ruleName}</rule-name>
  <team-name>{slash-delimited-team-hierarchy}</team-name>
  <ip-pattern>{IPFiltering}</ip-pattern>
  <ip-pattern-option>NoRestrictions|IPList</ip-pattern-option>
  <disabled>true|false</disabled>
  <apply-to-all-users>true|false</apply-to-all-users>
  <users>
    <user>{username}</user>
  </users>
  <resource-permissions>
    <resourcePermissions>
      <pathName>{path}</pathName>
      <permission>D|RO|RW</permission>
    </resourcePermissions>
  </resource-permissions>
</rule>

  

Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access
404 - Not Found - No resources found


Example: update a rule for all users


curl -H "Content-Type: application/xml" -X PUT -d "<rule><id>{RULEID}</id><rule-name>{RULENAME}</rule-name><team-name>{TEAMNAME}</team-name><ip-pattern></ip-pattern><ip-pattern-option>NoRestrictions</ip-pattern-option><disabled>false</disabled><apply-to-all-users>true</apply-to-all-users><resource-permissions><resourcePermissions><pathName>{DAVLOCATION}</pathName><permission>{RW|RO|D}</permission></resourcePermissions></resource-permissions></rule>" "http://<nodeIP>:6444/rest/v1.0/teams/<teamName>/teamrules/<ruleName>?authusername=<username>&authpassword=<password>"

Example: update a rule for specific user(s)


curl -H "Content-Type: application/xml" -X PUT -d "<rule><id>{RULEID}</id><rule-name>{RULENAME}</rule-name><team-name>{TEAMNAME}</team-name><ip-pattern></ip-pattern><ip-pattern-option>NoRestrictions</ip-pattern-option><disabled>false</disabled><apply-to-all-users>false</apply-to-all-users><users><user>{USERNAME}</user></users><resource-permissions><resourcePermissions><pathName>{DAVLOCATION}</pathName><permission>{RW|RO|D}</permission></resourcePermissions></resource-permissions></rule>" "http://<nodeIP>:6444/rest/v1.0/teams/<teamName>/teamrules/<ruleName>?authusername=<username>&authpassword=<password>"

5.5.20 Create Team rules

Description: Create an Access Control team rule.

URL:

http(s)://<server-host>:<server-port>/rest/v1.0/teams/{root-team}/subteam/{subteam1}/subteam/{target-team}/teamrules/{rule-name}

Type:

POST

Parameters:

authusername=<valid username> authpassword=<valid password>
includePendingChanges=true|false

Consumes:

<rule>
  <rule-name>{ruleName}</rule-name>
  <team-name>{slash-delimited-team-hierarchy}</team-name>
  <ip-pattern>{IPFiltering}</ip-pattern>
  <ip-pattern-option>NoRestrictions|IPList</ip-pattern-option>
  <disabled>true|false</disabled>
  <apply-to-all-users>true|false</apply-to-all-users>
  <users>
    <user>{username}</user>
  </users>
  <resource-permissions>
    <resourcePermissions>
      <pathName>{path}</pathName>
      <permission>D|RO|RW</permission>
    </resourcePermissions>
  </resource-permissions>
</rule>  

Successful Response:

200 - Success

Error Response:

400 - Bad Request - See message for detailed status
401 - Unauthorized Access


Example: Create a rule for a specific team user:

curl -H "Content-Type: application/xml" -X POST -d "<rule><rule-name>adminRuleTmp</rule-name><team-name>adminTeam</team-name><ip-pattern></ip-pattern><ip-pattern-option>NoRestrictions</ip-pattern-option><disabled>false</disabled><apply-to-all-users>false</apply-to-all-users><users><user>admin</user></users><resource-permissions><resourcePermissions><pathName>/svn/Repo9</pathName><permission>RW</permission></resourcePermissions></resource-permissions></rule>" "http://localhost:6444/rest/v1.0/teams/adminTeam/teamrules/adminRuleTmp?authusername=admin&authpassword=admin"