Users and Groups Resource

GET /groups

List groups.

Request Parameters
name type description default constraints
count query The maximum number of results to return. 100 int
description_format query The desired format for the binder description. Can be "html" or "text". text  
first query The index of the first result to return.   int
name query A name to search for. May contain wildcard characters.    
Response Body
media type data type description
application/json SearchResultList (JSON) A SearchResultList of GroupBrief objects.
application/xml searchResultList (XML)

GET /groups/{id}

Get a group.

Request Parameters
name type description default constraints
id path The ID of the group.   long
description_format query The desired format for the description. Can be "html" or "text". text  
include_attachments query Whether to include attachments in the returned group. true boolean
Response Body
media type data type description
application/json Group (JSON) A Group resource.
application/xml group (XML)

PUT /groups/{id}

Update a group.

Request Parameters
name type description constraints
id path The ID of the group. long
Request Body
media type data type description
application/json Group (JSON) A Group resource with updated fields.
application/xml group (XML)

GET /groups/{id}/members

List the members of the group.

Request Parameters
name type description default constraints
id path The ID of the group.   long
count query The maximum number of results to return. -1 int
first query The index of the first result to return. 0 int
Response Body
media type data type description
application/json SearchResultList (JSON) A SearchResultList of GroupMember objects.
application/xml searchResultList (XML)

POST /groups/{id}/members

Add a user or group to a group.

Request Parameters
name type description constraints
id path The ID of the group. long
Request Body
media type data type description
application/json PrincipalBrief (JSON) The User or Group to add.
application/xml principalBrief (XML)

DELETE /groups/{id}/members/{memberId}

Remove a member from a group.

Request Parameters
name type description constraints
id path The ID of the Group. long
memberId path The ID of the Group Member. long

GET /principals

Get users and groups by ID or by keyword.

  • By ID: id=20&id=32&id=46
  • By Keyword: keyword=Jo*

Request Parameters
name type description default constraints multivalued
count query The maximum number of results to return. 25 int no
description_format query The desired format for the user and group descriptions. Can be "html" or "text". text   no
first query The index of the first result to return. 0 int no
id query A user or group ID. May be specified multiple times.   long yes
include_all_users_group query Whether to include the "All Users" group in the results. true boolean no
included_groups query Whether to include groups in the results. all   no
included_users query Whether to include users in the results. all   no
keyword query A search term. Matches on full names, login names, and email address.     no
Response Body
media type data type description
application/json SearchResultList (JSON) A SearchResultList of UserBrief and GroupBrief objects.
application/xml searchResultList (XML)

GET /principals/{id}

Get a user or group.

Request Parameters
name type description default constraints
id path The ID of the user or group.   long
description_format query The desired format for the description. Can be "html" or "text". text  
include_attachments query Whether to include attachments in the returned user or group. true boolean
Response Body
media type data type description
application/json Principal (JSON) A User or Group resource.
application/xml principal (XML)

GET /users/{id}

Get a user.

Request Parameters
name type description default constraints
id path The ID of the user.   long
description_format query The desired format for the description. Can be "html" or "text". text  
include_attachments query Whether to include attachments in the returned user or group. true boolean
Response Body
media type data type description
application/json User (JSON) A User resource.
application/xml user (XML)

GET /users/{id}/groups

List the groups that the user is a member of.

Request Parameters
name type description constraints
id path The ID of the user. long
Response Body
media type data type description
application/json SearchResultList (JSON) A SearchResultList of GroupBrief resources.
application/xml searchResultList (XML)

POST /users/{id}/password

Change the user's password.

Request Parameters
name type description constraints
new_password form The desired new password.  
old_password form The old password.  
id path The ID of the user. long
Response Body
media type data type
application/json object (JSON)
application/xml anyType (XML)