Share this page
User management
This topic describes the usage of the StarTeam REST API for user management.
GET - users
The following section illustrates the usage of the GET method to retrieve users:
Usage: GET: /user
Description: Gets a list of users and basic information for each user.
Sample URL: The following URL returns a list of users: http://localhost:49206/serverapi/user
Response example
[{"Active":true,"ID":2,"Name":"John Smith"},
{"Active":true,"ID":0,"Name":"Administrator"},
{"Active":true,"ID":1,"Name":"local_user"}]
GET - properties
The following section illustrates the usage of the GET method to retrieve user properties.
Usage: GET: /user/{id}
Description: Gets user properties for a specific user {id}.
Sample URL: The following URL returns the properties of the user with the id 5: http://localhost:49206/serverapi/user/5
Response example
[{
"AccountStatus": 0,
"Address": "",
"BLSGUID": 0,
"CreatedTime": {
"raw": 43693.710332419,
"text": "8/17/2019"
},
"DirectoryManaged": true,
"DirectoryService": 0,
"DistinguishedName": "domain\\JSmith",
"EmailAddress": "jsmith@domain.com",
"FavoriteProjects": [],
"Fax": "",
"Flags": 0,
"FullName": "john smith",
"GroupIDs": [
2147483648
],
"ID": 6,
"IsLicensed": false,
"LastLogoutTime": {
"raw": 0,
"text": ""
},
"LastWebLogoutTime": {
"raw": 0,
"text": ""
},
"LicenseType": 1,
"LoginCount": 0,
"LoginName": "jsmith",
"Phone": "",
"ReplyTo": "",
"Territory": 0,
"VoiceMail": "",
"Workstations": []
}
GET - groups
The following section illustrates the usage of the GET method to retrieve a list of groups.
Usage: GET: /group
Description: Gets a list of groups and basic information for each group.
Sample URL: http://localhost:49206/serverapi/group
Response example
[{"Active":true,"ID":2147483648,"Name":"All Users"},
{"Active":true,"ID":2147483649,"Name":"Administrators"},
{"Active":true,"ID":2147483650,"Name":"Security Administrators"},
{"Active":true,"ID":2147483651,"Name":"System Managers"}]
See also:
